electron/lint-roller

@electron/lint-roller

Markdown linting helpers for Electron org repos

Usage

yarn global add @electron/lint-roller

electron-markdownlint "**/*.md"
electron-lint-markdown-links --root docs/ "docs/**/*.md"

What It Provides

A base config for markdownlint is provided for consistent linting rules across repos. To use the base config, extend it in .markdownlint.json:

{
  "extends": "@electron/lint-roller/configs/markdownlint.json"
}

electron-markdownlint is provided as a wrapper command which adds extra rules found in this package automatically.

electron-lint-markdown-links is a command to further lint links to find broken relative links, including URL fragments, and can also be used to check external links with the --fetch-external-links option.

electron-lint-markdown-standard is a command to lint JS code blocks in Markdown with standard, like standard-markdown does, but with better detection of code blocks. Linting can be disabled for specific code blocks by adding @nolint to the info string.

electron-lint-markdown-ts-check is a command to type check JS/TS code blocks in Markdown with tsc. Type checking can be disabled for specific code blocks by adding @ts-nocheck to the info string, specific lines can be ignored by adding @ts-ignore=[<line1>,<line2>] to the info string, and additional globals can be defined with @ts-type={name:type}. The Window object can be extended with more types using @ts-window-type={name:type}. When type checking TypeScript blocks in the same Markdown file, global augmentation (via declare global) can be shared between code blocks by putting @ts-noisolate on the code block doing the global augmentation.

License

MIT

lint-roller's Issues

ESLint for Code Blocks

Would be nice to be able to run ESLint over code blocks in the docs.

Type Check Code Blocks in Markdown

In addition to linting with standard, more mistakes in Markdown code blocks would be caught if some type checking was done (e.g. tsc --noEmit --checkJs). This could be opt-out using a flag in the info string for the code block, such as @ts-nocheck. Some extra magic could also be added to check for a require of electron, and if there isn't one, inject a generic one with default imports (app, BrowserWindow, etc).