Cursorのドキュメント参照時の@Web、@Link、rulesの使い分けを知りたいんじゃ
初めに
絵文字で毎回何を使うか迷うオメガマスターです。
いや〜暑くて夏バテしそうですよね〜
皆さん暑い夏ももう少しで終わると思うので、もう少し頑張りましょう!
今回の内容に関して
皆さんCursorで何かしらのドキュメント(Next.jsやTailwindとか)を参照する際にどうしていますか?@Docs?@Web?@Link?rulesに記載?
私はrulesに記載していますが、@Webにするのとどう違うのかな?と思いそれぞれ調べた内容とCursorチームに問い合わせた内容を記載します。
結論
ドキュメントについては、以下をお勧めします。
プロジェクト全体のコンテキストを永続化するために、ルールファイル内のリンクを保持します。
開発中に特定の Next.js ドキュメント ページを参照する必要がある場合は、@Link を使用します。
Next.jsの実践に関する最近のコミュニティの議論やチュートリアルを見つける必要がある場合は、@Webを使用してください。
.cursor/rulesに記載の場合(私の現状)
ルールにドキュメントリンクを含めるという現在のアプローチは、永続的なコンテキストを提供するのに適しています。ルールは、コード生成時にCursorが常に利用できるシステムレベルの命令として機能します。
rulesの内容
## Code Generation
- コードを生成する前に、必ず関連するドキュメントを確認する
- フレームワークやライブラリの使用方法については、必ず公式ドキュメントを参照する
- ドキュメントをもとにベストプラクティスを検証する
- 適用可能な場合は、コードコメントにドキュメント参照を含めること
- CSSはTailwindCSSを使用すること
## Required Documentation
- Next.js: https://nextjs.org/docs
- React 19: https://react.dev
- TypeScript: https://www.typescriptlang.org/docs/
- tailwindcss:https://tailwindcss.com/docs/
@Webの場合
Webの場合はexa.aiを使ってインターネット上の最新情報を検索します。最新のチュートリアル、比較、コミュニティでの議論を見つけるのに最適です。注: この機能を使用するには、「設定」→「機能」→「Web検索」で有効にする必要があります。
@Linkの場合
Linkの場合はチャットにURLを貼り付けると、Cursorは自動的に@Linkとしてタグ付けし、その内容をコンテキストとして取得します。これは、Cursorに特定のページを参照させたい場合に最適です。
@Docsの場合
まだDocsを設定していない場合、チャット欄で@をクリックするとDocsが表示されるのでクリック、add New Docsを選択しリンクを貼り付けます。そうすると下記の画像のような表示になります。
SHARE WITH TEAMをONにするとチームプランに入っているメンバー全員に共有できます。
こちらはチャット時に毎回@DocsでDocsのドキュメントを参照します。
しかし正直毎回指定するのは面倒ですよね…
最後に
今回はかなりショートな記事ですが、気になったので記載しました。
昔のQiitaでは多分これぐらいで終わっていましたよね〜最近の記事は長すぎると思うので、たまにはこれぐらいで締めたいと思います。
それでは残りの猛暑乗り越えましょ〜
Discussion