{"id":26304,"library":"remark-preset-lint-styleguide","title":"remark-preset-lint-styleguide","description":"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.","status":"active","version":"1.0.0","language":"javascript","source_language":"en","source_url":"https://github.com/raduserbanescu/remark-preset-lint-styleguide","tags":["javascript","remark","preset","remark-lint","config","markdown","styleguide","lint"],"install":[{"cmd":"npm install remark-preset-lint-styleguide","lang":"bash","label":"npm"},{"cmd":"yarn add remark-preset-lint-styleguide","lang":"bash","label":"yarn"},{"cmd":"pnpm add remark-preset-lint-styleguide","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"core lint engine for Markdown","package":"remark-lint","optional":false},{"reason":"unified processor for Markdown, required for programmatic usage","package":"remark","optional":true}],"imports":[{"note":"Package is CJS-only; no ESM export.","wrong":"import styleguide from 'remark-preset-lint-styleguide'","symbol":"default","correct":"const styleguide = require('remark-preset-lint-styleguide')"},{"note":"Prefix 'remark-preset-lint-styleguide/' required.","wrong":"require('remark-preset-lint-styleguide/writability')","symbol":"writability preset","correct":"const writability = require('remark-preset-lint-styleguide/writability')"},{"note":"Prefix required.","wrong":"require('remark-preset-lint-styleguide/readability')","symbol":"readability preset","correct":"const readability = require('remark-preset-lint-styleguide/readability')"}],"quickstart":{"code":"const fs = require('fs');\nconst remark = require('remark');\nconst styleguide = require('remark-preset-lint-styleguide');\nconst report = require('vfile-reporter');\n\nconst myFile = fs.readFileSync('my-awesome-article.md', 'utf8');\nlet output = remark().use(styleguide).processSync(myFile);\nconsole.log(report(output));","lang":"javascript","description":"Programmatic usage: read a Markdown file, lint with default preset, and output formatted report."},"warnings":[{"fix":"Use require('remark-preset-lint-styleguide/PRESET_NAME') instead of just 'PRESET_NAME'.","message":"Presets must be imported with full package name prefix (e.g., 'remark-preset-lint-styleguide/writability'). Omitting prefix leads to module not found.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Use require() instead of import.","message":"Package is CJS-only; does not provide ESM exports. Using 'import' will fail.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Update Node.js to >=4 or ideally latest LTS.","message":"Node.js >=4 required; older versions may cause runtime errors.","severity":"deprecated","affected_versions":">=1.0.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Use require('remark-preset-lint-styleguide/writability') (note the full package name).","cause":"Missing package name prefix or incorrect path","error":"Error: Cannot find module 'remark-preset-lint-styleguide/writability'"},{"fix":"Use require() instead of import.","cause":"Package is CJS-only; import not supported","error":"SyntaxError: Unexpected identifier (when using import)"},{"fix":"Run 'npm install remark-preset-lint-styleguide' and ensure it's listed in remarkConfig.","cause":"Plugin not installed or missing dependency","error":"Error: Configuration for 'remark-preset-lint-styleguide' not found"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}