@gasket/plugin-metadata - npm Package Compare versions

Comparing version 5.0.2 to 5.1.0

CHANGELOG.md

 # `@gasket/plugin-metadata`
 
+- Clean markdown from jsdocs ([#141])
+
 ### 5.0.0
@@ -23,6 +25,7 @@
 [#64]: https://github.com/godaddy/gasket/pull/64
+[#141]: https://github.com/godaddy/gasket/pull/141
 
-[Loader]:/packages/gasket-resolve/docs/api.md#Loader
-[PluginInfo]:/packages/gasket-resolve/docs/api.md#PluginInfo
-[PresetInfo]:/packages/gasket-resolve/docs/api.md#PresetInfo
-[ModuleInfo]:/packages/gasket-resolve/docs/api.md#ModuleInfo
+[Loader]:/packages/gasket-resolve/docs/api.md#loader
+[PluginInfo]:/packages/gasket-resolve/docs/api.md#plugininfo
+[PresetInfo]:/packages/gasket-resolve/docs/api.md#presetinfo
+[ModuleInfo]:/packages/gasket-resolve/docs/api.md#moduleinfo

docs/api.md

@@ -0,30 +1,17 @@
+
 ## Typedefs
 
-<dl>
-<dt><a href="#ModuleData">ModuleData</a> : <code>Object</code></dt>
-<dd><p>Module with meta data</p>
-</dd>
-<dt><a href="#AppData">AppData</a> : <code><a href="#ModuleData">ModuleData</a></code></dt>
-<dd><p>App module with meta data</p>
-</dd>
-<dt><a href="#PluginData">PluginData</a> : <code><a href="#ModuleData">ModuleData</a></code></dt>
-<dd><p>Plugin module with meta data</p>
-</dd>
-<dt><a href="#PresetData">PresetData</a> : <code><a href="#ModuleData">ModuleData</a></code></dt>
-<dd><p>Preset module with meta data</p>
-</dd>
-<dt><a href="#DetailData">DetailData</a> : <code>Object</code></dt>
-<dd><p>Metadata for details of a plugin</p>
-</dd>
-<dt><a href="#LifecycleData">LifecycleData</a> : <code><a href="#DetailData">DetailData</a></code></dt>
-<dd><p>Metadata with specifics details for plugin lifecycles</p>
-</dd>
-<dt><a href="#Metadata">Metadata</a> : <code>Object</code></dt>
-<dd><p>Collection data for modules configured for app</p>
-</dd>
-</dl>
+Name | Description
+------ | -----------
+[ModuleData] | Module with meta data
+[AppData] | App module with meta data
+[PluginData] | Plugin module with meta data
+[PresetData] | Preset module with meta data
+[DetailData] | Metadata for details of a plugin
+[LifecycleData] | Metadata with specifics details for plugin lifecycles
+[Metadata] | Collection data for modules configured for app
 
-<a name="ModuleData"></a>
 
-## ModuleData : <code>Object</code>
+## ModuleData
+
 Module with meta data
@@ -37,14 +24,14 @@
 | --- | --- | --- |
-| name | <code>String</code> | Name of preset |
-| module | <code>String</code> | Actual module content |
-| [package] | <code>String</code> | Package.json contents |
-| [version] | <code>String</code> | Resolved version |
-| [path] | <code>String</code> | Path to the root of package |
-| [from] | <code>String</code> | Name of module which requires this module |
-| [range] | <code>String</code> | Range by which this module was required |
-| [link] | <code>string</code> | Path to a doc file or URL |
+| name | `string` | Name of preset |
+| module | `string` | Actual module content |
+| \[package\] | `string` | Package.json contents |
+| \[version\] | `string` | Resolved version |
+| \[path\] | `string` | Path to the root of package |
+| \[from\] | `string` | Name of module which requires this module |
+| \[range\] | `string` | Range by which this module was required |
+| \[link\] | `string` | Path to a doc file or URL |
 
-<a name="AppData"></a>
 
-## AppData : [<code>ModuleData</code>](#ModuleData)
+## AppData
+
 App module with meta data
@@ -57,7 +44,7 @@
 | --- | --- | --- |
-| [modules] | [<code>Array.&lt;DetailData&gt;</code>](#DetailData) | Description of modules supporting this plugin |
+| \[modules\] | `Array.<DetailData>` | Description of modules supporting this plugin |
 
-<a name="PluginData"></a>
 
-## PluginData : [<code>ModuleData</code>](#ModuleData)
+## PluginData
+
 Plugin module with meta data
@@ -70,10 +57,10 @@
 | --- | --- | --- |
-| [commands] | [<code>Array.&lt;DetailData&gt;</code>](#DetailData) | Commands enabled by this plugin |
-| [structures] | [<code>Array.&lt;DetailData&gt;</code>](#DetailData) | App files and directories used by plugin |
-| [lifecycles] | [<code>Array.&lt;DetailData&gt;</code>](#DetailData) | Description of lifecycles invoked by plugin |
-| [modules] | [<code>Array.&lt;DetailData&gt;</code>](#DetailData) | Description of modules supporting this plugin |
+| \[commands\] | `Array.<DetailData>` | Commands enabled by this plugin |
+| \[structures\] | `Array.<DetailData>` | App files and directories used by plugin |
+| \[lifecycles\] | `Array.<DetailData>` | Description of lifecycles invoked by plugin |
+| \[modules\] | `Array.<DetailData>` | Description of modules supporting this plugin |
 
-<a name="PresetData"></a>
 
-## PresetData : [<code>ModuleData</code>](#ModuleData)
+## PresetData
+
 Preset module with meta data
@@ -86,8 +73,8 @@
 | --- | --- | --- |
-| presets | [<code>Array.&lt;PresetData&gt;</code>](#PresetData) | Presets that this preset extends |
-| plugins | [<code>Array.&lt;PluginData&gt;</code>](#PluginData) | Plugins this preset uses |
+| presets | `Array.<PresetData>` | Presets that this preset extends |
+| plugins | `Array.<PluginData>` | Plugins this preset uses |
 
-<a name="DetailData"></a>
 
-## DetailData : <code>Object</code>
+## DetailData
+
 Metadata for details of a plugin
@@ -100,9 +87,9 @@
 | --- | --- | --- |
-| name | <code>string</code> | Name of the the module or element |
-| [description] | <code>string</code> | Description of the module or element |
-| [link] | <code>string</code> | Path to a doc file or URL |
+| name | `string` | Name of the the module or element |
+| \[description\] | `string` | Description of the module or element |
+| \[link\] | `string` | Path to a doc file or URL |
 
-<a name="LifecycleData"></a>
 
-## LifecycleData : [<code>DetailData</code>](#DetailData)
+## LifecycleData
+
 Metadata with specifics details for plugin lifecycles
@@ -115,9 +102,9 @@
 | --- | --- | --- |
-| method | <code>string</code> | Executing method from the engine |
-| [parent] | <code>string</code> | Lifecycle from which this one is invoked |
-| [command] | <code>string</code> | Command from which this lifecycle is invoked |
+| method | `string` | Executing method from the engine |
+| \[parent\] | `string` | Lifecycle from which this one is invoked |
+| \[command\] | `string` | Command from which this lifecycle is invoked |
 
-<a name="Metadata"></a>
 
-## Metadata : <code>Object</code>
+## Metadata
+
 Collection data for modules configured for app
@@ -130,6 +117,15 @@
 | --- | --- | --- |
-| app | [<code>Array.&lt;AppData&gt;</code>](#AppData) | App and main package data |
-| presets | [<code>Array.&lt;PresetData&gt;</code>](#PresetData) | Preset data with dependency hierarchy |
-| plugins | [<code>Array.&lt;PluginData&gt;</code>](#PluginData) | Flat list of registered plugin data |
-| modules | [<code>Array.&lt;ModuleData&gt;</code>](#ModuleData) | Supporting module data |
+| app | `Array.<AppData>` | App and main package data |
+| presets | `Array.<PresetData>` | Preset data with dependency hierarchy |
+| plugins | `Array.<PluginData>` | Flat list of registered plugin data |
+| modules | `Array.<ModuleData>` | Supporting module data |
 
+<!-- LINKS -->
+
+[ModuleData]:#moduledata
+[AppData]:#appdata
+[PluginData]:#plugindata
+[PresetData]:#presetdata
+[DetailData]:#detaildata
+[LifecycleData]:#lifecycledata
+[Metadata]:#metadata

lib/types.js

 /**
  * Module with meta data
  *
- * @typedef {Object} ModuleData
+ * @typedef {object} ModuleData
  *
- * @property {String} name - Name of preset
- * @property {String} module - Actual module content
- * @property {String} [package] - Package.json contents
- * @property {String} [version] - Resolved version
- * @property {String} [path] - Path to the root of package
- * @property {String} [from] - Name of module which requires this module
- * @property {String} [range] - Range by which this module was required
+ * @property {string} name - Name of preset
+ * @property {string} module - Actual module content
+ * @property {string} [package] - Package.json contents
+ * @property {string} [version] - Resolved version
+ * @property {string} [path] - Path to the root of package
+ * @property {string} [from] - Name of module which requires this module
+ * @property {string} [range] - Range by which this module was required
  * @property {string} [link] - Path to a doc file or URL
@@ -44,3 +44,3 @@ */
  *
- * @typedef {Object} DetailData
+ * @typedef {object} DetailData
  *
@@ -65,3 +65,3 @@ * @property {string} name - Name of the the module or element
  *
- * @typedef {Object} Metadata
+ * @typedef {object} Metadata
  * @property {AppData[]} app - App and main package data
@@ -68,0 +68,0 @@ * @property {PresetData[]} presets - Preset data with dependency hierarchy

lib/utils.js

@@ -13,4 +13,4 @@ const isFunction = require('lodash.isfunction');
  *
- * @param {Object|Array} value - Item to consider
- * @returns {Object|Array} transformed result
+ * @param {object|object[]} value - Item to consider
+ * @returns {object|object[]} transformed result
  * @private
@@ -41,4 +41,4 @@ */
  *
- * @param {Object} target - Object to mutate
- * @param {Object} other - Object to pull from
+ * @param {object} target - Object to mutate
+ * @param {object} other - Object to pull from
  * @private
@@ -45,0 +45,0 @@ */

package.json

 {
   "name": "@gasket/plugin-metadata",
-  "version": "5.0.2",
+  "version": "5.1.0",
   "description": "Adds metadata to gasket lifecycles",
@@ -15,3 +15,3 @@ "main": "lib",
     "prepack": "npm run docs",
-    "docs": "jsdoc2md lib/*.js > docs/api.md"
+    "docs": "jsdoc2md --plugin @godaddy/dmd --files lib/*.js > docs/api.md"
   },
@@ -37,3 +37,3 @@ "repository": {
   "dependencies": {
-    "@gasket/resolve": "^5.0.2",
+    "@gasket/resolve": "^5.1.0",
     "lodash.clonedeep": "^4.5.0",
@@ -44,2 +44,3 @@ "lodash.isfunction": "^3.0.9",
   "devDependencies": {
+    "@godaddy/dmd": "^1.0.0",
     "assume": "^2.2.0",
@@ -54,3 +55,4 @@ "eslint": "^6.1.0",
     "sinon": "^7.4.1"
-  }
+  },
+  "gitHead": "e302b2a69664f911592012d280be280278db236f"
 }

No alert changes

Worsened metrics

Total package byte prevSize

39515

decreased by-2.6%

Dev dependency count

10

increased by11.11%

Dependency changes

• Updated@gasket/resolve@^5.1.0