remark-lint-no-heading-indent
Advanced tools
Comparing version 3.0.0 to 4.0.0
71
index.js
@@ -17,3 +17,4 @@ /** | ||
* | ||
* @example {"name": "ok.md"} | ||
* @example | ||
* {"name": "ok.md"} | ||
* | ||
@@ -30,3 +31,4 @@ * #·Hello world | ||
* | ||
* @example {"name": "not-ok.md", "label": "input"} | ||
* @example | ||
* {"name": "not-ok.md", "label": "input"} | ||
* | ||
@@ -43,3 +45,4 @@ * ···# Hello world | ||
* | ||
* @example {"name": "not-ok.md", "label": "output"} | ||
* @example | ||
* {"name": "not-ok.md", "label": "output"} | ||
* | ||
@@ -52,35 +55,39 @@ * 1:4: Remove 3 spaces before this heading | ||
'use strict' | ||
/** | ||
* @typedef {import('mdast').Root} Root | ||
*/ | ||
var rule = require('unified-lint-rule') | ||
var plural = require('pluralize') | ||
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 plural from 'pluralize' | ||
import {visit} from 'unist-util-visit' | ||
import {pointStart} from 'unist-util-position' | ||
import {generated} from 'unist-util-generated' | ||
module.exports = rule('remark-lint:no-heading-indent', noHeadingIndent) | ||
const remarkLintNoHeadingIndent = lintRule( | ||
'remark-lint:no-heading-indent', | ||
/** @type {import('unified-lint-rule').Rule<Root, void>} */ | ||
(tree, file) => { | ||
visit(tree, 'heading', (node, _, parent) => { | ||
// Note: it’s rather complex to detect what the expected indent is in block | ||
// quotes and lists, so let’s only do directly in root for now. | ||
if (generated(node) || (parent && parent.type !== 'root')) { | ||
return | ||
} | ||
var start = position.start | ||
const diff = pointStart(node).column - 1 | ||
function noHeadingIndent(tree, file) { | ||
visit(tree, 'heading', visitor) | ||
if (diff) { | ||
file.message( | ||
'Remove ' + | ||
diff + | ||
' ' + | ||
plural('space', diff) + | ||
' before this heading', | ||
pointStart(node) | ||
) | ||
} | ||
}) | ||
} | ||
) | ||
function visitor(node, _, parent) { | ||
var diff | ||
// Note: it’s rather complex to detect what the expected indent is in block | ||
// quotes and lists, so let’s only do directly in root for now. | ||
if (generated(node) || (parent && parent.type !== 'root')) { | ||
return | ||
} | ||
diff = start(node).column - 1 | ||
if (diff) { | ||
file.message( | ||
'Remove ' + diff + ' ' + plural('space', diff) + ' before this heading', | ||
start(node) | ||
) | ||
} | ||
} | ||
} | ||
export default remarkLintNoHeadingIndent |
{ | ||
"name": "remark-lint-no-heading-indent", | ||
"version": "3.0.0", | ||
"version": "4.0.0", | ||
"description": "remark-lint rule to warn when headings are indented", | ||
@@ -24,13 +24,29 @@ "license": "MIT", | ||
], | ||
"sideEffects": false, | ||
"type": "module", | ||
"main": "index.js", | ||
"types": "index.d.ts", | ||
"files": [ | ||
"index.d.ts", | ||
"index.js" | ||
], | ||
"dependencies": { | ||
"@types/mdast": "^3.0.0", | ||
"pluralize": "^8.0.0", | ||
"unified-lint-rule": "^1.0.0", | ||
"unist-util-generated": "^1.1.0", | ||
"unist-util-position": "^3.0.0", | ||
"unist-util-visit": "^2.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 | ||
} | ||
} |
@@ -80,2 +80,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][]: | ||
@@ -87,2 +90,5 @@ | ||
This package exports no identifiers. | ||
The default export is `remarkLintNoHeadingIndent`. | ||
## Use | ||
@@ -114,10 +120,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 remarkLintNoHeadingIndent from 'remark-lint-no-heading-indent' | ||
remark() | ||
.use(require('remark-lint')) | ||
+ .use(require('remark-lint-no-heading-indent')) | ||
.process('_Emphasis_ and **importance**', function (err, file) { | ||
console.error(report(err || file)) | ||
.use(remarkLint) | ||
+ .use(remarkLintNoHeadingIndent) | ||
.process('_Emphasis_ and **importance**') | ||
.then((file) => { | ||
console.error(reporter(file)) | ||
}) | ||
@@ -140,5 +149,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 | ||
@@ -167,2 +176,4 @@ [coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg | ||
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c | ||
[npm]: https://docs.npmjs.com/cli/install | ||
@@ -169,0 +180,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
7768
4
99
187
Yes
7
+ 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-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)
- 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-generated@^2.0.0
Updatedunist-util-position@^4.0.0
Updatedunist-util-visit@^4.0.0