Registry / devops / conventional-changelog-lint-config-canonical

conventional-changelog-lint-config-canonical

library1.0.0jsnpmunverified

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.

devops

npm install conventional-changelog-lint-config-canonical

github ↗package ↗

INSTALL

IMPORT

SIG · CONVENTIONAL-CHANG

conventional-changelog-lint-config-canonical

devopsjavascriptv1.0.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

config object

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

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

Not imported directly; used via extends in config file.

conventional-changelog-lint

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

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

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

.conventional-changelog-lintrc

✓ { "extends": ["canonical"] }

✗ { "extends": ["conventional-changelog-lint-config-canonical"] }

Only the short name 'canonical' is used for extends, not the full package name.

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

Debug

Known issues

gotchaThe config must be referenced by short name 'canonical' not the full package name.

fix

Use 'canonical' in extends array.

affects: >=1.0.0

deprecatedconventional-changelog-lint itself is deprecated in favor of commitlint.

fix

Migrate to @commitlint/config-conventional or similar.

affects: >=1.0.0

gotchaconventional-changelog-lint is a peer dependency and must be installed separately.

fix

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

affects: >=1.0.0

gotchaOlder Node.js versions may not be supported; ensure Node >= 10.

fix

Use Node.js 10 or higher.

affects: >=1.0.0

Errors

Common errors & fixes

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

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

fix

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

Invalid config: extends must be an array of strings

Extends property is not an array or contains invalid values.

fix

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

Please note that conventional-changelog-lint is deprecated

Using deprecated tool; maintainers suggest commitlint.

fix

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

Upgrade

Version history

1.0.0latest on npm

Audit

Dependencies

conventional-changelog-lintrequiredpeer dependency required for linting functionality

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/gajus/conventional-changelog-lint-config-canonical ↗

packagehttps://www.npmjs.com/package/conventional-changelog-lint-config-canonical ↗