Registry / devops / semantic-release-commits-lint

semantic-release-commits-lint

JSON →
library1.1.0jsnpmunverified

semantic-release plugin that analyzes commit messages using commitlint. Works with semantic-release >=20 and commitlint configurations. Provides analyzeCommits step. Version 1.1.0 adds support for commitlintFile and commitlintConfig options. Requires Node >=18 and peer dependencies jest, semantic-release, and xo. Alternative to built-in commit message analysis with custom commitlint rules.

npm install semantic-release-commits-lint
INSTALL
IMPORT
SIG · SEMANTIC-RELEASE-C
S
semantic-release-commits-lint
devopsjavascriptv1.1.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.

default
plugins: ['semantic-release-commits-lint']
require('semantic-release-commits-lint')
Used as a semantic-release plugin in .releaserc or release.config.js, not imported directly in code.
analyzeCommits
// Not exported; plugin provides step internally
import { analyzeCommits } from 'semantic-release-commits-lint'
analyzeCommits is not a public export; it is registered automatically when using the plugin string.
options
["semantic-release-commits-lint", { commitlintFile: ".commitlintrc.json" }]
["semantic-release-commits-lint", { commitlintConfig: { extends: [] } }]
commitlintConfig allows inline config, avoid mixing both options.

Example of configuring the plugin in semantic-release without additional options.

// .releaserc { "plugins": [ "semantic-release-commits-lint" ] }
Debug
Known issues
gotchaPlugin requires commitlint configuration to be present; otherwise, it may silently pass.
fix
Ensure commitlint config file exists or pass commitlintConfig option.
affects: >=1.0.0
deprecatedDeprecated: peer dependency xo may not be maintained.
fix
Check xo repository for alternative or compatibility.
affects: >=1.0.0
breakingPlugin only supports Node >=18. Older Node versions cause runtime errors.
fix
Upgrade Node to v18 or later.
affects: >=1.0.0
Errors
Common errors & fixes
Error: Cannot find module 'semantic-release-commits-lint'
Plugin not installed or not in node_modules.
fix
Run npm install semantic-release-commits-lint --save-dev
TypeError: Cannot read properties of undefined (reading 'analyzeCommits')
Using import or require incorrectly.
fix
Use string in plugins array, not imported symbol.
Upgrade
Version history
1.1.0latest on npm
Audit
Dependencies
jestrequiredpeer dependency required by plugin
semantic-releaserequiredpeer dependency, plugin requires semantic-release >=20
xorequiredpeer dependency required by plugin
Agent activity
2 hits · last 30 days
node
2
Resources
semantic-release-commits-lint — npm install semantic-release-commits-lint · libregistry