Package Exports

remark-lint-final-definition

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-lint-final-definition) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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 importeded instead of requiredd.

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.