commitlint-config

Shareable commitlint config enforcing conventional commits

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
• Types
  • Enums
  • Interfaces
  • Type Definitions
• Contribute

What is this?

This package exports a shareable commitlint configuration that enforces conventional commits.

It also includes a set of utilities for customizing rules.

When should I use this?

This package can be used with @commitlint/cli and @commitlint/prompt-cli.

Commit parsing options can also be used with conventional-changelog and conventional-commits-parser.

Install

yarn add -D @flex-development/commitlint-config @commitlint/cli

From Git:

yarn add -D @flex-development/commitlint-config@flex-development/commitlint-config @commitlint/cli

See Git - Protocols | Yarn  for details on requesting a specific branch, commit, or tag.

Use

TODO: usage example.

API

TODO: api documentation.

Types

This package is fully typed with TypeScript.

Enums

• PromptKind
• ReferenceAction
• Scope
• Type

Interfaces

• Commit
• Config
• Note
• ParserOptions
• PromptConfig
• Reference
• Revert
• RulesConfig

Type Definitions

• NoteKeyword
• ParserPreset
• QuestionEnum
• Question
• Questions

Contribute

See CONTRIBUTING.md.