mirror of
https://github.com/remarkjs/remark-lint.git
synced 2024-09-19 07:37:57 +03:00
359cd0828e
This change updates the `repository` field in all `package.json`s to add a `directory`. This also modifies the scripts to get the repository URLs. Closes GH-268. Closes GH-269. Reviewed-by: Titus Wormer <tituswormer@gmail.com> |
||
---|---|---|
.. | ||
index.js | ||
package.json | ||
readme.md | ||
tsconfig.json |
remark-lint-final-definition
Warn when definitions are placed somewhere other than at the end of the file.
Presets
This rule is included in the following presets:
Preset | Setting |
---|---|
remark-preset-lint-markdown-style-guide |
Example
ok.md
In
Paragraph.
[example]: http://example.com "Example Domain"
Out
No messages.
not-ok.md
In
Paragraph.
[example]: http://example.com "Example Domain"
Another paragraph.
Out
3:1-3:47: Move definitions to the end of the file (after the node at line `5`)
ok-comments.md
In
Paragraph.
[example-1]: http://example.com/one/
<!-- Comments are fine between and after definitions -->
[example-2]: http://example.com/two/
Out
No messages.
Install
This package is ESM only:
Node 12+ is needed to use it and it must be imported
ed instead of required
d.
npm:
npm install remark-lint-final-definition
This package exports no identifiers.
The default export is remarkLintFinalDefinition
.
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-final-definition",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-final-definition readme.md
Or use this on the API:
import {remark} from 'remark'
import {reporter} from 'vfile-reporter'
import remarkLint from 'remark-lint'
import remarkLintFinalDefinition from 'remark-lint-final-definition'
remark()
.use(remarkLint)
+ .use(remarkLintFinalDefinition)
.process('_Emphasis_ and **importance**')
.then((file) => {
console.error(reporter(file))
})
Contribute
See contributing.md
in remarkjs/.github
for ways
to get started.
See support.md
for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.