remark-lint-no-reference-like-url
Advanced tools
remark-lint-no-reference-like-url - npm Package Compare versions
Comparing version
77
index.js
@@ -9,3 +9,4 @@ /** | ||
| * | ||
| * @example {"name": "ok.md"} | ||
| * @example | ||
| * {"name": "ok.md"} | ||
| * | ||
@@ -16,3 +17,4 @@ * [Alpha](http://example.com). | ||
| * | ||
| * @example {"name": "not-ok.md", "label": "input"} | ||
| * @example | ||
| * {"name": "not-ok.md", "label": "input"} | ||
| * | ||
@@ -23,3 +25,4 @@ * [Charlie](delta). | ||
| * | ||
| * @example {"name": "not-ok.md", "label": "output"} | ||
| * @example | ||
| * {"name": "not-ok.md", "label": "output"} | ||
| * | ||
@@ -29,40 +32,42 @@ * 1:1-1:17: Did you mean to use `[delta]` instead of `(delta)`, a reference? | ||
| 'use strict' | ||
| /** | ||
| * @typedef {import('mdast').Root} Root | ||
| */ | ||
| var rule = require('unified-lint-rule') | ||
| var generated = require('unist-util-generated') | ||
| var visit = require('unist-util-visit') | ||
| import {lintRule} from 'unified-lint-rule' | ||
| import {generated} from 'unist-util-generated' | ||
| import {visit} from 'unist-util-visit' | ||
| module.exports = rule('remark-lint:no-reference-like-url', noReferenceLikeURL) | ||
| const remarkLintNoReferenceLikeUrl = lintRule( | ||
| 'remark-lint:no-reference-like-url', | ||
| /** @type {import('unified-lint-rule').Rule<Root, void>} */ | ||
| (tree, file) => { | ||
| /** @type {string[]} */ | ||
| const identifiers = [] | ||
| function noReferenceLikeURL(tree, file) { | ||
| var identifiers = [] | ||
| visit(tree, 'definition', (node) => { | ||
| if (!generated(node)) { | ||
| identifiers.push(node.identifier.toLowerCase()) | ||
| } | ||
| }) | ||
| visit(tree, 'definition', find) | ||
| visit(tree, ['image', 'link'], check) | ||
| // Find identifiers. | ||
| function find(node) { | ||
| if (!generated(node)) { | ||
| identifiers.push(node.identifier.toLowerCase()) | ||
| } | ||
| visit(tree, (node) => { | ||
| if ( | ||
| (node.type === 'image' || node.type === 'link') && | ||
| identifiers.includes(node.url.toLowerCase()) | ||
| ) { | ||
| file.message( | ||
| 'Did you mean to use `[' + | ||
| node.url + | ||
| ']` instead of ' + | ||
| '`(' + | ||
| node.url + | ||
| ')`, a reference?', | ||
| node | ||
| ) | ||
| } | ||
| }) | ||
| } | ||
| ) | ||
| // Check `node`. | ||
| function check(node) { | ||
| var url = node.url | ||
| var reason | ||
| if (identifiers.indexOf(url.toLowerCase()) !== -1) { | ||
| reason = | ||
| 'Did you mean to use `[' + | ||
| url + | ||
| ']` instead of ' + | ||
| '`(' + | ||
| url + | ||
| ')`, a reference?' | ||
| file.message(reason, node) | ||
| } | ||
| } | ||
| } | ||
| export default remarkLintNoReferenceLikeUrl |
| { | ||
| "name": "remark-lint-no-reference-like-url", | ||
| "version": "2.0.1", | ||
| "version": "3.0.0", | ||
| "description": "remark-lint rule to warn when URLs are also defined identifiers", | ||
@@ -25,11 +25,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 | ||
| } | ||
| } |
@@ -53,2 +53,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][]: | ||
@@ -60,2 +63,5 @@ | ||
| This package exports no identifiers. | ||
| The default export is `remarkLintNoReferenceLikeUrl`. | ||
| ## Use | ||
@@ -87,10 +93,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 remarkLintNoReferenceLikeUrl from 'remark-lint-no-reference-like-url' | ||
| remark() | ||
| .use(require('remark-lint')) | ||
| + .use(require('remark-lint-no-reference-like-url')) | ||
| .process('_Emphasis_ and **importance**', function (err, file) { | ||
| console.error(report(err || file)) | ||
| .use(remarkLint) | ||
| + .use(remarkLintNoReferenceLikeUrl) | ||
| .process('_Emphasis_ and **importance**') | ||
| .then((file) => { | ||
| console.error(reporter(file)) | ||
| }) | ||
@@ -113,5 +122,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 | ||
@@ -136,6 +145,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 | ||
@@ -142,0 +153,0 @@ |
Improved metrics
- Total package byte prevSize
6763
24.34%- Number of package files
4
33.33%- Lines of code
79
43.64%- Number of lines in readme file
160
7.38%- Is type module
Yes
NaNWorsened metrics
- Dependency count
5
66.67%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-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-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.0Updated
unist-util-generated@^2.0.0Updated
unist-util-visit@^4.0.0