Package Exports

remark-lint-no-file-name-articles

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-no-file-name-articles) 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-no-file-name-articles

Warn when file names start with an article.

Presets

This rule is included in the following presets:

Preset	Setting
`remark-preset-lint-markdown-style-guide`

Example

`title.md`

Out

No messages.

`a-title.md`

Out

1:1: Do not start file names with `a`

`the-title.md`

Out

1:1: Do not start file names with `the`

`teh-title.md`

Out

1:1: Do not start file names with `teh`

`an-article.md`

Out

1:1: Do not start file names with `an`

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-no-file-name-articles

This package exports no identifiers. The default export is remarkLintNoFileNameArticles.

Use

You probably want to use it on the CLI through a config file:

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-no-file-name-articles",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-no-file-name-articles readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintNoFileNameArticles from 'remark-lint-no-file-name-articles'

 remark()
   .use(remarkLint)
+  .use(remarkLintNoFileNameArticles)
   .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.