https://github.com/electron/lint-roller

https://github.com/electron/lint-roller

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/electron/lint-roller
• Owner: electron
• License: mit
• Created: 2023-02-24T19:32:15.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-07T00:19:18.000Z (9 months ago)
• Last Synced: 2024-04-14T03:56:18.914Z (8 months ago)
• Language: JavaScript
• Size: 273 KB
• Stars: 2
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# @electron/lint-roller

[![CircleCI](https://dl.circleci.com/status-badge/img/gh/electron/lint-roller/tree/main.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/electron/lint-roller/tree/main)

[![npm version](http://img.shields.io/npm/v/@electron/lint-roller.svg)](https://npmjs.org/package/@electron/lint-roller)

> Markdown linting helpers for Electron org repos

## Usage

```bash

yarn global add @electron/lint-roller

electron-markdownlint "**/*.md"

lint-roller-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`:

```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.

`lint-roller-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.

`lint-roller-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.

`lint-roller-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-expect-error=[,]` 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