remark-preset-lint-sider

0.8.2 verified Fri May 01 auth: no javascript

An opinionated remark-lint preset by Sider that focuses on possible errors or mistakes rather than stylistic issues. It provides a set of lint rules for Markdown files using remark-lint. The current stable version is 0.8.2, with no regular release cadence but triggered via GitHub Actions. It is designed for use with remark-cli and requires Node.js ^12.20.0 || ^14.13.1 || >=16.0.0. Unlike other presets that enforce style, this preset targets correctness and common pitfalls.

Common errors

error Error: Cannot find module 'remark-preset-lint-sider' ↓

cause Package not installed; or installed in devDependencies but not in dependencies.

fix

Run 'npm install --save-dev remark-preset-lint-sider' (devDependencies is typical).

error SyntaxError: Unexpected token 'export' ↓

cause Using require() in CommonJS environment; package is ESM-only.

fix

Use import syntax or set type: 'module' in package.json.

error Error: Unknown preset remark-preset-lint-sider ↓

cause Preset listed in .remarkrc but not installed.

fix

Install the preset via npm.

Warnings

gotcha The preset is opinionated and may flag rules that other presets ignore. Review rules before adoption. ↓

fix Check the list of rules in the source to understand what is enforced.

deprecated Node.js versions <12.20.0 are not supported. ↓

fix Upgrade Node.js to >=12.20.0 or use an older version of the package.

breaking Package is ESM-only since version 0.8.0; CommonJS require() will fail. ↓

fix Use import syntax or dynamic import().

gotcha The preset does not include any stylistic rules (e.g., line length, emphasis style). Use other presets for style. ↓

fix Combine with remark-preset-lint-consistent or similar for stylistic rules.

Install

npm install remark-preset-lint-sider

yarn add remark-preset-lint-sider

pnpm add remark-preset-lint-sider

Imports

preset

wrong

const preset = require('remark-preset-lint-sider')

correct

import * as preset from 'remark-preset-lint-sider'

The package is ESM-only. Use import or dynamic import; require() will fail.

default
```
import preset from 'remark-preset-lint-sider'
```
Default import is the preset configuration object.
remarkConfig
wrong
```
{
  "plugins": ["remark-lint-preset-sider"]
}
```
correct
```
{
  "plugins": ["remark-preset-lint-sider"]
}
```
In .remarkrc or package.json, use 'remark-preset-lint-sider' as a plugin key.

Quickstart

Install the preset and run linting on all Markdown files in the current directory.

npm install --save-dev remark-cli remark-preset-lint-sider
npx remark --use remark-preset-lint-sider .