remark-lint-linebreak-style

!Buildbadge-build-imagebadge-build-url !Coveragebadge-coverage-imagebadge-coverage-url !Downloadsbadge-downloads-imagebadge-downloads-url !Sizebadge-size-imagebadge-size-url !Sponsorsbadge-funding-sponsors-imagebadge-funding-url !Backersbadge-funding-backers-imagebadge-funding-url !Chatbadge-chat-imagebadge-chat-url
remark-lintgithub-remark-lint rule to warn when line endings violate a given style.

Contents

• When should I use this?
• When should I use this?
• Presets
• Install
• Use
• API

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

• Recommendation
• Fix
• Examples
• Compatibility
• Contribute
• License

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 onlygithub-gist-esm. In Node.js (version 16+), install with npmnpm-install:

npm install remark-lint-linebreak-style

In Deno with esm.shesm-sh:

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

In browsers with esm.shesm-sh:

<script type="module">
  import remarkLintLinebreakStyle from 'https://esm.sh/remark-lint-linebreak-style@4?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 TypeScripttypescript types Optionsapi-options and Styleapi-style. The default export is remarkLintLinebreakStyleapi-remark-lint-linebreak-style.

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

Warn when line endings violate a given style.

Parameters

• options (Optionsapi-options, default: 'consistent')

— preferred style or whether to detect the first style and warn for further differences

Returns

Transform (Transformer from unifiedgithub-unified-transformer).

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-stringifygithub-remark-stringify always uses Unix line endings.

Examples

ok-consistent-as-windows.md

In

Mercury␍␊and␍␊Venus.

Out

No messages.

ok-consistent-as-unix.md

In

Mercury␊and␊Venus.

Out

No messages.

not-ok-unix.md

When configured with 'unix'.

In

Mercury.␍␊

Out

1:10: Unexpected windows (`\r\n`) line ending, expected unix (`\n`) line endings

not-ok-windows.md

When configured with 'windows'.

In

Mercury.␊

Out

1:9: Unexpected unix (`\n`) line ending, expected windows (`\r\n`) line endings

not-ok-options.md

When configured with '🌍'.

Out

1:1: Unexpected value `🌍` for `options`, expected `'unix'`, `'windows'`, or `'consistent'`

many.md

When configured with 'windows'.

In

Mercury.␊Venus.␊Earth.␊Mars.␊Jupiter.␊Saturn.␊Uranus.␊Neptune.␊

Out

1:9: Unexpected unix (`\n`) line ending, expected windows (`\r\n`) line endings
2:7: Unexpected unix (`\n`) line ending, expected windows (`\r\n`) line endings
3:7: Unexpected unix (`\n`) line ending, expected windows (`\r\n`) line endings
4:6: Unexpected unix (`\n`) line ending, expected windows (`\r\n`) line endings
5:9: Unexpected unix (`\n`) line ending, expected windows (`\r\n`) line endings
6:8: Unexpected large number of incorrect line endings, stopping

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

Contribute

See contributing.mdgithub-dotfiles-contributing in remarkjs/.githubgithub-dotfiles-health for ways to get started. See support.mdgithub-dotfiles-support for ways to get help.
This project has a code of conductgithub-dotfiles-coc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITfile-license © Titus Wormerauthor