GitDocでコミット忘れを防ごう

1
"extensions": [
2
  "vsls-contrib.gitdoc"
3
]

1
"settings": {
2
  "gitdoc.commitValidationLevel": "warning",
3
  "gitdoc.autoPull": "onPush",
4
  "gitdoc.ai.model": "gpt-4o",
5
  "gitdoc.enabled": true,
6
  "gitdoc.ai.enabled": true,
7
  "gitdoc.excludeBranches": [
8
    "master",
9
    "develop"
10
  ]
11
}

1
---
2
extends:
3
- "@commitlint/config-conventional"
4
rules:
5
  header-max-length:
6
  - 2
7
  - always
8
  - 72
9
  type-enum:
10
  - 2
11
  - always
12
  - - build
13
    - ui
14
    - ci
15
    - docs
16
    - feat
17
    - fix
18
    - perf
19
    - chore
20
    - refactor
21
    - revert
22
    - format
23
    - test
24
prompt:
25
  messages:
26
    skip: "'Enterでスキップ'"
27
    max: 最大%d文字
28
    emptyWarning: 必須事項です
29
    upperLimitWarning: 最大文字数を超えています
30
  questions:
31
    type:
32
      description: 変更の種類を選択する
33
      enum:
34
        build:
35
          description: ビルドシステムや外部依存に関する変更
36
          title: Builds
37
        ci:
38
          description: CIの設定ファイルやスクリプトの変更
39
          title: Continuous Integrations
40
        chore:
41
          description: 補助ツールの導入やドキュメント生成などソースやテストの変更を含まない変更
42
          title: Chores
43
        docs:
44
          description: ドキュメントのみの変更
45
          title: Documentation
46
        feat:
47
          description: 新機能の追加
48
          title: Features
49
        fix:
50
          description: バグの修正
51
          title: Bug Fixes
52
        format:
53
          description: 動作に影響を与えないコードの書式などの変更
54
          title: Format
55
        perf:
56
          description: パフォーマンス向上を目的としたコードの変更
57
          title: Performance Improvements
58
        refactor:
59
          description: 新機能追加でもバグ修正でもないコードの変更
60
          title: Code Refactoring
61
        revert:
62
          description: コミットの取り消し
63
          title: Reverts
64
        test:
65
          description: テストの追加や変更
66
          title: Tests
67
        ui:
68
          description: スタイリングの追加や変更
69
          title: UI
70
    scope:
71
      description: 変更範囲を記述する
72
    subject:
73
      description: 変更内容を概括する
74
    body:
75
      description: 変更内容を詳述する(body:最大100文字)
76
    isBreaking:
77
      description: 破壊的変更はあるか
78
    breakingBody:
79
      description: 破壊的変更がある場合は必ず変更内容を詳説する
80
    breaking:
81
      description: 破壊的変更内容を詳述する(footer:最大100文字)
82
    isIssueAffected:
83
      description: 未解決のissuesに関する変更か
84
    issuesBody:
85
      description: issuesをcloseする場合は必ず変更内容の詳説する
86
    issues:
87
      description: 変更内容の詳説とissue番号を記載する(footer:最大100文字)

1
"settings": {
2
  "gitdoc.commitValidationLevel": "warning",
3
  "gitdoc.autoPull": "onPush",
4
  "gitdoc.ai.model": "gpt-4o",
5
  "gitdoc.enabled": true,
6
  "gitdoc.ai.enabled": true,
7
  "gitdoc.excludeBranches": [
8
    "master",
9
    "develop"
10
  ],
11
  "gitdoc.ai.customInstructions": "Generate a commit message in Japanese following the Conventional Commits specification and `commitlint` rules. Use the format `<type>(<scope>): <short description>` and choose `<type>` from `build`, `ci`, `docs`, `feat`, `fix`, `perf`, `chore`, `refactor`, `revert`, `format`, `test`. Limit `<short description>` to 72 characters. If `<short description>` starts with an English word, it must be in lowercase.",
12
}

1
#!/bin/sh
2

3
if [ -z "$GIT_CONFIG_PARAMETERS" ]; then
4
  exec < /dev/tty && bun cz --hook || true
5
fi