{"id":26191,"library":"remark-changelog","title":"remark-changelog","description":"Lint or fix a changelog written in Markdown following Keep a Changelog conventions. Version 1.2.1, maintained by vweevers. Integrates with remark and provides both linting and automatic fixing for headings, version links, dates, ordering, and release content. Supports Unreleased sections, semver versions, GitHub compare links, and commit log insertion. Differentiated by its fix mode and strict adherence to Keep a Changelog.","status":"active","version":"1.2.1","language":"javascript","source_language":"en","source_url":"https://github.com/vweevers/remark-changelog","tags":["javascript","changelog","keep-a-changelog","remark"],"install":[{"cmd":"npm install remark-changelog","lang":"bash","label":"npm"},{"cmd":"yarn add remark-changelog","lang":"bash","label":"yarn"},{"cmd":"pnpm add remark-changelog","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Peer dependency; this is a remark plugin.","package":"remark","optional":false}],"imports":[{"note":"Default export is the plugin function.","wrong":"import { changelog } from 'remark-changelog'","symbol":"default","correct":"import changelog from 'remark-changelog'"},{"note":"CommonJS require works in Node <10 and CJS projects.","symbol":"require('remark-changelog')","correct":"const changelog = require('remark-changelog')"},{"note":"Options can be passed but are not required.","wrong":"remark().use(changelog, options)","symbol":"remark().use(changelog)","correct":"remark().use(changelog)"}],"quickstart":{"code":"const remark = require('remark');\nconst changelog = require('remark-changelog');\nconst fs = require('fs');\n\nconst content = fs.readFileSync('CHANGELOG.md', 'utf8');\n\nremark()\n  .use(changelog, { lint: true })\n  .process(content, (err, file) => {\n    if (err) throw err;\n    console.log(file.messages);\n  });","lang":"javascript","description":"Lint a changelog file using remark-changelog plugin with default options."},"warnings":[{"fix":"Use remarkable or update to remark 12.","message":"Version 1.x uses remark 12; not compatible with remark 13+.","severity":"breaking","affected_versions":">=1.0.0 <2.0.0"},{"fix":"Use CommonJS or transpile; no ESM exports.","message":"Requires Node >=10; does not support ESM natively.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Review changes before committing; use version control.","message":"Fix mode may reorder releases and changelog entries, potentially causing git conflicts.","severity":"gotcha","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":"Run 'npm install remark-changelog' and check require/import path.","cause":"Missing npm install or incorrect import path.","error":"Cannot find module 'remark-changelog'"},{"fix":"Ensure remark v12 is installed: 'npm install remark@12'.","cause":"Using wrong version of remark (v13+ exports differently).","error":"TypeError: remark is not a function"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}