commitlint란?

git에서 커밋 메시지를 특정 형식으로만 제한할 수 있습니다.
-> htp // 마리오네 bl. 기주 b. 이오 / 코미 t t
자세한 설명은 할애합니다. (자신도 거기까지 자세하지 않기 때문에)

많은 인원으로 개발할 때 커밋 메시지가 통합되면 작업 상황을 쉽게 파악할 수 있습니다.

예를 들어, 자신의 경우는 아래와 같이 커밋 메시지의 포맷을 통일하고 있습니다.

커밋 메시지의 예

:art: Create sample/index.vue

サンプルのvueファイルを作成。

이모티콘 시작하기

첫 번째 문자는 대문자로 시작합니다

1행째와 상세를 쓰는 부분의 사이에 공백행을 마련한다.

etc.

GitHub에서는 이모티콘을 사용하면 다음과 같이 커밋 메시지의 모양이 좋아집니다 (개인적인 견해입니다)

전치

지금까지 혼자서 개발할 때는 커밋 메시지의 중요성을 알지 못하고 적당한 메시지를 붙여 커밋했습니다. 는 commitlint 의 도입에 대해 정리해 보았습니다. npm 커맨드 등에 대해서는 배우기 시작했을 뿐이므로, 잘못된 점이나 개선할 수 있는 점이 있으면 지적해 주시면 감사하겠습니다.

commitlint 도입 방법

프로젝트에 npm 도입

먼저 commitlint를 배포하려는 프로젝트에 npm을 도입하여 package.json를 만듭니다.

$ npm init -y

commitlint 설치

CLI 패키지 : @commitlint/cli

구성 패키지 : @commitlint/config-conventional

$ npm install --save-dev @commitlint/{cli,config-conventional}

커밋 린트 구성 파일 ( commitlint.config.js ) 만들기

$ echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js

위 명령은 commitlint.config.js를 만듭니다.

commitlint.config.js

module.exports = {
  extends: ['@commitlint/config-conventional']
};

여기에 커밋 메시지 규칙을 설명합니다. ( commitlint.config.js 의 규칙이나 쓰기 방법에 대해서는 다른 기사를 참조해 주세요.)

husky를 설치하고 후크를 추가합니다.

$ npm install husky --save-dev

package.json을 열면 다음과 같습니다.

package.json

{
  "name": "リポジトリ名",
  "version": "1.0.0",
  "description": "READMEの先頭に書いてある内容",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "[email protected]:example.git"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "@commitlint/cli": "^8.3.5",
    "@commitlint/config-conventional": "^8.3.4",
    "husky": "^4.2.3"
  }
}

거기에 다음 필드를 추가하십시오.

package.json

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

완성하면 이렇게 됩니다.

package.json

{
  "name": "リポジトリ名",
  "version": "1.0.0",
  "description": "READMEの先頭に書いてある内容",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "[email protected]:example.git"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "@commitlint/cli": "^8.3.5",
    "@commitlint/config-conventional": "^8.3.4",
    "husky": "^4.2.3"
  },
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  }
}

이상! ! ! ! !

마지막으로 .gitignore에 node_modules를 추가하는 것을 잊지 마십시오.
이렇게 하면 커밋할 때 자동으로 커밋 메시지가 검열되고 규칙에 맞지 않는 것은 커밋할 수 없게 됩니다.

참고

자신이 commitlint를 도입하는데 있어서 참고로 한 기사입니다.

commitlint 소개

git 커밋 메시지를 시맨틱으로