remark-preset-lint-itgalaxy

16.0.0 verified Fri May 01 auth: no javascript

Itgalaxy's sharable preset for remark-lint, providing a set of opinionated Markdown linting rules. Current stable version is 16.0.0, with releases on an as-needed cadence. Key differentiator: it pairs with Prettier for styling, focusing only on content correctness. It enforces rules like no trailing spaces, fenced code flag, and consistent heading style. Supports Node >= 12.13.0 and is widely used in the Itgalaxy ecosystem.

Common errors

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

cause Missing local installation of the preset.

fix

Run: npm install remark-preset-lint-itgalaxy --save-dev

error Error: No configuration provided for remark-lint ↓

cause remarkConfig not set in package.json or .remarkrc missing.

fix

Add "remarkConfig": { "plugins": ["remark-preset-lint-itgalaxy"] } to package.json

error Error: Missing peer dependency remark-lint ↓

cause remark-lint is not installed alongside the preset.

fix

Run: npm install remark-lint --save-dev

Warnings

breaking v12.0.0 removed all stylistic rules in favor of Prettier. ↓

fix Use Prettier for formatting; ensure Prettier is configured separately.

breaking v13.0.0 dropped Node.js 4 support. ↓

fix Upgrade Node.js to version 12 or later (current minimal requirement).

deprecated Use of --save (instead of --save-dev) for linting dependencies is deprecated practice. ↓

fix Use --save-dev to install as dev dependencies.

Install

npm install remark-preset-lint-itgalaxy

yarn add remark-preset-lint-itgalaxy

pnpm add remark-preset-lint-itgalaxy

Imports

remark-preset-lint-itgalaxy

wrong

Using require('remark-preset-lint-itgalaxy') in JavaScript code

correct

Add to package.json: "remarkConfig": { "plugins": ["remark-preset-lint-itgalaxy"] }

This is a preset for .remarkrc or package.json, not a programmatic API.

remark-lint
wrong
```
npm install remark-lint --save
```
correct
```
npm install remark-lint --save-dev
```
Should be a devDependency, not production dependency.

remark-cli

wrong

Using global install (npm install -g remark-cli) without local devDependency

correct

npm install remark-cli --save-dev

Recommended to install locally to avoid version conflicts.

Quickstart

Installs the preset and its peer dependencies, configures remarkConfig in package.json, and runs the linter on all files.

// 1. Install dependencies
npm install remark-cli remark-lint remark-preset-lint-itgalaxy --save-dev

// 2. Add to package.json
"remarkConfig": {
  "plugins": ["remark-preset-lint-itgalaxy"]
}

// 3. Run linter
npx remark .