@emdaer/plugin-list - npm Package Compare versions

Comparing version 1.0.0 to 1.2.1

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+<a name="1.2.1"></a>
+## [1.2.1](https://github.com/emdaer/emdaer/compare/v1.2.0...v1.2.1) (2017-10-30)
+
+
+
+
+**Note:** Version bump only for package @emdaer/plugin-list
+
 <a name="1.0.0"></a>
@@ -8,0 +16,0 @@ # [1.0.0](https://github.com/emdaer/emdaer/compare/v1.0.0-beta.2...v1.0.0) (2017-10-29)

lib/index.js

 /*  */
 
 /**
- * A plugin to generate lists
+ * Render HTML list elements.
  *
- * @param                     options
- * @param   {'ol' | 'ul'}     [options.type]  The type of list
- * @param   {Array<string>}   [options.items] The items to list
- * @returns {Promise<string>}                 The list element
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ol}
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ul}
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/li}
+ *
+ * @param options
+ * @param {'ol' | 'ul'} [options.type] The type of list; ol (ordered) and ul (unordered).
+ * @param {Array<string>} [options.items] The list items; each will be rendered as an li element.
+ * @returns {Promise<string>} The list HTML element.
  */
@@ -11,0 +15,0 @@ async function listPlugin({

package.json

 {
   "name": "@emdaer/plugin-list",
-  "description": "an emdaer plugin to add lists",
-  "version": "1.0.0",
+  "description": "An emdaer plugin that renders HTML list element.",
+  "version": "1.2.1",
   "repository": "emdaer/emdaer",
@@ -6,0 +6,0 @@ "homepage": "https://emdaer.me/",

README.md

@@ -9,3 +9,3 @@ <!--
 
-an emdaer plugin to add lists
+An emdaer plugin that renders HTML list element.
 
@@ -16,11 +16,15 @@ <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-A plugin to generate lists
+-   **See: <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ol>**
+-   **See: <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ul>**
+-   **See: <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/li>**
 
+Render HTML list elements.
+
 **Parameters**
 
 -   `options` **any** 
-    -   `options.type` **(`"ol"` \| `"ul"`)?** The type of list
-    -   `options.items` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>?** The items to list
+    -   `options.type` **(`"ol"` \| `"ul"`)?** The type of list; ol (ordered) and ul (unordered).
+    -   `options.items` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>?** The list items; each will be rendered as an li element.
 
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>** The list element
+Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>** The list HTML element.
 

src/index.js

 /* @flow */
 
 /**
- * A plugin to generate lists
+ * Render HTML list elements.
  *
- * @param                     options
- * @param   {'ol' | 'ul'}     [options.type]  The type of list
- * @param   {Array<string>}   [options.items] The items to list
- * @returns {Promise<string>}                 The list element
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ol}
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ul}
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/li}
+ *
+ * @param options
+ * @param {'ol' | 'ul'} [options.type] The type of list; ol (ordered) and ul (unordered).
+ * @param {Array<string>} [options.items] The list items; each will be rendered as an li element.
+ * @returns {Promise<string>} The list HTML element.
  */
@@ -11,0 +15,0 @@ async function listPlugin({

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5071

25.89%

Lines of code

95

9.2%

Number of lines in readme file

29

16%

Number of medium supply chain risk alerts

0

-100%

No dependency changes