push_rules

Cursor Rules for slack-utils

コミット前の必須チェックリスト

重要: git push する前に必ず以下のコマンドをローカルで実行し、全てがパスすることを確認してください。

必須実行コマンド

# 1. フォーマットチェック
deno fmt --check

# 2. リントチェック
deno lint

# 3. 全テスト実行
deno test --allow-all

ワークフロー

1. コードを変更
2. 上記3つのコマンドを実行
3. 全てパスしたことを確認
4. git add .
5. git commit -m "..."
6. git push

理由

CIでのフォーマットエラーやテスト失敗を防ぐため、ローカルで事前に全てのチェックを実行する必要があります。

プロジェクト情報

• このプロジェクトはDenoプロジェクトです
• package.json は存在しません
• 改行コードはLF（Unix形式）に統一されています
• Slackチャンネル名は #05-miyazawa です

新規関数作成時のルール

重要: 新しい関数やモジュールを作成する際は、必ず以下を実施してください。

必須事項

1. 関数にJSDocコメントを追加

   • 関数の目的と動作を説明する
   • パラメータの説明を @param で記載
   • 戻り値の説明を @returns で記載
   • エラーの場合は @throws で記載

   /**
    * Slackチャンネルの情報を取得します
    *
    * @param client - Slack APIクライアント
    * @param channelId - 取得対象のチャンネルID
    * @returns チャンネルの概要情報
    * @throws {Error} チャンネル情報の取得に失敗した場合
    */
   export async function retrieveChannelSummary(
     client: SlackAPIClient,
     channelId: string,
   ): Promise<ChannelSummary> {
     // ...
   }
   

2. テストファイルを作成

   • 関数と同じディレクトリに test.ts を配置
   • 正常系と異常系の両方をテスト
   • テスト名は日本語で明確に記述（例: "正常にチャンネル情報を取得できる"）
   • モックを使用して外部依存を排除

3. テストカバレッジ

   • 主要な処理パスをカバーする
   • エッジケースやエラーハンドリングもテスト
   • 最低限、正常系1つ・異常系1つを含める

テストファイルの命名規則

• 関数ファイル: mod.ts または {function_name}.ts
• テストファイル: test.ts または {function_name}_test.ts
• テストファイルは関数ファイルと同じディレクトリに配置

参考例

functions/get_channel_info/ を参照してください：

• mod.ts: JSDocコメント付きの関数実装
• test.ts: 正常系・異常系のテストケース

I18n（多言語対応）ルール

重要: エラーメッセージやユーザー向けメッセージを記述する際は、必ず以下を実施してください。

必須事項

1. 直接文字列を使わず t() 関数を使用

   • ハードコードされた文字列は避ける
   • 全てのユーザー向けメッセージは翻訳可能にする

   // ❌ 悪い例
   throw new Error("Failed to load channel info");
   
   // ✅ 良い例
   import { t } from "../../lib/i18n/mod.ts";
   throw new Error(t("errors.channel_not_found", { error }));
   

2. 英語をベース言語として locales/en.json に追加

   • 新しいメッセージは必ず locales/en.json に追加
   • 適切なカテゴリ（errors, messages, logs）に配置
   • プレースホルダーは {変数名} の形式で記述