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

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

This package checks file names.

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

This plugin is included in the following presets:

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@3'

In browsers with esm.sh:

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

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",
     …
   ]
 }
 …

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

Warn when file names start or end with dashes.

There are no options.

Transform (Transformer from unified).

No messages.

1:1: Unexpected initial or final dashes in file name, expected dashes to join words

1:1: Unexpected initial or final dashes in file name, expected dashes to join words

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@3, compatible with Node.js 16.

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.

MIT © Titus Wormer