cz-conventional-changelog-lint

0.1.3 verified Fri May 01 auth: no javascript maintenance

Commitizen adapter that reads your conventional-changelog-lint configuration and generates interactive commit message prompts matching your lint rules. Version 0.1.3 is the latest, though the package appears to be in maintenance mode with no recent updates. It bridges commitizen and conventional-changelog-lint, ensuring commit format compliance without manual configuration. Differentiators include automatic rule-based prompt generation and integration with the conventional-changelog-lint ecosystem.

Common errors

error Error: Cannot find module 'cz-conventional-changelog-lint' ↓

cause Missing adapter installation or incorrect path in config.

fix

Install the package: npm install --save cz-conventional-changelog-lint, and ensure path in config points to the correct location.

error Module not found: Can't resolve 'commitizen' ↓

cause commitizen not installed or not in node_modules.

fix

Install commitizen: npm install --save-dev commitizen

Warnings

gotcha The package requires both commitizen and conventional-changelog-lint as peer dependencies. Failure to install them will cause runtime errors. ↓

fix Ensure both peer dependencies are installed: npm install --save commitizen conventional-changelog-lint

deprecated The package has not been updated since 2017 and may not work with newer versions of commitizen or conventional-changelog-lint. ↓

fix Consider using cz-conventional-changelog (with conventional commits) or cz-customizable for more up-to-date alternatives.

Install

npm install cz-conventional-changelog-lint

yarn add cz-conventional-changelog-lint

pnpm add cz-conventional-changelog-lint

Imports

cz-conventional-changelog-lint

wrong

Using require('cz-conventional-changelog-lint') or import in code

correct

Configure in package.json: "config": { "commitizen": { "path": "./node_modules/cz-conventional-changelog-lint" } }

This package is a commitizen adapter, not a library to import directly. It is loaded by commitizen via the path config.

git-cz
wrong
```
Running cz command without commitizen installed
```
correct
```
npx git-cz or install commitizen globally and run git-cz
```
The CLI is provided by commitizen, not by this package. This package only provides the adapter.

Quickstart

Install the adapter and its peer dependencies, configure commitizen, then use git-cz to create commit messages.

npm install --save cz-conventional-changelog-lint commitizen conventional-changelog-lint
# Then add to package.json:
# { "config": { "commitizen": { "path": "./node_modules/cz-conventional-changelog-lint" } } }
git add .
npx git-cz