remark-lint-linebreak-style

2019-10-09

remark-lint rule to warn when linebreaks violate a given or detected style

remark-lint-linebreak-style

BuildCoverageDownloadsSizeSponsorsBackersChat

Warn when linebreaks violate a given or detected style.

Options: either 'unix'(for \n, denoted as ), 'windows'(for \r\n, denoted as ␍␊), or 'consistent'(to detect the first used linebreak in a file). Default: 'consistent'.

Fix

remark-stringifyalways uses unix-style linebreaks.

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

Presets

This rule is not included in any default preset

Example

valid-consistent-as-windows.md
In

Note: ␍␊represents a carriage return and a line feed.

Alpha␍␊
Bravo␍␊
Out

No messages.

valid-consistent-as-unix.md
In

Note: represents a line feed.

Alpha␊
Bravo␊
Out

No messages.

invalid-unix.md

When configured with 'unix'.

In

Note: ␍␊represents a carriage return and a line feed.

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

When configured with 'windows'.

In

Note: represents a line feed.

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

Install

npm:

npm install remark-lint-linebreak-style

Use

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

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

Or use it on the CLI directly

remark -u lint -u lint-linebreak-style 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-linebreak-style'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || file));
   });

Contribute

See contributing.mdin remarkjs/.githubfor ways to get started. See support.mdfor ways to get help.

This project has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT© Titus Wormer

Repository

https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-linebreak-style


上一篇:tap-yaml
下一篇:remark-lint-no-paragraph-content-indent
相关教程
关注微信

扫码加入 JavaScript 社区

相关文章

首次访问,需要验证
微信扫码,关注即可
(仅需验证一次)

欢迎加入 JavaScript 社区

号内回复关键字:

回到顶部