remark-lint-code-block-syntax

A remark-lint rule to check language syntax in a code block.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
remark-lint-code-block-syntax
130.6.03 months ago3 years agoMinified + gzip package size for remark-lint-code-block-syntax in KB

Readme

npm node
remark-lint-code-block-syntax
A remark-lint rule to check language syntax in a code block.

Supported languages

  • JavaScript
  • JSON
  • YAML
  • CSS

Install

$ npm install remark-lint-code-block-syntax

Usage

Via a command-line argument:
$ remark --use remark-lint-code-block-syntax
docs/config.md
  32:1-32:4  warning  Invalid JSON: Unexpected token a in JSON at position 128  code-block-syntax  remark-lint

Via a configuration file:
{
  "plugins": ["remark-lint-code-block-syntax"]
}

Via JavaScript API:
import { reporter } from "vfile-reporter";
import { remark } from "remark";
import remarkLintCodeBlockSyntax from "remark-lint-code-block-syntax";

main();

async function main() {
  const code = `
\`\`\`js
const sum = 1 +;
\`\`\`
`;
  const file = await remark().use(remarkLintCodeBlockSyntax).process(code);
  console.error(reporter(file));
}