@commitlint/config-conventional
- Version 19.5.0
- Published
- 18.5 kB
- 2 dependencies
- MIT license
Install
npm i @commitlint/config-conventional
yarn add @commitlint/config-conventional
pnpm add @commitlint/config-conventional
Overview
Shareable commitlint config enforcing conventional commits
Index
Variables
Variables
variable _default
const _default: { parserPreset: string; rules: { 'body-leading-blank': readonly [RuleConfigSeverity.Warning, 'always']; 'body-max-line-length': readonly [RuleConfigSeverity.Error, 'always', 100]; 'footer-leading-blank': readonly [RuleConfigSeverity.Warning, 'always']; 'footer-max-line-length': readonly [RuleConfigSeverity.Error, 'always', 100]; 'header-max-length': readonly [RuleConfigSeverity.Error, 'always', 100]; 'header-trim': readonly [RuleConfigSeverity.Error, 'always']; 'subject-case': [RuleConfigSeverity, RuleConfigCondition, TargetCaseType[]]; 'subject-empty': readonly [RuleConfigSeverity.Error, 'never']; 'subject-full-stop': readonly [RuleConfigSeverity.Error, 'never', '.']; 'type-case': readonly [RuleConfigSeverity.Error, 'always', 'lower-case']; 'type-empty': readonly [RuleConfigSeverity.Error, 'never']; 'type-enum': [RuleConfigSeverity, RuleConfigCondition, string[]]; }; prompt: { questions: { type: { description: string; enum: { feat: { description: string; title: string; emoji: string }; fix: { description: string; title: string; emoji: string }; docs: { description: string; title: string; emoji: string }; style: { description: string; title: string; emoji: string }; refactor: { description: string; title: string; emoji: string }; perf: { description: string; title: string; emoji: string }; test: { description: string; title: string; emoji: string }; build: { description: string; title: string; emoji: string }; ci: { description: string; title: string; emoji: string }; chore: { description: string; title: string; emoji: string }; revert: { description: string; title: string; emoji: string }; }; }; scope: { description: string }; subject: { description: string }; body: { description: string }; isBreaking: { description: string }; breakingBody: { description: string }; breaking: { description: string }; isIssueAffected: { description: string }; issuesBody: { description: string }; issues: { description: string }; }; };};
Package Files (1)
Dependencies (2)
Dev Dependencies (2)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@commitlint/config-conventional
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@commitlint/config-conventional)
- HTML<a href="https://www.jsdocs.io/package/@commitlint/config-conventional"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3330 ms. - Missing or incorrect documentation? Open an issue for this package.