commitlint-config - GitLite

KO | EN

gitlite — search

#python #ai #llm #go #android #rust #deep-learning #nodejs #java #awesome-list #vue #pytorch #openai #open-source

commitlint-config

(★ 99)

Shareable commitlint config used by Rocketseat 🚀

File Explorer

Download Latest Version (.zip)

index.js
LICENSE.md
package.json
README.md

# Installation Guide

1. Get the code

git clone https://github.com/Rocketseat/commitlint-config

Downloads the entire project code from GitHub to your computer.

cd commitlint-config

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm i -D @rocketseat/commitlint-config @commitlint/cli

Type this command into your terminal and run it.

yarn add -D @rocketseat/commitlint-config @commitlint/cli

Type this command into your terminal and run it.

npm i -D husky

Type this command into your terminal and run it.

yarn add -D husky

Type this command into your terminal and run it.

yarn commitlint --edit $1

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# @rocketseat/commitlint-config

<p>
  <img src="https://img.shields.io/npm/v/@rocketseat/commitlint-config?style=flat-square&color=8257E5&labelColor=121214" alt="npm version" />
  <img alt="License" src="https://img.shields.io/github/license/rocketseat/commitlint-config?style=flat-square&color=8257E5&labelColor=121214">
</p>

Shareable [`commitlint`](https://github.com/conventional-changelog/commitlint) config used by Rocketseat.

## Install

You can install it with npm or Yarn.

```sh
# npm
npm i -D @rocketseat/commitlint-config @commitlint/cli

# Yarn
yarn add -D @rocketseat/commitlint-config @commitlint/cli
```

## Usage

After installing it, apply the config to `commitlint` by running the following command:

```sh
echo "module.exports = { extends: ['@rocketseat/commitlint-config'] };" > .commitlintrc.js
```

## Bonus

To lint commits before they are created, install Husky and use the 'commit-msg' hook.

```sh
# Npm
npm i -D husky

# Yarn
yarn add -D husky
```

After that, you can create a `.huskyrc` file or add to your `package.json` the following code for

Husky v4:

```json
{
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  }
}
```

Husky v5:

```
# .husky/commit-msg
# ...
npx --no-install commitlint --edit $1
# or
yarn commitlint --edit $1
```

## Version Support

- Node.js [LTS](https://github.com/nodejs/LTS#lts-schedule) `>= 10.21.0`
- git `>= 2.13.2`

## License

MIT License © [Rocketseat](https://github.com/Rocketseat)