Conventional Changelog Lint Canonical Config

1.0.0 verified Fri May 01 auth: no javascript

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.

Common errors

error Cannot find module 'conventional-changelog-lint-config-canonical' ↓

cause Package not installed or missing peer dependency conventional-changelog-lint.

fix

Install both conventional-changelog-lint and conventional-changelog-lint-config-canonical.

error Invalid config: extends must be an array of strings ↓

cause Extends property is not an array or contains invalid values.

fix

Set extends to an array, e.g., ["canonical"].

error Please note that conventional-changelog-lint is deprecated ↓

cause Using deprecated tool; maintainers suggest commitlint.

fix

Consider migrating to @commitlint/cli and @commitlint/config-conventional.

Warnings

gotcha The config must be referenced by short name 'canonical' not the full package name. ↓

fix Use 'canonical' in extends array.

deprecated conventional-changelog-lint itself is deprecated in favor of commitlint. ↓

fix Migrate to @commitlint/config-conventional or similar.

gotcha conventional-changelog-lint is a peer dependency and must be installed separately. ↓

fix Run npm install conventional-changelog-lint --save-dev.

gotcha Older Node.js versions may not be supported; ensure Node >= 10. ↓

fix Use Node.js 10 or higher.

Install

npm install conventional-changelog-lint-config-canonical

yarn add conventional-changelog-lint-config-canonical

pnpm add conventional-changelog-lint-config-canonical

Imports

config object

wrong

import config from 'conventional-changelog-lint-config-canonical'

correct

extends: ['canonical'] in .conventional-changelog-lintrc JSON

Not imported directly; used via extends in config file.

conventional-changelog-lint

wrong

npm install --save conventional-changelog-lint-config-canonical

correct

npm install --save-dev conventional-changelog-lint conventional-changelog-lint-config-canonical

conventional-changelog-lint must be installed as it is a peer dependency.

.conventional-changelog-lintrc
wrong
```
{
  "extends": ["conventional-changelog-lint-config-canonical"]
}
```
correct
```
{
  "extends": ["canonical"]
}
```
Only the short name 'canonical' is used for extends, not the full package name.

Quickstart

Installs the config and the linter, creates a minimal config file, and runs the linter against sample commits.

npm install --save-dev conventional-changelog-lint conventional-changelog-lint-config-canonical
echo '{
  "extends": ["canonical"]
}' > .conventional-changelog-lintrc
echo 'feat: add new feature
fix: correct a bug' | npx conventional-changelog-lint