shared-standards

TechGuide の SvelteKit 案件向け共通標準をまとめるリポジトリです。
標準の正本は docs/standards/sveltekit.md で、Codex / Claude Code / Cursor 向けの補助ファイルと、各案件へ同期するテンプレート群を同梱します。

方針

• 対象は SvelteKit 案件に限定します。
• 標準の主軸は人間向け文書と CI チェックです。
• AI ツール向け設定は補助物として扱い、内容は標準文書と矛盾させません。
• 各案件はこのリポジトリのタグを固定して採用し、案件固有ルールだけをローカルに持ちます。

ディレクトリ構成

docs/                 人間向け標準文書と導入ガイド
skills/               Codex 用 skill
templates/project/    各案件へ同期する最小テンプレート
scripts/              同期・導入・静的チェック用スクリプト
fixtures/             script / action 検証用ミニ repo
.github/actions/      consumer repo から再利用する composite action

クイックスタート

各案件へ適用する

1. この repo の採用バージョンを決める
   例: v0.1.0
2. 各案件 repo にテンプレートを同期する

./scripts/sync-project-standards.sh \
  --target /path/to/project \
  --version v0.1.0 \
  --profile sveltekit \
  --adapters codex,claude,cursor

3. 必要なら Codex skill をローカル環境へ導入する

./scripts/install-codex-skills.sh --mode copy

4. 各案件 repo で docs/engineering/project-exceptions.md に案件固有の例外だけを書く

consumer repo で守るもの

• /.shared-standards.json
• docs/engineering/shared-standards.md
• docs/engineering/project-exceptions.md
• 利用する AI ツールごとの設定ファイル
• CI 上の check-sveltekit-standards

Consumer Contract

各案件 repo の正本設定ファイルは /.shared-standards.json です。

{
  "profile": "sveltekit",
  "version": "v0.1.0",
  "adapters": ["codex", "claude", "cursor"],
  "disabledChecks": [],
  "notesPath": "docs/engineering/project-exceptions.md",
  "typecheckCommand": "pnpm check"
}

利用可能な自動チェック ID:

• no-export-let
• no-app-stores
• no-create-event-dispatcher
• no-svelte-component
• no-server-imports-in-universal

例外は disabledChecks と docs/engineering/project-exceptions.md の両方に記録してください。口頭運用のみの例外は認めません。

AI Tool Adapters

• Codex 導入ガイド
• Claude Code 導入ガイド
• Cursor 導入ガイド

リリース運用

• 互換性のある標準更新はタグでリリースします。
• 各案件は採用タグを固定してください。
• 変更履歴は CHANGELOG.md に記録します。

開発者向け検証

bash scripts/test-fixtures.sh

このコマンドは以下を確認します。

• sync-project-standards.sh の初回同期 / 再同期 / dry-run
• install-codex-skills.sh の copy / symlink / 上書き確認
• check-sveltekit-standards の成功系 / 失敗系

ライセンス

MIT