commitlint-config - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #ai #golang #go #machine-learning #macos #windows #kubernetes #vue #pytorch #mcp #openai #open-source

commitlint-config

(★ 99)

Shareable commitlint config used by Rocketseat 🚀

파일 탐색기

최종 버전 다운로드 (.zip)

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

# 설치 가이드

1. 코드 내려받기

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

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd commitlint-config

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

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

이 명령어를 터미널에 그대로 입력해 실행하세요.

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

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm i -D husky

이 명령어를 터미널에 그대로 입력해 실행하세요.

yarn add -D husky

이 명령어를 터미널에 그대로 입력해 실행하세요.

yarn commitlint --edit $1

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 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)