Add plugin description

Author: SineStriker

README.md

@@ -265,6 +265,7 @@ Static and runtime plugins differ only in how their instances enter the factory:
 
 - `id` is required, identifies the plugin, and must be unique within the system. If discovery produces duplicate IDs, the first plugin is used and each later duplicate is invalid.
 - `displayName` is required display text and may repeat.
+- `description` is optional human-readable text for the plugin.
 - `version` is required and gives the current plugin version.
 - `compatVersion` is optional and defaults to `version`.
 - `enabledByDefault` is optional and defaults to `true`.
@@ -278,6 +279,7 @@ The metadata has the following schema:
 {
     "id": "org.example.editor",
     "displayName": "Editor",
+    "description": "Provides the editor extension.",
     "version": "2.1.0",
     "compatVersion": "2.0.0",
     "enabledByDefault": true,

include/stdcorelib/pluginsystem/pluginspec.h

@@ -60,6 +60,9 @@ namespace stdc::pluginsystem {
         /// The display name, which does not have to be unique.
         const std::string &displayName() const;
 
+        /// A human-readable description of this plugin, or empty when none was provided.
+        const std::string &description() const;
+
         /// The plugin version.
         const VersionNumber &version() const;
 

src/pluginsystem/pluginspec.cpp

@@ -38,6 +38,14 @@ namespace stdc::pluginsystem {
             return reportError("missing or invalid plugin display name");
         }
 
+        const auto &descriptionValue = metadata["description"];
+        if (!descriptionValue.isNull()) {
+            if (!descriptionValue.isString()) {
+                return reportError("invalid plugin description");
+            }
+            description = descriptionValue.toString();
+        }
+
         std::string versionString;
         if (!readString("version", &versionString)) {
             return reportError("missing or invalid plugin version");
@@ -150,6 +158,10 @@ namespace stdc::pluginsystem {
         return _data->displayName;
     }
 
+    const std::string &PluginSpec::description() const {
+        return _data->description;
+    }
+
     const VersionNumber &PluginSpec::version() const {
         return _data->version;
     }

src/pluginsystem/pluginspec_p.h

@@ -22,6 +22,7 @@ namespace stdc::pluginsystem {
         std::string errorMessage;
         std::string id;
         std::string displayName;
+        std::string description;
         VersionNumber version;
         VersionNumber compatVersion;
         std::vector<PluginDependency> dependencies;

tests/auto/plugins/test_pluginsystem_plugin/test_pluginsystem_plugin.json

@@ -1,5 +1,6 @@
 {
     "id": "org.stdcorelib.PluginSystemTest",
     "displayName": "PluginSystem Test",
+    "description": "A plugin system test plugin.",
     "version": "2.1.0"
 }

tests/auto/test_pluginsystem.cpp

@@ -34,7 +34,7 @@ namespace {
             } else {
                 addPlugin(
                     "plugin",
-                    R"({"id":"org.stdcorelib.PluginSystemTest","displayName":"PluginSystem Test","version":"2.1.0"})");
+                    R"({"id":"org.stdcorelib.PluginSystemTest","displayName":"PluginSystem Test","description":"A plugin system test plugin.","version":"2.1.0"})");
             }
         }
 
@@ -197,6 +197,7 @@ namespace {
         BOOST_CHECK(!specs.front()->hasError());
         BOOST_CHECK_EQUAL(specs.front()->id(), "org.stdcorelib.PluginSystemTest");
         BOOST_CHECK_EQUAL(specs.front()->displayName(), "PluginSystem Test");
+        BOOST_CHECK_EQUAL(specs.front()->description(), "A plugin system test plugin.");
         BOOST_CHECK_EQUAL(specs.front()->version(), stdc::VersionNumber(2, 1));
         BOOST_CHECK_EQUAL(specs.front()->compatVersion(), specs.front()->version());