unified

Project: remarkjs/remark-lint

Package: remark-lint-final-definition@2.0.1

  1. Dependencies: 4·Dependents: 16
  2. remark-lint rule to warn when definitions are not placed at the end of the file
  1. remark 188
  2. lint 68
  3. rule 64
  4. remark-lint-rule 63
  5. definition 13
  6. position 8
  7. final 2

remark-lint-final-definition

Build Coverage Downloads Size Sponsors Backers Chat

Warn when definitions are placed somewhere other than at the end of the file.

Presets

This rule is included in the following presets:

PresetSetting
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`)

Install

npm:

npm install remark-lint-final-definition

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:

 var remark = require('remark')
 var report = require('vfile-reporter')

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-final-definition'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || 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.

License

MIT © Titus Wormer