remark-usage - npm Package Compare versions

Comparing version 5.0.0 to 5.0.1

index.js

@@ -206,3 +206,3 @@ 'use strict';
 
-    /* to do: better tmp file management. */
+    /* To Do: better tmp file management. */
     stop = cept(console, 'log', function (id, lang, value) {
@@ -209,0 +209,0 @@ if (!value) {

package.json

 {
   "name": "remark-usage",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "description": "Add a usage example to your README",
@@ -33,8 +33,8 @@ "license": "MIT",
     "negate": "^1.0.0",
-    "nyc": "^10.0.0",
+    "nyc": "^11.0.0",
     "remark": "^7.0.0",
     "remark-cli": "^3.0.0",
-    "remark-preset-wooorm": "^2.0.0",
+    "remark-preset-wooorm": "^3.0.0",
     "tape": "^4.0.0",
-    "xo": "^0.17.1"
+    "xo": "^0.18.0"
   },
@@ -57,2 +57,3 @@ "scripts": {
     "space": true,
+    "esnext": false,
     "rules": {
@@ -68,6 +69,8 @@ "max-lines": "off",
   "remarkConfig": {
-    "output": true,
     "plugins": [
       "preset-wooorm",
-      ["remark-lint-fenced-code-flag", false],
+      [
+        "remark-lint-fenced-code-flag",
+        false
+      ],
       "./"
@@ -74,0 +77,0 @@ ]

readme.md

@@ -77,23 +77,35 @@ # remark-usage [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status] [![Chat][chat-badge]][chat]
 
-*   Operate this from an npm package, or provide a `cwd`;
-*   Make sure no side effects occur when running `example.js`!
-*   Don’t do weird things.  This is mostly regexes!
+*   Operate this from an npm package, or provide a `cwd`
+*   Make sure no side effects occur when running `example.js`
+*   Don’t do weird things.  This is mostly regexes
 
-###### `options`
+##### `options`
 
-*   `cwd` (`string?`) — Path to a directory containing a node module.
-    Used to infer `name`, `main`, and `example`;
-*   `name` (`string?`) — Name of the module.  Inferred from `package.json`s
-    `name` property.  Used to rewrite `require('./index.js')` to
-    `require('some-name')`;
-*   `main` (`string?`) — Path to the main script.  Resolved from
-    `package.json`s `main` property (or `index.js`).  Used to rewrite
-    `require('./index.js')`
-    to `require('some-name')`.
-*   `example` (`string?`) — Path to the example script.  **remark-usage**
-    checks for `docs/example.js`, `doc/example.js`, `examples/index.js`,
-    `example/index.js`, and `example.js`.
-*   `heading` (`string?`, default: `"usage"`) — Heading to look for,
-    wrapped in `new RegExp('^(' + value + ')$', 'i');`.
+###### `options.cwd`
 
+`string?` — Path to a directory containing a node module.  Used to infer `name`,
+`main`, and `example`.
+
+###### `options.name`
+
+`string?` — Name of the module, inferred from `package.json`s `name` property.
+Used to rewrite `require('./index.js')` to `require('some-name')`.
+
+###### `options.main`
+
+`string?` — Path to the main script.  Resolved from `package.json`s `main`
+property (or `index.js`).  Used to rewrite `require('./index.js')` to
+`require('some-name')`.
+
+###### `options.example`
+
+`string?` — Path to the example script.  `remark-usage` checks for
+`docs/example.js`, `doc/example.js`, `examples/index.js`, `example/index.js`,
+and `example.js`.
+
+###### `options.heading`
+
+`string?`, default: `'usage'` — Heading to look for, wrapped in
+`new RegExp('^(' + value + ')$', 'i');`.
+
 ## License
@@ -100,0 +112,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

13139

increased by0.27%

Number of lines in readme file

139

increased by9.45%

No dependency changes