Registry / testing / remark-preset-lint-itgalaxy

remark-preset-lint-itgalaxy

library16.0.0jsnpmunverified

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.

testing

npm install remark-preset-lint-itgalaxy

github ↗package ↗

INSTALL

IMPORT

SIG · REMARK-PRESET-LINT

remark-preset-lint-itgalaxy

testingjavascriptv16.0.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

remark-preset-lint-itgalaxy

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

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

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

remark-lint

✓ npm install remark-lint --save-dev

✗ npm install remark-lint --save

Should be a devDependency, not production dependency.

remark-cli

✓ npm install remark-cli --save-dev

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

Recommended to install locally to avoid version conflicts.

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 .

Debug

Known issues

breakingv12.0.0 removed all stylistic rules in favor of Prettier.

fix

Use Prettier for formatting; ensure Prettier is configured separately.

affects: >=12.0.0

breakingv13.0.0 dropped Node.js 4 support.

fix

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

affects: >=13.0.0

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

fix

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

affects: all

Errors

Common errors & fixes

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

Missing local installation of the preset.

fix

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

Error: No configuration provided for remark-lint

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

fix

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

Error: Missing peer dependency remark-lint

remark-lint is not installed alongside the preset.

fix

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

Upgrade

Version history

16.0.0latest on npm

Audit

Dependencies

remark-clirequiredRequired to run the preset via CLI.

remark-lintrequiredCore linting engine that powers the preset.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/itgalaxy/remark-lint-config-itgalaxy ↗

packagehttps://www.npmjs.com/package/remark-preset-lint-itgalaxy ↗