SSG - Gitの統一標準

定義

SSG標準は、Gitのセマンティクス、アクセシビリティ、および動作ロジックに関する要件を規定しています。

標準的なコミット - コミットの構成

コミットメッセージは、以下の構成に従う必要があります：

<タイプ>([適用範囲]): <概要>

[コミット本文]

[フッター]

ヘッダー - 必須項目

タイプ - コミットの分類：

適用範囲 はオプションで、プロジェクトのどの部分が影響を受けるかを示します（例：ui、api、auth）：

feat(api): ユーザー向けの新しいエンドポイントを追加

説明 は変更内容を記述するもので、できれば命令形で、50文字以内とします。

本文とフッター、オプションの部分

本文では、何が、なぜ変更されたのかを説明します。

フッターはBreaking Changesに使用され、互換性のない変更は BREAKING CHANGE: または feat! で指定します（例：feat!: 非推奨のapiメソッドを削除）。また、課題への参照（例：Closes #123）にも使用されます。

安全なコミットプロセスを実現するためのパイプラインの設定

パイプラインは、フォーマット、コミットの検証、およびブランチの安全なマージを保証します。

必要な依存関係

npm i -D \
  husky \
  lint-staged \
  @commitlint/cli \
  @commitlint/config-conventional \
  @commitlint/types \
  conventional-changelog-conventionalcommits \
  @archoleat/commitlint-define-config

lint-staged の設定

lint-staged は、インデックスに登録された変更のみをチェックします：

export default {
  '*': 'prettier --write',
  'src/**/*.{tsx,ts}': 'eslint --fix',
  'src/**/*.scss': 'stylelint --fix',
};

Commitlintの設定

Commitlint は、コミットの形式と許可されたタイプをチェックします：

import { defineConfig } from '@archoleat/commitlint-define-config';

export default defineConfig({
  extends: ['@commitlint/config-conventional'],
  rules: {
    'type-enum': [
      2,
      'always',
      [
        'build',
        'chore',
        'ci',
        'docs',
        'feat',
        'fix',
        'perf',
        'refactor',
        'revert',
        'spec',
        'style',
      ],
    ],
  },
});

defineConfig用のプラグインはこちらから確認できます

Gitフックの設定（Husky）

Huskyには、コミットがチェックに合格しなかった場合、変更内容が失われることがあるバグがあります！

コミットプロセスの概要

• 変更のステージング:

  git add .

• コミットの作成:

  git commit -m "feat(header): テーマ切り替えボタンを追加"

• pre-commit:

  lint-staged が実行され、Prettier、ESLint、Stylelint がインデックスに登録されたファイルのエラーを修正した後、修正されたファイルが再度インデックスに追加されます。

• commit-msg:

  commitlint は、コミットヘッダーが Conventional Commits のルールに準拠しているかどうかを確認します。

• 結果：

  すべてのチェックに合格した場合、コミットは正常に完了します。そうでない場合は、エラーメッセージとともにコミットが却下されます。