@emdaer/plugin-list - npm Package Compare versions

Comparing version 1.0.0-beta.0 to 1.0.0

.emdaer/README.emdaer.md

+# <!--emdaer-p
+  - '@emdaer/plugin-value-from-package'
+  - value: name
+-->
+
+<!--emdaer-p
+  - '@emdaer/plugin-value-from-package'
+  - value: description
+-->
+
+<!--emdaer-p
+  - '@emdaer/plugin-documentation'
+  - sources:
+    - ./src/index.js
+-->

CHANGELOG.md

+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+<a name="1.0.0"></a>
+# [1.0.0](https://github.com/emdaer/emdaer/compare/v1.0.0-beta.2...v1.0.0) (2017-10-29)
+
+
+
+
+**Note:** Version bump only for package @emdaer/plugin-list

lib/index.js

@@ -11,3 +11,3 @@ /*  */
  */
-module.exports = async function listPlugin({
+async function listPlugin({
   type,
@@ -28,2 +28,4 @@ items,
   ].join('\n');
-};
+}
+
+module.exports = listPlugin;

package.json

 {
   "name": "@emdaer/plugin-list",
   "description": "an emdaer plugin to add lists",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.0",
   "repository": "emdaer/emdaer",
@@ -6,0 +6,0 @@ "homepage": "https://emdaer.me/",

README.md

@@ -1,2 +0,24 @@
-<h1>@emdaer/plugin-list</h1>
-<p>an emdaer plugin to add lists</p>
+<!--
+  This file was generated by emdaer
+
+  Its template can be found at .emdaer/README.emdaer.md
+-->
+
+# @emdaer/plugin-list
+
+an emdaer plugin to add lists
+
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## listPlugin
+
+A plugin to generate lists
+
+**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
+
+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
+

src/index.js

@@ -11,3 +11,3 @@ /* @flow */
  */
-module.exports = async function listPlugin({
+async function listPlugin({
   type,
@@ -31,2 +31,4 @@ items,
   ].join('\n');
-};
+}
+
+module.exports = listPlugin;

src/index.test.js

@@ -1,2 +0,2 @@
-const list = require('../src');
+const list = require('./');
 
@@ -3,0 +3,0 @@ describe('@emdaer/plugin-list', () => {

New 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

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4028

53.68%

Number of package files

7

40%

Lines of code

87

2.35%

Number of low quality alerts

1

-50%

Number of lines in readme file

25

733.33%

Worsened metrics

Number of medium supply chain risk alerts

1

Infinity%

No dependency changes