![Chat](https://img.shields.io/badge/chat-spectrum.svg)
Warn when hard tabs (\t
) are used instead of spaces.
Fix
remark-stringify
uses spaces where tabs are used for indentation, but retains tabs used in
content.
See Using remark to fix your Markdown
on how to automatically fix warnings for this rule.
Presets
This rule is not included in any default preset
Example
ok.md
In
Note: ·
represents a space.
Foo Bar
····Foo
Out
No messages.
not-ok.md
In
Note: »
represents a tab.
»Here's one before a code block.
Here's a tab:», and here is another:».
And this is in `inline»code`.
>»This is in a block quote.
*»And…
»1.»in a list.
And this is a tab as the last character.»
Out
1:1: Use spaces instead of tabs
3:14: Use spaces instead of tabs
3:37: Use spaces instead of tabs
5:23: Use spaces instead of tabs
7:2: Use spaces instead of tabs
9:2: Use spaces instead of tabs
11:1: Use spaces instead of tabs
11:4: Use spaces instead of tabs
13:41: Use spaces instead of tabs
Install
npm:
npm install remark-lint-no-tabs
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-no-tabs",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-no-tabs 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-no-tabs'))
.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