{"library":"remark-lint-no-shell-dollars","title":"remark-lint-no-shell-dollars","description":"remark-lint rule to warn when every line in shell code blocks is prefixed by a `$` sign, which hinders copy/pasting. Current version 4.0.1, part of the remark-lint monorepo. ESM-only, supports Node.js 16+. No configurable options. It is included in the `remark-preset-lint-markdown-style-guide` preset. Differentiates from other lint rules by focusing specifically on shell code readability and usability.","language":"javascript","status":"active","last_verified":"Fri May 01","install":{"commands":["npm install remark-lint-no-shell-dollars"],"cli":null},"imports":["import remarkLintNoShellDollars from 'remark-lint-no-shell-dollars'","\"remark-lint-no-shell-dollars\""],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import remarkLint from 'remark-lint'\nimport remarkLintNoShellDollars from 'remark-lint-no-shell-dollars'\nimport remarkParse from 'remark-parse'\nimport remarkStringify from 'remark-stringify'\nimport {read} from 'to-vfile'\nimport {unified} from 'unified'\nimport {reporter} from 'vfile-reporter'\n\nconst file = await read('example.md')\n\nawait unified()\n  .use(remarkParse)\n  .use(remarkLint)\n  .use(remarkLintNoShellDollars)\n  .use(remarkStringify)\n  .process(file)\n\nconsole.error(reporter(file))","lang":"typescript","description":"Lint a Markdown file for shell code blocks where every line starts with $, indicating copy-paste issues.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}