{"id":26434,"library":"standard-readme-preset","title":"standard-readme-preset","description":"A remark preset to configure remark-lint with rules that enforce the standard-readme specification. Version 1.0.9 is the current stable release, with low release cadence. It includes custom rules for file extensions, required sections, section ordering, and heading validation. Differentiator: integrates directly with remark-lint to automatically check README compliance, reducing manual review effort. Dependencies: Node.js >=10. Install via npm and use CLI or API.","status":"active","version":"1.0.9","language":"javascript","source_language":"en","source_url":"https://github.com/RichardLitt/standard-readme-preset","tags":["javascript","remark","lint","preset","standard","readme"],"install":[{"cmd":"npm install standard-readme-preset","lang":"bash","label":"npm"},{"cmd":"yarn add standard-readme-preset","lang":"bash","label":"yarn"},{"cmd":"pnpm add standard-readme-preset","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"core linting engine","package":"remark","optional":false},{"reason":"linting rules framework","package":"remark-lint","optional":false}],"imports":[{"note":"Default export. CommonJS: require('standard-readme-preset').","wrong":"const { preset } = require('standard-readme-preset')","symbol":"default","correct":"import preset from 'standard-readme-preset'"},{"note":"Preset configures remark-lint under the hood; no direct rule imports needed.","symbol":"remark-lint rules","correct":"import { remark, lint } from 'remark'"},{"note":"Configuration for package.json or .remarkrc.","symbol":"remarkConfig","correct":"{\n  \"plugins\": [\"standard-readme-preset\"]\n}"}],"quickstart":{"code":"// Install: npm install standard-readme-preset remark-cli\n// CLI usage with default rules\nremark -u standard-readme-preset README.md\n\n// API usage\nconst remark = require('remark');\nconst preset = require('standard-readme-preset');\nconst vfile = require('to-vfile');\n\nremark()\n  .use(preset)\n  .process(vfile.readSync('README.md'), (err, file) => {\n    if (err) throw err;\n    console.log(String(file));\n  });","lang":"javascript","description":"Shows how to lint a README using the preset via CLI and API with CommonJS."},"warnings":[{"fix":"Ensure remark and remark-lint are in your dependencies.","message":"Preset requires remark-lint to be installed; not a standalone plugin.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Upgrade Node to version 10 or later.","message":"Deprecated support for Node <10.","severity":"breaking","affected_versions":">=1.0.0"},{"fix":"Switch to Renovate or manually update dependencies.","message":"Greenkeeper badge is obsolete; CI integration may be outdated.","severity":"deprecated","affected_versions":">=1.0.0"},{"fix":"Refer to https://github.com/RichardLitt/standard-readme-preset for rule specifics.","message":"Custom rules like file-extension and require-sections are not part of core remark-lint.","severity":"gotcha","affected_versions":">=0.0.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"npm install remark-lint","cause":"remark-lint is missing from node_modules.","error":"Cannot find module 'remark-lint'"},{"fix":"npm install standard-readme-preset","cause":"Preset not installed or incorrectly referenced.","error":"Error: Cannot find preset 'standard-readme-preset'"},{"fix":"Use default import: import preset from 'standard-readme-preset' or CommonJS require.","cause":"Using an ESM import without default export handling in older remark versions.","error":"TypeError: preset is not a function"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}