【ITニュース解説】📏 Guide CursorAI with a `.prompt-rules.md` File

CursorAIは、AIを活用したコーディング支援ツールで、ユーザーのコードを解析し、文脈に沿ったコードの提案や説明、リファクタリングなどを自動で行う。しかし、AIが生成するコードが、必ずしもチームや個人のコーディングスタイル、あるいはプロジェクトの規約に合致するとは限らない。現状、CursorAIには、コーディング規約を厳格に適用する機能が組み込まれていないため、提案されるコードが規約に違反する可能性がある。

この記事では、そのような問題を解決するための、手動による簡単な回避策を紹介する。それは、プロジェクトのルートディレクトリに、.prompt-rules.mdという名前のMarkdownファイルを作成し、その中にプロジェクト固有のコーディングルールやガイドラインを記述するという方法だ。

具体的な手順は以下の通り。まず、プロジェクトのルートディレクトリ（package.jsonやREADME.mdと同じ階層）に、.prompt-rules.mdという名前のファイルを作成する。次に、そのファイルの中に、チームやプロジェクトで遵守すべきコーディングルールを、明確かつ簡潔に記述する。まるで、チームメンバーに指示を与えるように、わかりやすい言葉で記述することが重要となる。

例えば、以下のようなルールを記述できる。

1. TypeScriptを使用し、厳格な型付けを行うこと。
2. Reactコンポーネントは、関数コンポーネントとして実装すること。
3. any型は使用せず、ユニオン型やジェネリクスを使用すること。
4. Promiseよりもasync/awaitを優先して使用すること。
5. Airbnb JavaScript Style Guideに従うこと。
6. 複雑なロジックには、インラインコメントを追加すること。
7. インラインCSSは避け、styled-componentsを使用すること。
8. 関数は40行以内に保つこと。

この方法が有効な理由は、CursorAIがプロジェクト内のすべてのファイルをスキャンし、コードの文脈を理解しようとするからだ。.prompt-rules.mdファイルに記述されたルールは、CursorAIに対する一種の「指示書」として機能し、AIはそれを考慮してコードの提案や説明を行うようになる。このファイルに記述されたルールは、AIによる提案、説明、リファクタリングなど、あらゆる種類の支援に適用される。

ただし、この方法にはいくつかの制限がある。まず、ESLintのような厳格なルール適用ではないため、CursorAIはルールに違反するコードを提案する可能性が残る。.prompt-rules.mdはあくまでAIに対する「ガイドライン」であり、「強制力」はない。次に、.prompt-rules.mdファイルの内容を常に最新の状態に保つ必要がある。プロジェクトのルールが変更された場合は、忘れずにファイルを更新しなければならない。

まとめると、CursorAIの提案するコードを、プロジェクトのコーディング規約に合わせるためには、プロジェクトのルートディレクトリに.prompt-rules.mdファイルを配置し、そこにコーディングルールを記述するのが効果的だ。特別なプラグインなどは必要なく、手軽に導入できる点がメリットである。ただし、この方法は完全な解決策ではなく、あくまで一時的な回避策であることを理解しておく必要がある。将来的には、CursorAI自体に、コーディング規約を厳格に適用する機能が組み込まれることが期待される。この.prompt-rules.mdファイルは、その機能が実装されるまでの間、有効な手段となるだろう。システムエンジニアを目指す上で、様々なツールを自分たちの開発スタイルに合わせる工夫は非常に重要だ。今回紹介した方法は、その一例として覚えておくと良い。