remark-lint-final-newline

remark-lint rule to warn when a newline at the end of a file is missing

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
remark-lint-final-newline
3.0.02 months ago7 years agoMinified + gzip package size for remark-lint-final-newline in KB

Readme

remark-lint-final-newline
!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 a final line ending is missing.

Contents

unified().use(remarkLintFinalNewline)

What is this?

This package checks the final line ending.

When should I use this?

You can use this package to check final line endings.

Presets

This plugin is included in the following presets:
| Preset | Options | | - | - | | remark-preset-lint-recommended | |

Install

This package is ESM onlygithub-gist-esm. In Node.js (version 16+), install with npmnpm-install:
npm install remark-lint-final-newline

In Deno with esm.shesm-sh:
import remarkLintFinalNewline from 'https://esm.sh/remark-lint-final-newline@3'

In browsers with esm.shesm-sh:
<script type="module">
  import remarkLintFinalNewline from 'https://esm.sh/remark-lint-final-newline@3?bundle'
</script>

Use

On the API:
import remarkLint from 'remark-lint'
import remarkLintFinalNewline from 'remark-lint-final-newline'
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(remarkLintFinalNewline)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:
remark --frail --use remark-lint --use remark-lint-final-newline .

On the CLI in a config file (here a package.json):
…
"remarkConfig": {
  "plugins": [
    …
    "remark-lint",
+    "remark-lint-final-newline",
    …
  ]
}
…

API

This package exports no identifiers. It exports no additional TypeScripttypescript types. The default export is remarkLintFinalNewlineapi-remark-lint-final-newline.

unified().use(remarkLintFinalNewline)

Warn when a final line ending is missing.
Parameters
There are no options.
Returns
Transform (Transformer from unifiedgithub-unified-transformer).

Recommendation

Turn this rule on. See StackExchange for more info.

Fix

remark-stringify always adds final line endings.

Examples

ok.md
In
Mercury␊
Out
No messages.
not-ok.md
In
Mercury␀
Out
1:8: Unexpected missing final newline character, expected line feed (`\n`) at end of file

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-final-newline@3, 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