Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/flex-development/commitlint-config

Shareable commitlint config enforcing conventional commit
https://github.com/flex-development/commitlint-config
cjs commitlint commitlint-config conventional-changelog conventional-commits-parser esm hybrid typescript
Last synced: 5 days ago
JSON representation
Shareable commitlint config enforcing conventional commit
Host: GitHub
URL: https://github.com/flex-development/commitlint-config
Owner: flex-development
License: bsd-3-clause
Created: 2023-02-22T00:22:53.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-06-13T04:32:29.000Z (5 months ago)
Last Synced: 2024-09-27T05:10:33.271Z (about 2 months ago)
Topics: cjs, commitlint, commitlint-config, conventional-changelog, conventional-commits-parser, esm, hybrid, typescript
Language: TypeScript
Homepage: https://github.com/flex-development/commitlint-config
Size: 1.37 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 11
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/funding.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project

README

        # commitlint-config

[![github release](https://img.shields.io/github/v/release/flex-development/commitlint-config.svg?include_prereleases&sort=semver)](https://github.com/flex-development/commitlint-config/releases/latest)

[![npm](https://img.shields.io/npm/v/@flex-development/commitlint-config.svg)](https://npmjs.com/package/@flex-development/commitlint-config)

[![codecov](https://codecov.io/gh/flex-development/commitlint-config/branch/main/graph/badge.svg?token=hJhCIS5UIM)](https://codecov.io/gh/flex-development/commitlint-config)

[![module type: cjs+esm](https://img.shields.io/badge/module%20type-cjs%2Besm-brightgreen)](https://github.com/voxpelli/badges-cjs-esm)

[![license](https://img.shields.io/github/license/flex-development/commitlint-config.svg)](LICENSE.md)

[![conventional commits](https://img.shields.io/badge/-conventional%20commits-fe5196?logo=conventional-commits&logoColor=ffffff)](https://conventionalcommits.org/)

[![typescript](https://img.shields.io/badge/-typescript-3178c6?logo=typescript&logoColor=ffffff)](https://typescriptlang.org/)

[![vitest](https://img.shields.io/badge/-vitest-6e9f18?style=flat&logo=vitest&logoColor=ffffff)](https://vitest.dev/)

[![yarn](https://img.shields.io/badge/-yarn-2c8ebb?style=flat&logo=yarn&logoColor=ffffff)](https://yarnpkg.com/)

Shareable [`commitlint`][1] config enforcing [conventional commits][2]

## Contents

- [What is this?](#what-is-this)

- [When should I use this?](#when-should-i-use-this)

- [Install](#install)

- [Use](#use)

  - [Customizing scopes and types](#customizing-scopes-and-types)

- [Rules](#rules)

  - [Problems](#problems)

    - [`body-full-stop`](#body-full-stop)

    - [`body-leading-blank`](#body-leading-blank)

    - [`body-max-length`](#body-max-length)

    - [`body-max-line-length`](#body-max-line-length)

    - [`footer-leading-blank`](#footer-leading-blank)

    - [`footer-max-length`](#footer-max-length)

    - [`footer-max-line-length`](#footer-max-line-length)

    - [`header-full-stop`](#header-full-stop)

    - [`header-max-length`](#header-max-length)

    - [`scope-case`](#scope-case)

    - [`scope-enum`](#scope-enum)

    - [`scope-max-length`](#scope-max-length)

    - [`scope-min-length`](#scope-min-length)

    - [`subject-empty`](#subject-empty)

    - [`subject-full-stop`](#subject-full-stop)

    - [`subject-min-length`](#subject-min-length)

    - [`trailer-exists`](#trailer-exists)

    - [`type-case`](#type-case)

    - [`type-empty`](#type-empty)

    - [`type-enum`](#type-enum)

    - [`type-max-length`](#type-max-length)

    - [`type-min-length`](#type-min-length)

- [API](#api)

  - [`config`](#config)

  - `defaultIgnores`

  - `formatter`

  - `helpUrl`

  - `ignores`

  - [`max(array)`](#maxarray)

  - [`min(array)`](#minarray)

  - `parserPreset`

  - `plugins`

  - `prompt`

  - `rules`

  - [`scopes([extras])`](#scopesextras)

  - [`types([extras])`](#typesextras)

- [Types](#types)

  - [Enums](#enums)

  - [Interfaces](#interfaces)

  - [Type Definitions](#type-definitions)

- [Contribute](#contribute)

## What is this?

This package exports a shareable [`commitlint`][1] configuration that enforces [conventional commits][2].

It also includes a set of utilities for customizing rules.

## When should I use this?

This package can be used with [`@commitlint/cli`][3] and [`@commitlint/prompt-cli`][4].

Commit parsing options can also be used with [`conventional-changelog`][5] and [`conventional-commits-parser`][6].

## Install

```sh

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

```

From Git:

```sh

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

```sh

echo '{\n  "extends": "@flex-development"\n}' > .commitlintrc.json

commitlint --from HEAD~1 --to HEAD --verbose

```

### Customizing scopes and types

Due to [an unresolved `commitlint` issue][7], extended `commitlint` configurations do not concatenate [`scope-enum`][8],

nor [`type-enum`][9]. Follow the example below to customize commit scopes and types losslessly.

```sh

touch .commitlintrc.cts

```

```ts

/**

 * @file Configuration - commitlint

 * @module config/commitlint

 * @see https://commitlint.js.org

 */

import {

  RuleConfigSeverity as Severity,

  type UserConfig

} from '@commitlint/types'

import { scopes } from '@flex-development/commitlint-config'

/**

 * `commitlint` configuration object.

 *

 * @const {UserConfig} config

 */

const config: UserConfig = {

  extends: ['@flex-development'],

  rules: {

    'scope-enum': [Severity.Error, 'always', scopes(['bundle', 'transpile'])]

  }

}

export default config

```

You may need to set [`TS_NODE_PROJECT`][10] if running `commitlint` from the command line.

See [`docs/examples/commitlint.config.cjs`](docs/examples/commitlint.config.cjs) for an example config written in pure CommonJS.

## Rules

Rules **not** documented below are disabled by default. Consult the [rules reference][11] for a list of all rules.

### Problems

The following rules are considered problems for `@flex-development/commitlint-config` and will yield a non-zero exit

code when not met.

#### `body-full-stop`

- **condition**: `body` ends with `value`

- **rule**: `never`

- **value**:

  ```ts

  '.'

  ```

#### `body-leading-blank`

- **condition**: `body` begins with blank line

- **rule**: `always`

#### `body-max-length`

- **condition**: `body` has `value` or less characters

- **rule**: `always`

- **value**:

  ```ts

  Number.MAX_SAFE_INTEGER

  ```

#### `body-max-line-length`

- **condition**: `body` lines has `value` or less characters

- **rule**: `always`

- **value**:

  ```ts

  2050

  ```

#### `footer-leading-blank`

- **condition**: `footer` begins with blank line

- **rule**: `always`

#### `footer-max-length`

- **condition**: `footer` has `value` or less characters

- **rule**: `always`

- **value**:

  ```ts

  Number.MAX_SAFE_INTEGER

  ```

#### `footer-max-line-length`

- **condition**: `footer` lines has `value` or less characters

- **rule**: `always`

- **value**:

  ```ts

  2050

  ```

#### `header-full-stop`

- **condition**: `header` ends with `value`

- **rule**: `never`

- **value**:

  ```ts

  '.'

  ```

#### `header-max-length`

- **condition**: `header` has `value` or less characters

- **rule**: `always`

- **value**:

  ```ts

  100

  ```

#### `scope-case`

- **condition**: `scope` is in case that is in `value`

- **rule**: `always`

- **value**:

  ```ts

  ['kebab-case', 'lower-case']

  ```

#### `scope-enum`

- **condition**: `scope` is found in `value`

- **rule**: `always`

- **value**:

  ```ts

  scopes()

  ```

#### `scope-max-length`

- **condition**: `scope` has `value` or less characters

- **rule**: `always`

- **value**:

  ```ts

  max(scopes())

  ```

#### `scope-min-length`

- **condition**: `scope` has `value` or more characters

- **rule**: `always`

- **value**:

  ```ts

  min(scopes())

  ```

#### `subject-empty`

- **condition**: `subject` is empty

- **rule**: `never`

#### `subject-full-stop`

- **condition**: `subject` ends with `value`

- **rule**: `never`

- **value**:

  ```ts

  '.'

  ```

#### `subject-min-length`

- **condition**: `subject` has `value` or more characters

- **rule**: `always`

- **value**:

  ```ts

  2

  ```

#### `trailer-exists`

- **condition**: `message` has trailer `value`

- **rule**: `always`

- **value**:

  ```ts

  'Signed-off-by:'

  ```

#### `type-case`

- **description**: `type` is in case `value`

- **rule**: `always`

- **value**:

  ```ts

  'lower-case'

  ```

#### `type-empty`

- **condition**: `type` is empty

- **rule**: `never`

#### `type-enum`

- **condition**: `type` is found in `value`

- **rule**: `always`

- **value**:

  ```ts

  types()

  ```

#### `type-max-length`

- **condition**: `type` has `value` or less characters

- **rule**: `always`

- **value**:

  ```ts

  max(types)

  ```

#### `type-min-length`

- **condition**: `type` has `value` or more characters

- **rule**: `always`

- **value**:

  ```ts

  min(types())

  ```

## API

This package exports the following identifiers:

- [`config`](#config)

- `defaultIgnores`

- `formatter`

- `helpUrl`

- `ignores`

- [`max`](#maxarray)

- [`min`](#minarray)

- `parserPreset`

- `plugins`

- `prompt`

- `rules`

- [`scopes`](#scopesextras)

- [`types`](#typesextras)

The default export is `config`.

### `config`

`commitlint` configuration object.

Properties:

- `defaultIgnores`

- `formatter`

- `helpUrl`

- `ignores`

- `parserPreset`

- `plugins`

- `prompt`

- `rules`

See the [configuration reference][12] for more details.

### Utilities

#### `max(array)`

Returns the length of the longest string in the given `array`.

##### Parameters

- `{string[]}` **`array`** — Array to evaluate

##### Returns

`{number}` Length of longest string in `array`.

##### Source

> [`src/utils/max.ts`](src/utils/max.ts)

#### `min(array)`

Returns the length of the shortest string in the given `array`.

##### Parameters

- `{string[]}` **`array`** — Array to evaluate

##### Returns

`{number}` Length of shortest string in `array`.

##### Source

> [`src/utils/min.ts`](src/utils/min.ts)

#### `scopes([extras])`

Returns an array containing valid commit scopes.

##### Parameters

- `{(Set | string[])?}` **`[extras=[]]`** — Additional commit scopes

##### Returns

`{LiteralUnion[]}` Commit scopes array.

##### Source

> [`src/utils/scopes.ts`](src/utils/scopes.ts)

#### `types([extras])`

Returns an array containing valid commit types.

##### Parameters

- `{(Set | string[])?}` **`[extras=[]]`** — Additional commit types

##### Returns

`{LiteralUnion[]}` Commit types array.

##### Source

> [`src/utils/types.ts`](src/utils/types.ts)

## Types

This package is fully typed with [TypeScript][13].

### Enums

- [`PromptKind`](src/enums/kind-prompt.ts)

- [`ReferenceAction`](src/enums/reference-action.ts)

- [`Scope`](src/enums/scope.ts)

- [`Type`](src/enums/type.ts)

### Interfaces

- [`Commit`](src/interfaces/commit.ts)

- [`Config`](src/interfaces/config.ts)

- [`Note`](src/interfaces/note.ts)

- [`ParserOptions`](src/interfaces/options-parser.ts)

- [`PromptConfig`](src/interfaces/config-prompt.ts)

- [`Reference`](src/interfaces/reference.ts)

- [`Revert`](src/interfaces/revert.ts)

- [`RulesConfig`](src/interfaces/config-rules.ts)

### Type Definitions

- [`NoteKeyword`](src/types/note-keyword.ts)

- [`ParserPreset`](src/types/parser-preset.ts)

- [`QuestionEnum`](src/types/question-enum.ts)

- [`Question`](src/types/question.ts)

- [`Questions`](src/types/questions.ts)

## Contribute

See [`CONTRIBUTING.md`](CONTRIBUTING.md).

[1]: https://commitlint.js.org/

[2]: https://conventionalcommits.org/

[3]: https://commitlint.js.org/#/reference-cli

[4]: https://commitlint.js.org/#/guides-use-prompt

[5]: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog

[6]: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser

[7]: https://github.com/conventional-changelog/commitlint/issues/528

[8]: https://commitlint.js.org/#/reference-rules?id=scope-enum

[9]: https://commitlint.js.org/#/reference-rules?id=type-enum

[10]: https://typestrong.org/ts-node/docs/options#project

[11]: https://commitlint.js.org/#/reference-rules

[12]: https://commitlint.js.org/#/reference-configuration

[13]: https://www.typescriptlang.org