Registry / testing / remark-preset-lint-styleguide

remark-preset-lint-styleguide

JSON →
library1.0.0jsnpmunverified

remark preset to configure remark-lint with rules inspired by popular Markdown style guides, including Markdown Style Guide, Google documentation guide, and CommonMark specification. Current version: 1.0.0 (Node >=4). Integrates all official remark-lint rules and exposes multiple presets: default, writability, readability. Use with remark-cli or programmatically. Differentiators: opinionated but customizable, supports external rules and configuration comments, suited for maintaining portable Markdown.

testing
npm install remark-preset-lint-styleguide
github ↗package ↗
INSTALL
IMPORT
SIG · REMARK-PRESET-LINT
R
remark-preset-lint-styleguide
testingjavascriptv1.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.

default
✓ const styleguide = require('remark-preset-lint-styleguide')
✗ import styleguide from 'remark-preset-lint-styleguide'
Package is CJS-only; no ESM export.
writability preset
✓ const writability = require('remark-preset-lint-styleguide/writability')
✗ require('remark-preset-lint-styleguide/writability')
Prefix 'remark-preset-lint-styleguide/' required.
readability preset
✓ const readability = require('remark-preset-lint-styleguide/readability')
✗ require('remark-preset-lint-styleguide/readability')
Prefix required.

Programmatic usage: read a Markdown file, lint with default preset, and output formatted report.

const fs = require('fs'); const remark = require('remark'); const styleguide = require('remark-preset-lint-styleguide'); const report = require('vfile-reporter'); const myFile = fs.readFileSync('my-awesome-article.md', 'utf8'); let output = remark().use(styleguide).processSync(myFile); console.log(report(output));
remark --version
Debug
Known issues
gotchaPresets must be imported with full package name prefix (e.g., 'remark-preset-lint-styleguide/writability'). Omitting prefix leads to module not found.
fix
Use require('remark-preset-lint-styleguide/PRESET_NAME') instead of just 'PRESET_NAME'.
affects: >=1.0.0
gotchaPackage is CJS-only; does not provide ESM exports. Using 'import' will fail.
fix
Use require() instead of import.
affects: >=1.0.0
deprecatedNode.js >=4 required; older versions may cause runtime errors.
fix
Update Node.js to >=4 or ideally latest LTS.
affects: >=1.0.0
Errors
Common errors & fixes
Error: Cannot find module 'remark-preset-lint-styleguide/writability'
Missing package name prefix or incorrect path
fix
Use require('remark-preset-lint-styleguide/writability') (note the full package name).
SyntaxError: Unexpected identifier (when using import)
Package is CJS-only; import not supported
fix
Use require() instead of import.
Error: Configuration for 'remark-preset-lint-styleguide' not found
Plugin not installed or missing dependency
fix
Run 'npm install remark-preset-lint-styleguide' and ensure it's listed in remarkConfig.
Upgrade
Version history
1.0.0latest on npm
Audit
Dependencies
remark-lintrequiredcore lint engine for Markdown
remarkoptionalunified processor for Markdown, required for programmatic usage
Agent activity
4 hits · last 30 days
node
4
Resources
githubhttps://github.com/raduserbanescu/remark-preset-lint-styleguide ↗
packagehttps://www.npmjs.com/package/remark-preset-lint-styleguide ↗
remark-preset-lint-styleguide — npm install remark-preset-lint-styleguide · libregistry