unified

Project: remarkjs/remark-lint

Package: remark-lint-linebreak-style@3.1.1

  1. Dependents: 0
  2. remark-lint rule to warn when linebreaks violate a given or detected style
  1. remark 214
  2. lint 80
  3. rule 75
  4. remark-lint-rule 68
  5. break 4
  6. line 3
  7. unix 2

remark-lint-linebreak-style

Build Coverage Downloads Size Sponsors Backers Chat

remark-lint rule to warn when line endings violate a given style.

Contents

When should I use this?

This package checks the style of line endings.

When should I use this?

You can use this package to check that the style of line endings is consistent.

Presets

This plugin is not included in presets maintained here.

Install

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

npm install remark-lint-linebreak-style

In Deno with esm.sh:

import remarkLintLinebreakStyle from 'https://esm.sh/remark-lint-linebreak-style@3'

In browsers with esm.sh:

<script type="module">
  import remarkLintLinebreakStyle from 'https://esm.sh/remark-lint-linebreak-style@3?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintLinebreakStyle from 'remark-lint-linebreak-style'
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(remarkLintLinebreakStyle)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-linebreak-style .

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-linebreak-style",
     …
   ]
 }
 …

API

This package exports no identifiers. It exports the TypeScript types Options and Style. The default export is remarkLintLinebreakStyle.

unified().use(remarkLintLinebreakStyle[, options])

Warn when line endings violate a given style.

Parameters
Returns

Transform (Transformer from unified).

Options

Configuration (TypeScript type).

Type
type Options = Style | 'consistent'

Style

Style (TypeScript type).

Type
type Style = 'unix' | 'windows'

Recommendation

In Git projects, you can configure to automatically switch between line endings based on who checks the repo out. In other places, you may want to manually force that one or the other is used.

Fix

remark-stringify always uses Unix linebreaks.

Examples

ok-consistent-as-windows.md
In
Alpha␍␊Bravo␍␊
Out

No messages.

ok-consistent-as-unix.md
In
Alpha␊Bravo␊
Out

No messages.

not-ok-unix.md

When configured with 'unix'.

In
Alpha␍␊
Out
1:7: Expected linebreaks to be unix (`\n`), not windows (`\r\n`)
not-ok-windows.md

When configured with 'windows'.

In
Alpha␊
Out
1:6: Expected linebreaks to be windows (`\r\n`), not unix (`\n`)

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-linebreak-style@3, 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