commitlint (.commitlintrc)
commitlint configuration files
| Type | object |
|---|---|
| File match |
.commitlintrc
.commitlintrc.json
.commitlintrc.yaml
.commitlintrc.yml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/commitlint-commitlintrc/latest.json |
| Source | https://www.schemastore.org/commitlintrc.json |
Validate with Lintel
npx @lintel/lintel check
Type:
object
Properties
extends
string[] | string
Resolvable ids to commitlint configurations to extend
parserPreset
string | object
Resolvable id to conventional-changelog parser preset to import and use
helpUrl
string
Custom URL to show upon failure
formatter
string
Resolvable id to package, from node_modules, which formats the output
rules
Record<string, array>
Rules to check against
plugins
string[]
Resolvable ids of commitlint plugins from node_modules
ignores
array
Additional commits to ignore, defined by ignore matchers
defaultIgnores
boolean
Whether commitlint uses the default ignore rules
Definitions
rule
array