remark-lint-no-shell-dollars - npm Package Compare versions

Comparing version 2.0.2 to 3.0.0

index.js

@@ -11,3 +11,4 @@ /**
  *
- * @example {"name": "ok.md"}
+ * @example
+ *   {"name": "ok.md"}
  *
@@ -37,6 +38,7 @@ *   ```bash
  *   ```js
- *   $('div').remove();
+ *   $('div').remove()
  *   ```
  *
- * @example {"name": "not-ok.md", "label": "input"}
+ * @example
+ *   {"name": "not-ok.md", "label": "input"}
  *
@@ -52,3 +54,4 @@ *   ```sh
  *
- * @example {"name": "not-ok.md", "label": "output"}
+ * @example
+ *   {"name": "not-ok.md", "label": "output"}
  *
@@ -59,16 +62,14 @@ *   1:1-3:4: Do not use dollar signs before shell commands
 
-'use strict'
+/**
+ * @typedef {import('mdast').Root} Root
+ */
 
-var rule = require('unified-lint-rule')
-var visit = require('unist-util-visit')
-var generated = require('unist-util-generated')
+import {lintRule} from 'unified-lint-rule'
+import {visit} from 'unist-util-visit'
+import {generated} from 'unist-util-generated'
 
-module.exports = rule('remark-lint:no-shell-dollars', noShellDollars)
-
-var reason = 'Do not use dollar signs before shell commands'
-
 // List of shell script file extensions (also used as code flags for syntax
 // highlighting on GitHub):
 // See: <https://github.com/github/linguist/blob/40992ba/lib/linguist/languages.yml#L4984>
-var flags = [
+const flags = new Set([
   'sh',
@@ -84,38 +85,34 @@ 'bash',
   'zsh'
-]
+])
 
-function noShellDollars(tree, file) {
-  visit(tree, 'code', visitor)
+const remarkLintNoShellDollars = lintRule(
+  'remark-lint:no-shell-dollars',
+  /** @type {import('unified-lint-rule').Rule<Root, void>} */
+  (tree, file) => {
+    visit(tree, 'code', (node) => {
+      // Check both known shell code and unknown code.
+      if (!generated(node) && node.lang && flags.has(node.lang)) {
+        const lines = node.value
+          .split('\n')
+          .filter((line) => line.trim().length > 0)
+        let index = -1
 
-  function visitor(node) {
-    var lines
-    var line
-    var length
-    var index
+        if (lines.length === 0) {
+          return
+        }
 
-    // Check both known shell code and unknown code.
-    if (!generated(node) && node.lang && flags.indexOf(node.lang) !== -1) {
-      lines = node.value.split('\n').filter(notEmpty)
-      length = lines.length
-      index = -1
+        while (++index < lines.length) {
+          const line = lines[index]
 
-      if (length === 0) {
-        return
-      }
+          if (line.trim() && !/^\s*\$\s*/.test(line)) {
+            return
+          }
+        }
 
-      while (++index < length) {
-        line = lines[index]
-
-        if (line.trim() && !line.match(/^\s*\$\s*/)) {
-          return
-        }
+        file.message('Do not use dollar signs before shell commands', node)
       }
-
-      file.message(reason, node)
-    }
+    })
   }
+)
 
-  function notEmpty(line) {
-    return line.trim().length !== 0
-  }
-}
+export default remarkLintNoShellDollars

package.json

 {
   "name": "remark-lint-no-shell-dollars",
-  "version": "2.0.2",
+  "version": "3.0.0",
   "description": "remark-lint rule to warn when shell code is prefixed by dollars",
@@ -24,11 +24,27 @@ "license": "MIT",
   ],
+  "sideEffects": false,
+  "type": "module",
+  "main": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js"
   ],
   "dependencies": {
-    "unified-lint-rule": "^1.0.0",
-    "unist-util-generated": "^1.1.0",
-    "unist-util-visit": "^2.0.0"
+    "@types/mdast": "^3.0.0",
+    "unified": "^10.0.0",
+    "unified-lint-rule": "^2.0.0",
+    "unist-util-generated": "^2.0.0",
+    "unist-util-visit": "^4.0.0"
   },
-  "xo": false
+  "scripts": {
+    "build": "rimraf \"*.d.ts\" && tsc && type-coverage"
+  },
+  "xo": false,
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true,
+    "ignoreCatch": true
+  }
 }

