Security News
Highlights from the 2024 Rails Community Survey
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
remark-lint-no-shell-dollars
Advanced tools
remark-lint rule to warn when shell code is prefixed by dollars
remark-lint
rule to warn when every line in shell code is preceded by $
s.
This package checks for $
markers prefixing shell code,
which are hard to copy/paste.
You can use this package to check shell code blocks.
This plugin is included in the following presets:
Preset | Options |
---|---|
remark-preset-lint-markdown-style-guide |
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-no-shell-dollars
In Deno with esm.sh
:
import remarkLintNoShellDollars from 'https://esm.sh/remark-lint-no-shell-dollars@4'
In browsers with esm.sh
:
<script type="module">
import remarkLintNoShellDollars from 'https://esm.sh/remark-lint-no-shell-dollars@4?bundle'
</script>
On the API:
import remarkLint from 'remark-lint'
import remarkLintNoShellDollars from 'remark-lint-no-shell-dollars'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'
const file = await read('example.md')
await unified()
.use(remarkParse)
.use(remarkLint)
.use(remarkLintNoShellDollars)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-no-shell-dollars .
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-shell-dollars",
…
]
}
…
This package exports no identifiers.
It exports no additional TypeScript types.
The default export is
remarkLintNoShellDollars
.
unified().use(remarkLintNoShellDollars)
Warn when every line in shell code is preceded by $
s.
There are no options.
Transform (Transformer
from unified
).
Dollars make copy/pasting hard. Either put dollars in front of some lines (commands) and don’t put them in front of other lines (output), or use different code blocks for commands and output.
ok.md
```bash
echo "Mercury and Venus"
```
```sh
echo "Mercury and Venus"
echo "Earth and Mars" > file
```
Mixed dollars for input lines and without for output is also OK:
```zsh
$ echo "Mercury and Venus"
Mercury and Venus
$ echo "Earth and Mars" > file
```
```command
```
```js
$('div').remove()
```
No messages.
not-ok.md
```sh
$ echo "Mercury and Venus"
```
```bash
$ echo "Mercury and Venus"
$ echo "Earth and Mars" > file
```
1:1-3:4: Unexpected shell code with every line prefixed by `$`, expected different code for input and output
5:1-8:4: Unexpected shell code with every line prefixed by `$`, expected different code for input and output
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
remark-lint-no-shell-dollars@4
,
compatible with Node.js 16.
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 shell code is prefixed by dollars
The npm package remark-lint-no-shell-dollars receives a total of 60,961 weekly downloads. As such, remark-lint-no-shell-dollars popularity was classified as popular.
We found that remark-lint-no-shell-dollars 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
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.