Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
remark-lint-list-item-indent
Advanced tools
remark-lint rule to warn when the spacing between a list item’s bullet and its content violates a given style
The remark-lint-list-item-indent package is a plugin for remark-lint that ensures consistent indentation for list items in Markdown files. It helps maintain a uniform style and prevents issues related to inconsistent list item indentation.
Check for consistent indentation
This feature checks that list items are indented using spaces. The configuration specifies 'space' to enforce this rule.
module.exports = {
plugins: [
['remark-lint-list-item-indent', 'space']
]
};
Check for tab indentation
This feature checks that list items are indented using tabs. The configuration specifies 'tab' to enforce this rule.
module.exports = {
plugins: [
['remark-lint-list-item-indent', 'tab']
]
};
remark-lint is a general-purpose Markdown linter that can be extended with various plugins, including remark-lint-list-item-indent. It provides a wide range of rules for ensuring Markdown quality and consistency.
markdownlint is a Node.js style checker and lint tool for Markdown files. It offers a comprehensive set of rules and can be customized to enforce specific styles, similar to remark-lint-list-item-indent.
markdown-it is a Markdown parser that can be extended with plugins to enforce specific styles and rules. While it is primarily a parser, it can be used in conjunction with linting tools to achieve similar functionality to remark-lint-list-item-indent.
Warn when the spacing between a list item’s bullet and its content violates a given style.
Options: 'tab-size'
, 'mixed'
, or 'space'
, default: 'tab-size'
.
remark-stringify
uses 'tab-size'
(named 'tab'
there) by default to ensure Markdown is
seen the same way across vendors.
This can be configured with the
listItemIndent
option.
This rule’s 'space'
option is named '1'
there.
See Using remark to fix your Markdown on how to automatically fix warnings for this rule.
This rule is included in the following presets:
Preset | Setting |
---|---|
remark-preset-lint-markdown-style-guide | 'mixed' |
remark-preset-lint-recommended | 'tab-size' |
ok.md
Note: ·
represents a space.
*···List
····item.
Paragraph.
11.·List
····item.
Paragraph.
*···List
····item.
*···List
····item.
No messages.
ok.md
When configured with 'mixed'
.
Note: ·
represents a space.
*·List item.
Paragraph.
11.·List item
Paragraph.
*···List
····item.
*···List
····item.
No messages.
not-ok.md
When configured with 'mixed'
.
Note: ·
represents a space.
*···List item.
1:5: Incorrect list-item indent: remove 2 spaces
ok.md
When configured with 'space'
.
Note: ·
represents a space.
*·List item.
Paragraph.
11.·List item
Paragraph.
*·List
··item.
*·List
··item.
No messages.
not-ok.md
When configured with 'space'
.
Note: ·
represents a space.
*···List
····item.
1:5: Incorrect list-item indent: remove 2 spaces
not-ok.md
When configured with 'tab-size'
.
Note: ·
represents a space.
*·List
··item.
1:3: Incorrect list-item indent: add 2 spaces
not-ok.md
When configured with '💩'
.
1:1: Incorrect list-item indent style `💩`: use either `'tab-size'`, `'space'`, or `'mixed'`
npm:
npm install remark-lint-list-item-indent
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-list-item-indent",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-list-item-indent 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-list-item-indent'))
.process('_Emphasis_ and **importance**', function (err, file) {
console.error(report(err || file))
})
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.
FAQs
remark-lint rule to warn when the spacing between a list item’s bullet and its content violates a given style
The npm package remark-lint-list-item-indent receives a total of 118,482 weekly downloads. As such, remark-lint-list-item-indent popularity was classified as popular.
We found that remark-lint-list-item-indent demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.