readme.md

@@ -55,3 +55,3 @@ <!--This file is generated-->
 ```js
-$('div').remove();
+$('div').remove()
 ```
@@ -88,2 +88,5 @@ ````
 
+This package is [ESM only][esm]:
+Node 12+ is needed to use it and it must be `imported`ed instead of `required`d.
+
 [npm][]:
@@ -95,2 +98,5 @@
 
+This package exports no identifiers.
+The default export is `remarkLintNoShellDollars`.
+
 ## Use
@@ -122,10 +128,13 @@
 ```diff
- var remark = require('remark')
- var report = require('vfile-reporter')
+ import {remark} from 'remark'
+ import {reporter} from 'vfile-reporter'
+ import remarkLint from 'remark-lint'
+ import remarkLintNoShellDollars from 'remark-lint-no-shell-dollars'
 
  remark()
-   .use(require('remark-lint'))
-+  .use(require('remark-lint-no-shell-dollars'))
-   .process('_Emphasis_ and **importance**', function (err, file) {
-     console.error(report(err || file))
+   .use(remarkLint)
++  .use(remarkLintNoShellDollars)
+   .process('_Emphasis_ and **importance**')
+   .then((file) => {
+     console.error(reporter(file))
    })
@@ -148,5 +157,5 @@ ```
 
-[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/main.svg
+[build-badge]: https://github.com/remarkjs/remark-lint/workflows/main/badge.svg
 
-[build]: https://travis-ci.org/remarkjs/remark-lint
+[build]: https://github.com/remarkjs/remark-lint/actions
 
@@ -171,6 +180,8 @@ [coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg
 
-[chat-badge]: https://img.shields.io/badge/chat-spectrum.svg
+[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
 
-[chat]: https://spectrum.chat/unified/remark
+[chat]: https://github.com/remarkjs/remark/discussions
 
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+
 [npm]: https://docs.npmjs.com/cli/install
@@ -177,0 +188,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

7884

increased by17.81%

Number of package files

4

increased by33.33%

Lines of code

120

increased by16.5%

Number of lines in readme file

194

increased by6.01%

Is type module

Yes

Worsened metrics

Dependency count

5

increased by66.67%

Dependency changes

• + Added@types/mdast@^3.0.0

• + Addedunified@^10.0.0

• + Added@types/mdast@3.0.15(transitive)

• + Addedbail@2.0.2(transitive)

• + Addedextend@3.0.2(transitive)

• + Addedis-buffer@2.0.5(transitive)

• + Addedis-plain-obj@4.1.0(transitive)

• + Addedtrough@2.2.0(transitive)

• + Addedunified@10.1.2(transitive)

• + Addedunified-lint-rule@2.1.2(transitive)

• + Addedunist-util-generated@2.0.1(transitive)

• + Addedunist-util-is@5.2.1(transitive)

• + Addedunist-util-stringify-position@3.0.3(transitive)

• + Addedunist-util-visit@4.1.2(transitive)

• + Addedunist-util-visit-parents@5.1.3(transitive)

• + Addedvfile@5.3.7(transitive)

• + Addedvfile-message@3.1.4(transitive)

• - Removedco@3.1.0(transitive)

• - Removedsliced@1.0.1(transitive)

• - Removedunified-lint-rule@1.0.6(transitive)

• - Removedunist-util-generated@1.1.6(transitive)

• - Removedunist-util-is@4.1.0(transitive)

• - Removedunist-util-visit@2.0.3(transitive)

• - Removedunist-util-visit-parents@3.1.1(transitive)

• - Removedwrapped@1.0.1(transitive)

• Updatedunified-lint-rule@^2.0.0

• Updatedunist-util-generated@^2.0.0

• Updatedunist-util-visit@^4.0.0