remark-lint-no-file-name-articles

remark-lint rule to warn when file names start with a, the, and such.

Contents

What is this?
When should I use this?
Presets
Install
Use
API
- unified().use(remarkLintNoFileNameArticles)
Examples
Compatibility
Contribute
License

What is this?

This package checks file names.

When should I use this?

You can use this package to check that file names are consistent.

Presets

This plugin is included in the following presets:

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

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install remark-lint-no-file-name-articles

In Deno with esm.sh:

import remarkLintNoFileNameArticles from 'https://esm.sh/remark-lint-no-file-name-articles@3'

In browsers with esm.sh:

<script type="module">
  import remarkLintNoFileNameArticles from 'https://esm.sh/remark-lint-no-file-name-articles@3?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintNoFileNameArticles from 'remark-lint-no-file-name-articles'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'

const file = await read('example.md')

await unified()
  .use(remarkParse)
  .use(remarkLint)
  .use(remarkLintNoFileNameArticles)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-no-file-name-articles .

On the CLI in a config file (here a package.json):

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

API

This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintNoFileNameArticles.

`unified().use(remarkLintNoFileNameArticles)`

Warn when file names start with a, the, and such.

Parameters

There are no options.

Returns

Transform (Transformer from unified).

Examples

`title.md`

Out

No messages.

`a-title.md`

Out

1:1: Unexpected file name starting with `a`, remove it

`the-title.md`

Out

1:1: Unexpected file name starting with `the`, remove it

`an-article.md`

Out

1:1: Unexpected file name starting with `an`, remove it

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, remark-lint-no-file-name-articles@3, compatible with Node.js 16.

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

Uh oh!