# @arrai-innovations/commitlint-config

> Arrai Innovation's shareable configuration for commitlint.

Latest version **3.0.0** (published 2026-08-05) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install @arrai-innovations/commitlint-config
pnpm add @arrai-innovations/commitlint-config
yarn add @arrai-innovations/commitlint-config
bun add @arrai-innovations/commitlint-config
```

## Health

**Score 50/100 (C)** — status: active.

Positive: no vulnerabilities; recently updated.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2026-08-05 |
| First published | 2021-02-01 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Arrai Innovations Inc. |
| Maintainers | arrai-developers |

## Links

- npm: https://www.npmjs.com/package/@arrai-innovations/commitlint-config
- Repository: https://github.com/arrai-innovations/commitlint-config
- Homepage: https://github.com/arrai-innovations/commitlint-config#readme
- Issues: https://github.com/arrai-innovations/commitlint-config/issues
- npm.io page: https://npm.io/package/@arrai-innovations/commitlint-config

## Recent versions

- 3.0.0 (latest) — 2026-08-05
- 2.1.0 — 2025-05-23
- 2.0.0 — 2025-03-14
- 1.1.0 — 2021-03-03
- 1.0.0 — 2021-02-01

## README

# commitlint-config

Arrai Innovation's shareable configuration for [commitlint](https://commitlint.js.org).

- [Requirements](#requirements)
- [Use with pre-commit](#use-with-pre-commit)
- [Use with Husky](#use-with-husky)

## Requirements

- Node.js 22.12.0 or newer, the floor set by `@commitlint/config-conventional` 21.
- commitlint 21 (`@commitlint/cli@^21`). Commitlint 19 and 20 also load this configuration, but both depend on the
  deprecated `git-raw-commits` package.

## Use with pre-commit

1. Install pre-commit: https://pre-commit.com

1. Install the `commit-msg` hook type:

   ```console
   $ pre-commit install --hook-type commit-msg
   pre-commit installed at .git/hooks/commit-msg
   ```

1. Create a `.pre-commit-config.yaml` file at the root of your repo:

   ```yaml
   default_stages: [commit]
   fail_fast: true
   
   repos:
       - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
         rev: v4.1.0
         hooks:
           - id: commitlint
             stages: [ commit-msg ]
             additional_dependencies: [ "@arrai-innovations/commitlint-config" ]
   ```

   It contains a pre-commit hook for commitlint using [commitlint-pre-commit-hook](https://github.com/alessandrojcm/commitlint-pre-commit-hook) with this repo's configuration as a dependency.

1. Add a `.commitlintrc.json` or other commitlint configuration file (see [Install commitlint](https://commitlint.js.org/#/guides-local-setup?id=install-commitlint)) to the root of your repo:

   ```json
   {
       "extends": ["@arrai-innovations/commitlint-config"]
   }
   ```

## Use with Husky

1. Install Husky: https://typicode.github.io/husky/

   ```console
   $ npm install --save-dev "husky@^5"
   ```

1. Install commitlint/cli: https://www.npmjs.com/package/@commitlint/cli

   ```console
   $ npm install --save-dev @commitlint/cli
   ```

1. Create a `.husky/commit-msg` file at the root of your repo to run commitlint:

   ```bash
   #!/usr/bin/env bash
   npx --no-install commitlint --edit "$1"
   ```
   
   Husky changed formats in version 5. Version 4 Husky used to have it's hooks configured in `package.json`.

1. Add scripts to `package.json` to install Husky hooks when a user runs `npm install` while developing our package:

   ```console
   $ npm install --save-dev is-ci pinst
   ```

   ```json
   {
      ...
      "scripts": {
         ...,
         "postinstall": "is-ci || husky install",
         "prepublishOnly": "pinst --disable",
         "postpublish": "pinst --enable"
      },
      ...
   }
   ```
   
   The `is-ci` module helps us not install hooks uselessly on ci builds. The `pisnt` module helps us not install hooks when users install this package as a dependency.

1. Install this repo's configuration:

   ```console
   $ npm install --save-dev @arrai-innovations/commitlint-config
   ```

1. Add a `.commitlintrc.json` or other commitlint configuration file (see [Install commitlint](https://commitlint.js.org/#/guides-local-setup?id=install-commitlint)) to the root of your repo:

   ```json
   {
       "extends": ["@arrai-innovations/commitlint-config"]
   }
   ```

---
_Source: https://npm.io/package/@arrai-innovations/commitlint-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._