unified

Project: remarkjs/remark-lint

Package: remark-lint-final-newline@1.0.5

  1. Dependencies: 1·Dependents: 20
  2. remark-lint rule to warn when a newline at the end of a file is missing
  1. remark 169
  2. lint 68
  3. rule 64
  4. remark-lint-rule 63
  5. final 2
  6. newline 2
  7. unix 2

remark-lint-final-newline

Build Coverage Downloads Size Sponsors Backers Chat

Warn when a line feed at the end of a file is missing. Empty files are allowed.

See StackExchange for why.

Fix

remark-stringify always adds a final line feed to files.

See Using remark to fix your Markdown on how to automatically fix warnings for this rule.

Example

ok.md
In

Note: represents LF.

Alpha␊
Out

No messages.

not-ok.md
In

Note: The below file does not have a final newline.

Bravo
Out
1:1: Missing newline character at end of file

Presets

This rule is included in the following presets:

PresetSetting
remark-preset-lint-recommended

Install

npm:

npm install remark-lint-final-newline

Use

You probably want to use it on the CLI through a config file:

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-final-newline",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-final-newline readme.md

Or use this on the API:

 var remark = require('remark')
 var report = require('vfile-reporter')

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-final-newline'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || file))
   })

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