commitlint

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 18,694 Open GitHub ↗

📓 Commit 메시지 린트하기

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# [Get Started](https://commitlint.js.org/guides/getting-started) | [Website](https://commitlint.js.org)
> Commit 메시지 린트하기

![](docs/public/assets/commitlint.svg)

> 데모 생성 도구: [svg-term-cli](https://github.com/marionebl/svg-term-cli)
>
> `cat docs/assets/commitlint.json | svg-term --out docs/public/assets/commitlint.svg --frame --profile=Seti --height=20 --width=80`
[![npm latest][2]][3] [![node compatibility][13]][14] [![Github Actions][4]][5]
- 🚓 모범적인 `commitizen` 되기
- 📦 `npm`을 통해 설정 공유하기
- 🤖 `conventional-changelog` 활용하기
## 목차
- [시작하기 | 웹사이트](#get-started--website)
- [목차](#contents)
- [commitlint란 무엇인가요?](#what-is-commitlint)
- [commitlint 사용의 이점](#benefits-of-using-commitlint)
- [시작하기](#getting-started)
- [CLI](#cli)
- [설정](#config)
- [공유 설정](#shared-configuration)
- [문서](#documentation)
- [API](#api)
- [도구](#tools)
- [로드맵](#roadmap)
- [버전 지원 및 릴리스](#version-support-and-releases)
- [릴리스](#releases)
- [관련 프로젝트](#related-projects)
- [라이선스](#license)
- [개발](#development)
- [설치 및 실행](#install-and-run)
---
## commitlint란 무엇인가요?
commitlint는 커밋 메시지가 [Conventional Commit 형식](https://conventionalcommits.org)을 준수하는지 확인합니다.
일반적인 패턴은 대략 다음과 같습니다:
```sh
type(scope?): subject #scope는 선택사항이며, 여러 scope를 지원합니다 (현재 구분자 옵션: "/", "\" 및 ",")
```
실제 사용 예시는 다음과 같습니다:
```text
chore: run tests on travis ci
```
```text
fix(server): send cors headers
```
```text
feat(blog): add comment section
```
[commitlint-config-conventional(Angular 컨벤션 기반)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum)에 따른 일반적인 타입은 다음과 같습니다:
- build
- chore
- ci
- docs
- feat
- fix
- perf
- refactor
- revert
- style
- test
이러한 타입들은 [나만의 설정](#config)을 통해 수정할 수 있습니다.
### commitlint 사용의 이점
- [Conventional Commits를 사용하는 이유는 무엇인가요?](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#why-use-conventional-commits)
- ["컨벤션으로 커밋하는 것의 장점" (발표 자료)](https://slides.com/marionebl/the-perks-of-committing-with-conventions#/)
## 시작하기
- [로컬 설정](https://commitlint.js.org/guides/local-setup) - husky를 사용하여 커밋 시 메시지 린트하기
- [CI 설정](https://commitlint.js.org/guides/ci-setup) - CI 빌드 중 메시지 린트하기
## CLI
- commitlint와 상호작용하는 주요 방법입니다.
- `npm install --save-dev @commitlint/cli`
- 패키지: [cli](./@commitlint/cli)
## 설정
- 설정 파일은 다음 위치에서 탐색됩니다:
- `.commitlintrc`
- `.commitlintrc.json`
- `.commitlintrc.yaml`
- `.commitlintrc.yml`
- `.commitlintrc.js`
- `.commitlintrc.cjs`
- `.commitlintrc.mjs`
- `.commitlintrc.ts`
- `.commitlintrc.cts`
- `.commitlintrc.mts`
- `commitlint.config.js`
- `commitlint.config.cjs`
- `commitlint.config.mjs`
- `commitlint.config.ts`
- `commitlint.config.cts`
- `commitlint.config.mts`
- `package.json` 내의 `commitlint` 필드
- [`package.yaml`](https://github.com/pnpm/pnpm/pull/1799) 내의 `commitlint` 필드
- 패키지: [cli](./@commitlint/cli), [core](./@commitlint/core)
- 사용 가능한 전체 규칙 목록은 [규칙](./docs/reference/rules.md)을 참조하세요.
- 설정 예시는 [@commitlint/config-conventional](./@commitlint/config-conventional/src/index.ts)에서 확인할 수 있습니다.
### Node 24+ 관련 중요 참고사항
Node v24는 모듈 로드 방식을 변경했으며, 이는 commitlint 설정 파일에도 영향을 줍니다. 프로젝트에 `package.json`이 포함되어 있지 않은 경우, commitlint가 설정을 로드하지 못해 `Please add rules to your commitlint.config.js` 오류 메시지가 발생할 수 있습니다. 이 문제는 다음 방법 중 하나로 해결할 수 있습니다:
- `package.json` 파일을 추가하고 프로젝트를 ES6 모듈로 선언합니다. `npm init es6`를 실행하여 간단히 수행할 수 있습니다.
- 설정 파일 이름을 `commitlint.config.js`에서 `commitlint.config.mjs`로 변경합니다.
## 공유 설정
`commitlint`와 함께 설치하여 사용할 수 있는 다양한 공유 설정들이 제공됩니다:
- [@commitlint/config-angular](./@commitlint/config-angular)
-

[@commitlint/config-conventional](./@commitlint/config-conventional)
- [@commitlint/config-lerna-scopes](./@commitlint/config-lerna-scopes)
- [@commitlint/config-nx-scopes](./@commitlint/config-nx-scopes)
- [@commitlint/config-patternplate](./@commitlint/config-patternplate)
- [@commitlint/config-workspace-scopes](./@commitlint/config-workspace-scopes)
- [conventional-changelog-lint-config-atom](https://github.com/erikmueller/conventional-changelog-lint-config-atom)
- [conventional-changelog-lint-config-canonical](https://github.com/gajus/conventional-changelog-lint-config-canonical)
> ⚠️ 자신만의 공유 가능한 설정을 배포하고 싶다면 이름이 `commitlint-config-emoji-log` 또는 `commitlint-config-your-config-name` 패턴과 일치하는지 확인하세요. 그런 다음 extend에서 작성해야 할 것은 `emoji-log` 또는 `your-config-name`뿐입니다.
## Documentation
[메인 웹사이트](https://commitlint.js.org/)를 확인하세요.
## API
- `commitlint`와 상호작용하는 대안적인 프로그래밍 방식
- 패키지:
- [format](./@commitlint/format) - commitlint 보고서 서식 지정
- [lint](./@commitlint/lint) - commitlint 규칙에 따라 문자열 린트 수행
- [load](./@commitlint/load) - 공유된 commitlint 설정 로드
- [read](./@commitlint/read) - 지정된 범위 또는 마지막 수정에서 커밋 메시지 읽기
- 전체 메서드 및 예제 목록은 [API](./docs/api)를 참조하세요.
## Tools
- [commitizen adapter](./@commitlint/prompt)
- [prompt](./@commitlint/prompt-cli)
## Roadmap
`commitlint`는 안정화된 것으로 간주되며 다양한 프로젝트에서 개발 도구로 사용됩니다.
> \*\*아이디어\*\*: [conventional-changelog/commitlint#94](https://github.com/conventional-changelog/commitlint/issues/94)
## Version Support and Releases
- Node.js [LTS](https://github.com/nodejs/LTS#lts-schedule) `>= 22.12.0`
- git `>= 2.13.2`
### Releases
우리는 후원을 받는 OSS 프로젝트가 아닙니다. 따라서 이전 릴리스에 대한 패치 버전을 적시에 출시할 것이라고 보장할 수 없습니다.\
이전 버전에 머물러 있고 보안 패치가 필요한 경우, PR을 기여해 주시면 감사하겠습니다.
## Related projects
- [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)
컨벤셔널 커밋 기록에서 변경 로그 생성
- [commitizen](https://github.com/commitizen/cz-cli)
인터넷 사용자를 위한 간단한 커밋 규칙
- [create-semantic-module](https://github.com/jlegrone/create-semantic-module)
신규 또는 기존 프로젝트에 commitizen과 commitlint를 빠르게 통합하기 위한 CLI
## License
Copyright by @marionebl. 모든 `commitlint` 패키지는 MIT 라이선스 하에 배포됩니다.
## Development
`commitlint`는 모노 레포지토리에서 개발됩니다.
### Install and run
```sh
git clone git@github.com:conventional-changelog/commitlint.git
cd commitlint
pnpm install
pnpm build # 빌드 작업 실행
pnpm start # 변경 시 재빌드 (tsc -b --watch)
node @commitlint/cli/cli.js # CLI 실행
```
기여 방법에 대한 자세한 내용은 [기여 가이드](./.github/CONTRIBUTING.md)를 참조하세요.
[0]: https://img.shields.io/badge/stability-stable-green.svg?style=flat-square
[1]: https://nodejs.org/api/documentation.html#documentation\_stability\_index
[2]: https://img.shields.io/npm/v/@commitlint/cli.svg?style=flat-square
[3]: https://npmjs.org/package/@commitlint/cli
[4]: https://github.com/conventional-changelog/commitlint/actions/workflows/CI.yml/badge.svg
[5]: https://github.com/conventional-changelog/commitlint/actions/workflows/CI.yml
[8]: https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square
[9]: https://nodejs.org/api/documentation.html#documentation\_stability\_index
[10]: https://img.shields.io/npm/v/@commitlint/cli/next.svg?style=flat-square
[13]: https://img.shields.io/node/v/@commitlint/cli.svg
[14]: https://nodejs.org/en/about/previous-releases

commitlint

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README