概要
AIエディタ Cursorには2つのルール設定があります。
1つは設定内のもので、すべてのプロジェクトと対話に適用されます。
もう1つはプロジェクトのルートディレクトリにある.cursorrulesで、現在のプロジェクトに適用されます。
Rules for AI と .cursorrules
- Rules for AI: Cursorの設定画面で設定します。詳細はこちらを参考にしてください。
- .cursorrules: 作成後、リポジトリのルート直下に配置します。
Rules for AI 設定 と .cursorrules ファイル の違い
| 項目 | Rules for AI | .cursorrules |
|---|---|---|
| 対象 | 文体や参考情報 | コーディング規約や選定技術 |
| 範囲 | ユーザーごとの設定 | プロジェクトまたはチーム全体 |
| 設定場所 | Cursor内での設定 | リポジトリのルートディレクトリ |
| ルール | ユーザーごとのルール | プロジェクト全体のルール |
このように、Rules for AIと.cursorrulesはそれぞれ異なる目的と範囲を持っています。プロジェクトに応じて適切なルールを選択しましょう。
.cursorrulesファイルの利点
.cursorrulesは、Cursor AIの体験を向上させるための強力な機能です。以下は、.cursorrulesを使用する理由です。
- カスタマイズされたAIの動作: .cursorrulesファイルは、AIの応答をプロジェクトの特定のニーズに合わせて調整し、より関連性の高い正確なコード提案を保証します。
- 一貫性: コーディング標準やベストプラクティスを.cursorrulesファイルに定義することで、AIがプロジェクトのスタイルガイドラインに沿ったコードを生成することを確実にします。
- コンテキストの認識: プロジェクトに関する重要なコンテキスト（一般的に使用されるメソッド、アーキテクチャの決定、特定のライブラリなど）をAIに提供することで、より情報に基づいたコード生成が可能になります。
- 生産性の向上: 明確に定義されたルールにより、AIは手動編集が少なくて済むコードを生成でき、開発プロセスを加速します。
- チームの整合性: チームプロジェクトの場合、共有の.cursorrulesファイルにより、すべてのチームメンバーが一貫したAI支援を受けられ、コーディングプラクティスの統一が促進されます。
- プロジェクト特有の知識: プロジェクトの構造、依存関係、または独自の要件に関する情報を含めることで、AIがより正確で関連性の高い提案を提供できるようになります。
プロジェクトのルートディレクトリに.cursorrulesファイルを作成することで、これらの利点を活用し、Cursor AIでのコーディング体験を向上させることができます。
良い.cursorrulesの書き方を調べる方法
PatrickJS/awesome-cursorrules: 📄 A curated list of awesome .cursorrules files
が参考になります。このリポジトリは、Cursorのルールをカスタマイズした例を集めたリポジトリです。