remark-lint-fenced-code-flag - npm Package Compare versions

Comparing version 2.0.1 to 3.0.0

index.js

@@ -18,101 +18,128 @@ /**
  *
- * @example {"name": "ok.md"}
+ * @example
+ *   {"name": "ok.md"}
  *
  *   ```alpha
- *   bravo();
+ *   bravo()
  *   ```
  *
- * @example {"name": "not-ok.md", "label": "input"}
+ * @example
+ *   {"name": "not-ok.md", "label": "input"}
  *
  *   ```
- *   alpha();
+ *   alpha()
  *   ```
  *
- * @example {"name": "not-ok.md", "label": "output"}
+ * @example
+ *   {"name": "not-ok.md", "label": "output"}
  *
  *   1:1-3:4: Missing code language flag
  *
- * @example {"name": "ok.md", "setting": {"allowEmpty": true}}
+ * @example
+ *   {"name": "ok.md", "setting": {"allowEmpty": true}}
  *
  *   ```
- *   alpha();
+ *   alpha()
  *   ```
  *
- * @example {"name": "not-ok.md", "setting": {"allowEmpty": false}, "label": "input"}
+ * @example
+ *   {"name": "not-ok.md", "setting": {"allowEmpty": false}, "label": "input"}
  *
  *   ```
- *   alpha();
+ *   alpha()
  *   ```
  *
- * @example {"name": "not-ok.md", "setting": {"allowEmpty": false}, "label": "output"}
+ * @example
+ *   {"name": "not-ok.md", "setting": {"allowEmpty": false}, "label": "output"}
  *
  *   1:1-3:4: Missing code language flag
  *
- * @example {"name": "ok.md", "setting": ["alpha"]}
+ * @example
+ *   {"name": "ok.md", "setting": ["alpha"]}
  *
  *   ```alpha
- *   bravo();
+ *   bravo()
  *   ```
  *
- * @example {"name": "not-ok.md", "setting": ["charlie"], "label": "input"}
+ * @example
+ *   {"name": "ok.md", "setting": {"flags":["alpha"]}}
  *
  *   ```alpha
- *   bravo();
+ *   bravo()
  *   ```
  *
- * @example {"name": "not-ok.md", "setting": ["charlie"], "label": "output"}
+ * @example
+ *   {"name": "not-ok.md", "setting": ["charlie"], "label": "input"}
  *
+ *   ```alpha
+ *   bravo()
+ *   ```
+ *
+ * @example
+ *   {"name": "not-ok.md", "setting": ["charlie"], "label": "output"}
+ *
  *   1:1-3:4: Incorrect code language flag
  */
 
-'use strict'
+/**
+ * @typedef {import('mdast').Root} Root
+ *
+ * @typedef {string[]} Flags
+ *
+ * @typedef FlagMap
+ * @property {Flags} [flags]
+ * @property {boolean} [allowEmpty=false]
+ *
+ * @typedef {Flags|FlagMap} Options
+ */
 
-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'
+import {generated} from 'unist-util-generated'
 
