Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
remark-lint-code-block-style
Advanced tools
Readme
remark-lint
rule to warn when code blocks violate a given style.
This package is a unified (remark) plugin, specifically a remark-lint
rule.
Lint rules check markdown code style.
You can use this package to check that code blocks are consistent.
This rule is included in the following presets:
Preset | Setting |
---|---|
remark-preset-lint-consistent | 'consistent' |
remark-preset-lint-markdown-style-guide | 'fenced' |
This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install remark-lint-code-block-style
In Deno with esm.sh
:
import remarkLintCodeBlockStyle from 'https://esm.sh/remark-lint-code-block-style@3'
In browsers with esm.sh
:
<script type="module">
import remarkLintCodeBlockStyle from 'https://esm.sh/remark-lint-code-block-style@3?bundle'
</script>
On the API:
import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {remark} from 'remark'
import remarkLint from 'remark-lint'
import remarkLintCodeBlockStyle from 'remark-lint-code-block-style'
main()
async function main() {
const file = await remark()
.use(remarkLint)
.use(remarkLintCodeBlockStyle)
.process(await read('example.md'))
console.error(reporter(file))
}
On the CLI:
remark --use remark-lint --use remark-lint-code-block-style example.md
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-code-block-style",
…
]
}
…
This package exports no identifiers.
The default export is remarkLintCodeBlockStyle
.
unified().use(remarkLintCodeBlockStyle[, config])
This rule supports standard configuration that all remark lint rules accept
(such as false
to turn it off or [1, options]
to configure it).
The following options (default: 'consistent'
) are accepted:
'fenced'
— prefer fenced code blocks:
```js
code()
```
'indented'
— prefer indented code blocks:
code()
'consistent'
— detect the first used style and warn when further code blocks differIndentation in markdown is complex, especially because lists and indented
code can interfere in unexpected ways.
Fenced code has more features than indented code: importantly, specifying a
programming language.
Since CommonMark took the idea of fenced code from GFM, fenced code became
widely supported.
Due to this, it’s recommended to configure this rule with 'fenced'
.
remark-stringify
formats code blocks as fenced code when they have a language flag and as
indented code otherwise.
Pass
fences: true
to always use fenced code.
ok.md
When configured with 'indented'
.
alpha()
Paragraph.
bravo()
No messages.
not-ok.md
When configured with 'indented'
.
```
alpha()
```
Paragraph.
```
bravo()
```
1:1-3:4: Code blocks should be indented
7:1-9:4: Code blocks should be indented
ok.md
When configured with 'fenced'
.
```
alpha()
```
Paragraph.
```
bravo()
```
No messages.
not-ok-fenced.md
When configured with 'fenced'
.
alpha()
Paragraph.
bravo()
1:1-1:12: Code blocks should be fenced
5:1-5:12: Code blocks should be fenced
not-ok-consistent.md
alpha()
Paragraph.
```
bravo()
```
5:1-7:4: Code blocks should be indented
not-ok-incorrect.md
When configured with '💩'
.
1:1: Incorrect code block style `💩`: use either `'consistent'`, `'fenced'`, or `'indented'`
Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.
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 code blocks do not adhere to a given style
The npm package remark-lint-code-block-style receives a total of 77,473 weekly downloads. As such, remark-lint-code-block-style popularity was classified as popular.
We found that remark-lint-code-block-style 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
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.