remark-lint-definition-spacing - npm Package Compare versions

Comparing version 2.0.1 to 3.0.0

index.js

@@ -9,11 +9,14 @@ /**
  *
- * @example {"name": "ok.md"}
+ * @example
+ *   {"name": "ok.md"}
  *
  *   [example domain]: http://example.com "Example Domain"
  *
- * @example {"name": "not-ok.md", "label": "input"}
+ * @example
+ *   {"name": "not-ok.md", "label": "input"}
  *
  *   [example····domain]: http://example.com "Example Domain"
  *
- * @example {"name": "not-ok.md", "label": "output"}
+ * @example
+ *   {"name": "not-ok.md", "label": "output"}
  *
@@ -23,30 +26,38 @@ *   1:1-1:57: Do not use consecutive whitespace in definition labels
 
-'use strict'
+/**
+ * @typedef {import('mdast').Root} Root
+ */
 
-var rule = require('unified-lint-rule')
-var visit = require('unist-util-visit')
-var position = require('unist-util-position')
-var generated = require('unist-util-generated')
+import {lintRule} from 'unified-lint-rule'
+import {visit} from 'unist-util-visit'
+import {pointStart, pointEnd} from 'unist-util-position'
 
-module.exports = rule('remark-lint:definition-spacing', definitionSpacing)
+const label = /^\s*\[((?:\\[\s\S]|[^[\]])+)]/
 
-var label = /^\s*\[((?:\\[\s\S]|[^[\]])+)]/
-var reason = 'Do not use consecutive whitespace in definition labels'
+const remarkLintDefinitionSpacing = lintRule(
+  'remark-lint:definition-spacing',
+  /** @type {import('unified-lint-rule').Rule<Root, void>} */
+  (tree, file) => {
+    const value = String(file)
 
-function definitionSpacing(tree, file) {
-  var contents = String(file)
+    visit(tree, (node) => {
+      if (node.type === 'definition' || node.type === 'footnoteDefinition') {
+        const start = pointStart(node).offset
+        const end = pointEnd(node).offset
 
-  visit(tree, ['definition', 'footnoteDefinition'], check)
+        if (typeof start === 'number' && typeof end === 'number') {
+          const match = value.slice(start, end).match(label)
 
-  function check(node) {
-    var start = position.start(node).offset
-    var end = position.end(node).offset
+          if (match && /[ \t\n]{2,}/.test(match[1])) {
+            file.message(
+              'Do not use consecutive whitespace in definition labels',
+              node
+            )
+          }
+        }
+      }
+    })
+  }
+)
 
-    if (
-      !generated(node) &&
-      /[ \t\n]{2,}/.test(contents.slice(start, end).match(label)[1])
-    ) {
-      file.message(reason, node)
-    }
-  }
-}
+export default remarkLintDefinitionSpacing

package.json

 {
   "name": "remark-lint-definition-spacing",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "remark-lint rule to warn when consecutive whitespace is used in a definition",
@@ -24,12 +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-position": "^3.0.0",
-    "unist-util-visit": "^2.0.0"
+    "@types/mdast": "^3.0.0",
+    "unified": "^10.0.0",
+    "unified-lint-rule": "^2.0.0",
+    "unist-util-position": "^4.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,2 +55,5 @@ <!--This file is generated-->
 
+This package is [ESM only][esm]:
+Node 12+ is needed to use it and it must be `imported`ed instead of `required`d.
+
 [npm][]:
@@ -62,2 +65,5 @@
 
+This package exports no identifiers.
+The default export is `remarkLintDefinitionSpacing`.
+
 ## Use
@@ -89,10 +95,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 remarkLintDefinitionSpacing from 'remark-lint-definition-spacing'
 
  remark()
-   .use(require('remark-lint'))
-+  .use(require('remark-lint-definition-spacing'))
-   .process('_Emphasis_ and **importance**', function (err, file) {
-     console.error(report(err || file))
+   .use(remarkLint)
++  .use(remarkLintDefinitionSpacing)
+   .process('_Emphasis_ and **importance**')
+   .then((file) => {
+     console.error(reporter(file))
    })
@@ -115,5 +124,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
 
@@ -138,6 +147,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
@@ -144,0 +155,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

6988

increased by24.67%

Number of downloads

84656

increased by11.8%

Number of package files

4

increased by33.33%

Lines of code

69

increased by64.29%

Number of lines in readme file

162

increased by7.28%

Is type module

Yes

Worsened metrics

Dependency count

5

increased by25%

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-is@5.2.1(transitive)

• + Addedunist-util-position@4.0.4(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)

• - Removedunist-util-generated@^1.1.0

• - 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-position@3.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-position@^4.0.0

• Updatedunist-util-visit@^4.0.0