カスタム指示

Repomixでは、出力ファイルに含めるカスタム指示（独自の指示）を提供することができます。これは、AIシステムにプロジェクトの特定のコンテキストや要件を理解させるのに役立ちます。

使用方法

カスタム指示を含めるには、リポジトリのルートにマークダウンファイル（例：repomix-instruction.md）を作成し、repomix.config.jsonでそのパスを指定します。

{
  "output": {
    "instructionFilePath": "repomix-instruction.md"
  }
}

このファイルの内容は出力の「Instruction」セクションに含まれます。

使用例

# コーディングガイドライン

- Airbnb JavaScript スタイルガイドに従う
- 適切な場合は、ファイルを小さな単位に分割する
- 自明でないロジックにはコメントを追加。すべてのテキストは英語で記述
- すべての新機能には対応するユニットテストを作成する

# 生成内容について

- 特に指定がない限り、すべての内容を省略せずに含める
- 大規模なコードベースを処理しながら、出力の品質を維持する

これは出力ファイルで以下のように表示されます。

<instruction>
# コーディングガイドライン

- Airbnb JavaScript スタイルガイドに従う
- 適切な場合は、ファイルを小さな単位に分割する
- 自明でないロジックにはコメントを追加。すべてのテキストは英語で記述
- すべての新機能には対応するユニットテストを作成する

# 生成内容について

- 特に指定がない限り、すべての内容を省略せずに含める
- 大規模なコードベースを処理しながら、出力の品質を維持する
</instruction>

注意点

• カスタム指示は出力ファイルのInstructionセクションに含まれます。
• カスタム指示は適切な長さに保つことを推奨します。過度に長い指示は逆効果になる場合があります。
• プロジェクト固有のガイドラインや要件に焦点を当てることで、AIがプロジェクトのコンテキストを理解しやすくなり、より効果的な結果が得られます。