unified

Project: remarkjs/remark-lint

Package: remark-lint-no-file-name-outer-dashes@2.1.1

  1. Dependents: 0
  2. remark-lint rule to warn when file names contain initial or final dashes
  1. remark 214
  2. lint 80
  3. rule 75
  4. remark-lint-rule 68
  5. file 34
  6. name 5
  7. dash 2
  8. hyphen 2

remark-lint-no-file-name-outer-dashes

Build Coverage Downloads Size Sponsors Backers Chat

remark-lint rule to warn when file names start or end with dashes.

Contents

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:

PresetOptions
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-outer-dashes

In Deno with esm.sh:

import remarkLintNoFileNameOuterDashes from 'https://esm.sh/remark-lint-no-file-name-outer-dashes@2'

In browsers with esm.sh:

<script type="module">
  import remarkLintNoFileNameOuterDashes from 'https://esm.sh/remark-lint-no-file-name-outer-dashes@2?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintNoFileNameOuterDashes from 'remark-lint-no-file-name-outer-dashes'
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(remarkLintNoFileNameOuterDashes)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-no-file-name-outer-dashes .

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

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

API

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

unified().use(remarkLintNoFileNameOuterDashes)

Warn when file names start or end with dashes.

Parameters

There are no options.

Returns

Transform (Transformer from unified).

Examples

readme.md
Out

No messages.

-readme.md
Out
1:1: Do not use initial or final dashes in a file name
readme-.md
Out
1:1: Do not use initial or final dashes in a file name

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-outer-dashes@2, compatible with Node.js 12.

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