remark-lint/packages/remark-lint-final-newline

remark-lint-final-newline

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

See StackExchange for why.

Fix

remark-stringify always adds a final newline to files.

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

Example

valid.md

In

Note: ␊ represents LF.

Alpha␊

Out

No messages.

invalid.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:

Preset	Setting
remark-preset-lint-recommended

Install

npm install remark-lint-final-newline

Usage

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));
   });

License

MIT © Titus Wormer