{"id":25124,"library":"conventional-changelog-lint-config-canonical","title":"Conventional Changelog Lint Canonical Config","description":"This package provides a shareable configuration for conventional-changelog-lint enforcing the Canonical commit convention. Version 1.0.0 is stable with no known recent updates. It is used as an extension in .conventional-changelog-lintrc to validate commit messages according to Canonical rules. Differs from other configs like angular or atom by specific Canonical conventions.","status":"active","version":"1.0.0","language":"javascript","source_language":"en","source_url":"https://github.com/gajus/conventional-changelog-lint-config-canonical","tags":["javascript","canonical","conventional-changelog","changelog","commit","config","lint"],"install":[{"cmd":"npm install conventional-changelog-lint-config-canonical","lang":"bash","label":"npm"},{"cmd":"yarn add conventional-changelog-lint-config-canonical","lang":"bash","label":"yarn"},{"cmd":"pnpm add conventional-changelog-lint-config-canonical","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"peer dependency required for linting functionality","package":"conventional-changelog-lint","optional":false}],"imports":[{"note":"Not imported directly; used via extends in config file.","wrong":"import config from 'conventional-changelog-lint-config-canonical'","symbol":"config object","correct":"extends: ['canonical'] in .conventional-changelog-lintrc JSON"},{"note":"conventional-changelog-lint must be installed as it is a peer dependency.","wrong":"npm install --save conventional-changelog-lint-config-canonical","symbol":"conventional-changelog-lint","correct":"npm install --save-dev conventional-changelog-lint conventional-changelog-lint-config-canonical"},{"note":"Only the short name 'canonical' is used for extends, not the full package name.","wrong":"{\n  \"extends\": [\"conventional-changelog-lint-config-canonical\"]\n}","symbol":".conventional-changelog-lintrc","correct":"{\n  \"extends\": [\"canonical\"]\n}"}],"quickstart":{"code":"npm install --save-dev conventional-changelog-lint conventional-changelog-lint-config-canonical\necho '{\n  \"extends\": [\"canonical\"]\n}' > .conventional-changelog-lintrc\necho 'feat: add new feature\nfix: correct a bug' | npx conventional-changelog-lint","lang":"javascript","description":"Installs the config and the linter, creates a minimal config file, and runs the linter against sample commits."},"warnings":[{"fix":"Use 'canonical' in extends array.","message":"The config must be referenced by short name 'canonical' not the full package name.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Migrate to @commitlint/config-conventional or similar.","message":"conventional-changelog-lint itself is deprecated in favor of commitlint.","severity":"deprecated","affected_versions":">=1.0.0"},{"fix":"Run npm install conventional-changelog-lint --save-dev.","message":"conventional-changelog-lint is a peer dependency and must be installed separately.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Use Node.js 10 or higher.","message":"Older Node.js versions may not be supported; ensure Node >= 10.","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":"Install both conventional-changelog-lint and conventional-changelog-lint-config-canonical.","cause":"Package not installed or missing peer dependency conventional-changelog-lint.","error":"Cannot find module 'conventional-changelog-lint-config-canonical'"},{"fix":"Set extends to an array, e.g., [\"canonical\"].","cause":"Extends property is not an array or contains invalid values.","error":"Invalid config: extends must be an array of strings"},{"fix":"Consider migrating to @commitlint/cli and @commitlint/config-conventional.","cause":"Using deprecated tool; maintainers suggest commitlint.","error":"Please note that conventional-changelog-lint is deprecated"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}