-module.exports = rule('remark-lint:fenced-code-flag', fencedCodeFlag)
+const fence = /^ {0,3}([~`])\1{2,}/
 
-var start = position.start
-var end = position.end
+const remarkLintFencedCodeFlag = lintRule(
+  'remark-lint:fenced-code-flag',
+  /** @type {import('unified-lint-rule').Rule<Root, Options>} */
+  (tree, file, option) => {
+    const value = String(file)
+    let allowEmpty = false
+    /** @type {string[]} */
+    let allowed = []
 
-var fence = /^ {0,3}([~`])\1{2,}/
-var reasonIncorrect = 'Incorrect code language flag'
-var reasonMissing = 'Missing code language flag'
+    if (typeof option === 'object') {
+      if (Array.isArray(option)) {
+        allowed = option
+      } else {
+        allowEmpty = Boolean(option.allowEmpty)
 
-function fencedCodeFlag(tree, file, option) {
-  var contents = String(file)
-  var allowEmpty = false
-  var allowed = []
-  var flags = option
+        if (option.flags) {
+          allowed = option.flags
+        }
+      }
+    }
 
-  if (typeof flags === 'object' && !('length' in flags)) {
-    allowEmpty = Boolean(flags.allowEmpty)
-    flags = flags.flags
-  }
+    visit(tree, 'code', (node) => {
+      if (!generated(node)) {
+        if (node.lang) {
+          if (allowed.length > 0 && !allowed.includes(node.lang)) {
+            file.message('Incorrect code language flag', node)
+          }
+        } else {
+          const slice = value.slice(
+            pointStart(node).offset,
+            pointEnd(node).offset
+          )
 
-  if (typeof flags === 'object' && 'length' in flags) {
-    allowed = String(flags).split(',')
-  }
-
-  visit(tree, 'code', visitor)
-
-  function visitor(node) {
-    var value
-
-    if (!generated(node)) {
-      if (node.lang) {
-        if (allowed.length !== 0 && allowed.indexOf(node.lang) === -1) {
-          file.message(reasonIncorrect, node)
+          if (!allowEmpty && fence.test(slice)) {
+            file.message('Missing code language flag', node)
+          }
         }
-      } else {
-        value = contents.slice(start(node).offset, end(node).offset)
-
-        if (!allowEmpty && fence.test(value)) {
-          file.message(reasonMissing, node)
-        }
       }
-    }
+    })
   }
-}
+)
+
+export default remarkLintFencedCodeFlag

package.json

 {
   "name": "remark-lint-fenced-code-flag",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "remark-lint rule to warn when fenced code blocks occur without language flag",
@@ -26,12 +26,28 @@ "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-generated": "^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

@@ -30,3 +30,3 @@ <!--This file is generated-->
 | - | - |
-| [`remark-preset-lint-markdown-style-guide`](https://github.com/remarkjs/remark-lint/tree/main/packages/remark-preset-lint-markdown-style-guide) | `{allowEmpty: false}` |
+| [`remark-preset-lint-markdown-style-guide`](https://github.com/remarkjs/remark-lint/tree/main/packages/remark-preset-lint-markdown-style-guide) | `{ allowEmpty: false }` |
 
@@ -41,3 +41,3 @@ ## Example
 ```alpha
-bravo();
+bravo()
 ```
@@ -56,3 +56,3 @@ ````
 ```
-alpha();
+alpha()
 ```
@@ -75,3 +75,3 @@ ````
 ```
-alpha();
+alpha()
 ```
@@ -92,3 +92,3 @@ ````
 ```
-alpha();
+alpha()
 ```
@@ -111,3 +111,3 @@ ````
 ```alpha
-bravo();
+bravo()
 ```
@@ -120,2 +120,18 @@ ````
 
+##### `ok.md`
+
+When configured with `{ flags: [ 'alpha' ] }`.
+
+###### In
+
+````markdown
+```alpha
+bravo()
+```
+````
+
+###### Out
+
+No messages.
+
 ##### `not-ok.md`
@@ -129,3 +145,3 @@
 ```alpha
-bravo();
+bravo()
 ```
@@ -142,2 +158,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][]:
@@ -149,2 +168,5 @@
 
+This package exports no identifiers.
+The default export is `remarkLintFencedCodeFlag`.
+
 ## Use
@@ -176,10 +198,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 remarkLintFencedCodeFlag from 'remark-lint-fenced-code-flag'
 
  remark()
-   .use(require('remark-lint'))
-+  .use(require('remark-lint-fenced-code-flag'))
-   .process('_Emphasis_ and **importance**', function (err, file) {
-     console.error(report(err || file))
+   .use(remarkLint)
++  .use(remarkLintFencedCodeFlag)
+   .process('_Emphasis_ and **importance**')
+   .then((file) => {
+     console.error(reporter(file))
    })
@@ -202,5 +227,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
 
@@ -225,6 +250,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
@@ -231,0 +258,0 @@

No alert changes

Improved metrics

Total package byte prevSize

9746

24.74%

Number of package files

4

33.33%

Lines of code

161

53.33%

Number of lines in readme file

257

11.74%

Is type module

Yes

NaN

Worsened metrics

Dependency count

6

50%

Dependency changes

• + Added

  @types/mdast@^3.0.0

• + Added

  unified@^10.0.0

• + Added

  @types/mdast@3.0.15
  (transitive)

• + Added

  bail@2.0.2
  (transitive)

• + Added

  extend@3.0.2
  (transitive)

• + Added

  is-buffer@2.0.5
  (transitive)

• + Added

  is-plain-obj@4.1.0
  (transitive)

• + Added

  trough@2.2.0
  (transitive)

• + Added

  unified@10.1.2
  (transitive)

• + Added

  unified-lint-rule@2.1.2
  (transitive)

• + Added

  unist-util-generated@2.0.1
  (transitive)

• + Added

  unist-util-is@5.2.1
  (transitive)

• + Added

  unist-util-position@4.0.4
  (transitive)

• + Added

  unist-util-stringify-position@3.0.3
  (transitive)

• + Added

  unist-util-visit@4.1.2
  (transitive)

• + Added

  unist-util-visit-parents@5.1.3
  (transitive)

• + Added

  vfile@5.3.7
  (transitive)

• + Added

  vfile-message@3.1.4
  (transitive)

• - Removed

  co@3.1.0
  (transitive)

• - Removed

  sliced@1.0.1
  (transitive)

• - Removed

  unified-lint-rule@1.0.6
  (transitive)

• - Removed

  unist-util-generated@1.1.6
  (transitive)

• - Removed

  unist-util-is@4.1.0
  (transitive)

• - Removed

  unist-util-position@3.1.0
  (transitive)

• - Removed

  unist-util-visit@2.0.3
  (transitive)

• - Removed

  unist-util-visit-parents@3.1.1
  (transitive)

• - Removed

  wrapped@1.0.1
  (transitive)

• Updated

  unified-lint-rule@^2.0.0

• Updated

  unist-util-generated@^2.0.0

• Updated

  unist-util-position@^4.0.0

• Updated

  unist-util-visit@^4.0.0