commitlint

시작 | 웹 사이트

보풀 커밋 메시지

SVG-Term-Cli로 생성 된 데모

cat docs/assets/commitlint.json | svg-term --out docs/public/assets/commitlint.svg --frame --profile=Seti --height=20 --width=80

• 좋은 commitizen 되십시오

• npm 통해 구성을 공유하십시오

• conventional-changelog 를 활용하십시오

내용물

• 시작 | 웹 사이트

• 설치 및 실행

• 릴리스

• Commitlint 사용의 이점

• 내용물

• Commitlint는 무엇입니까?

• 시작하기

• 클리

• 구성

• 공유 구성

• 선적 서류 비치

• API

• 도구

• 로드맵

• 버전 지원 및 릴리스

• 관련 프로젝트

• 특허

• 개발

---

Commitlint는 무엇입니까?

CommitLint는 커밋 메시지가 기존 커밋 형식을 충족하는지 확인합니다.

일반적으로 패턴은 주로 다음과 같습니다.

 유형 (스코프?) : 주제 #scope는 선택 사항입니다. 여러 스코프가 지원됩니다 (현재 구분 기 옵션 : "/", ""및 ",")

실제 예제는 다음과 같이 보일 수 있습니다.

chore: run tests on travis ci

fix(server): send cors headers

feat(blog): add comment section

Commitlint-Config-Conventional (Angular Convention에 따른)에 따른 일반적인 유형은 다음과 같습니다.

• 짓다

• 하기 싫은 일

• CI

• 문서

• 위업

• 고치다

• 성전

• 리팩터

• 돌아가는 것

• 스타일

• 시험

이들은 자신의 구성으로 수정할 수 있습니다.

Commitlint 사용의 이점

• 왜 기존의 커밋을 사용합니까?

• "컨벤션에 대한 커밋의 특전"(토크 슬라이드)

시작하기

• 로컬 설정 - Husky와의 커밋의 보풀 메시지

• CI 설정 - CI 빌드 중에 보풀 메시지

클리

• Commitlint와 상호 작용하는 주요 방법.

• npm install --save-dev @commitlint/cli

• 패키지 : CLI

구성

• 구성은 다음과 같습니다.

• .commitlintrc

• .commitlintrc.json

• .commitlintrc.yaml

• .commitlintrc.yml

• .commitlintrc.js

• .commitlintrc.cjs

• .commitlintrc.mjs

• .commitlintrc.ts

• .commitlintrc.cts

• commitlint.config.js

• commitlint.config.cjs

• commitlint.config.mjs

• commitlint.config.ts

• commitlint.config.cts

• commitlint 필드는 package.json

• commitlint field package.yaml

• 패키지 : CLI, 코어

• 가능한 규칙의 전체 목록은 규칙을 참조하십시오

• 예제 구성은 @commitlint/config-conventional에서 찾을 수 있습니다

공유 구성

commitlint 와 함께 설치하고 사용할 수있는 여러 공유 구성을 사용할 수 있습니다.

• @commitlint/config-angular

• @commitlint/config-conventional

• @commitlint/config-lerna-scopes

• @commitlint/config-nx-scopes

• @commitlint/config-patternplate

• 기존의 랭글 로그 린트-콘피드 원자

• 기존의 랭글 로그 린트-콘 피그-캐노칼

켈 자신만의 공유 가능한 구성을 게시하려면 패턴 commitlint-config-emoji-log 또는 commitlint-config-your-config-name emoji-log 맞는 이름이 있는지 확인하십시오. 또는 your-config-name .

선적 서류 비치

기본 웹 사이트를 확인하십시오.

API

• commitlint 와 상호 작용하는 대안적이고 프로그래밍 방식

• 패키지 :

• 형식 - 형식 CommitLint 보고서

• LINT- 보풀을 린트 CommitLint 규칙에 대한 문자열

• 로드 -로드 공유 커밋 구성

• 읽기 - 지정된 범위 또는 마지막 편집에서 커밋 메시지 읽기

• 방법 및 예제의 전체 목록은 API를 참조하십시오.

도구

• Commitizen 어댑터

• 즉각적인

로드맵

commitlint 는 안정적으로 간주되며 다양한 프로젝트에서 개발 도구로 사용됩니다.

아이디어 : 기존의 랭글 로그/Commitlint#94

버전 지원 및 릴리스

• node.js lts >= 18

• git >= 2.13.2

릴리스

보안 패치는 아직 EOL이 아닌 버전에 적용됩니다.
기능은 현재 기본 버전에만 적용됩니다.

풀어 주다	초기 릴리스
v19	02/2024
v18	10/2023

EOL은 보통 1 년 정도입니다.

우리는 후원 된 OSS 프로젝트가 아닙니다. 따라서 우리는 적시에 구형 릴리스를위한 패치 버전을 출시 할 것이라고 약속 할 수 없습니다.
이전 버전에 갇혀 있고 보안 패치가 필요한 경우 PR을 제공 할 수 있으면 행복합니다.

관련 프로젝트

• 기존의 랜지 로그는 기존의 커밋 역사에서 변화를 생성합니다

• Commitizen은 인터넷 시민을위한 단순한 커밋 컨벤션

• 신규 또는 기존 프로젝트에서 Commitizen 및 Commitlint를 빠르게 통합하기위한 Semantic-Module CLI 작성

특허

@marionebl의 저작권. 모든 commitlint 패키지는 MIT 라이센스에 따라 릴리스됩니다.

개발

commitlint 모노 저장소로 개발되었습니다.

설치 및 실행

 git clone [email protected] : 기존 changelog/commitlint.gitcd commitlint
방사
원사 실행 빌드 # 실행 빌드 빌드 작업 세트 시작 # 실행 테스트, 다시 changeyarn run commitlint # run cli

기부 방법에 대한 자세한 내용은 기여 가이드를 살펴보십시오.