Zenn
⚙️

Cursor Rules の管理・活用検証（開発日記 No.074）

に公開
git submodule
開発日記
cursorrules
idea

関連リンク

はじめに

昨日は、Cursor Rules の管理・活用方法について検討しました。今日は、その検証作業を進めていきます。具体的には、Rules をどのように分類し、管理し、実際に動作させるかを確認します。

背景と目的

以前から考えていた Cursor Rules の管理・活用方法を実現するために、実際に検証を行います。Rules を一元管理し、プロジェクト間で共有できるようにすることで、開発効率の向上を目指します。また、タスクに応じて Rules を切り替えることで、より柔軟な開発環境を構築したいと考えています。

検討内容

検証計画として、以下の内容を検討しました。

  1. Rules の分類: 背景知識 Rules（常に適用）と役割（モード） Rules（タスクに応じて切り替え）の2種類に分類します。
  2. 管理方法: 専用の Git リポジトリで Rules を一元管理し、各プロジェクトでは Git Submodule として追加します。
  3. 検証手順: Rules 専用リポジトリの準備、検証用プロジェクトの準備、Rules の動作確認、共通 Rules の更新テストを行います。

実装内容

まずは、Rules 専用リポジトリ（https://github.com/centervil/my-cursor-rules.git）の内容を確認しました。リポジトリは、knowledge（背景知識 Rules）、modes（役割 Rules）、references（参考資料）の3つのディレクトリに分かれています。

次に、現在のプロジェクトを検証用プロジェクトとして使用し、以下の手順で Rules を組み込みました。

  1. プロジェクトを Git リポジトリとして初期化
  2. .cursor/rules ディレクトリを作成
  3. Rules 専用リポジトリを Git Submodule として .cursor/rules-common に追加
git init
mkdir -p .cursor/rules
git submodule add https://github.com/centervil/my-cursor-rules.git .cursor/rules-common

その後、背景知識 Rules（alwaysApply: true）、手動モード Rules（manual: true）、エージェント要求モード Rules（agentRequested: true）の3種類の Rules ファイルを確認しました。現在のリポジトリには manual: true や agentRequested: true の設定を持つファイルは見当たらなかったので、必要に応じて新規作成することにします。

残念ながら、現在の環境ではプロジェクトディレクトリに直接ファイルを書き込む権限がないため、シンボリックリンクの作成や実際のファイル操作は実行できませんでした。

技術的なポイント

今回の検証では、Git Submodule を使用して Rules を一元管理する点が技術的なポイントです。Git Submodule を使うことで、Rules リポジトリの変更を各プロジェクトに反映させることが容易になります。また、Rules をカテゴリ別に整理することで、管理しやすく、必要な Rules を見つけやすくすることができます。

所感

Git Submodule を使った Rules の一元管理は、技術的には実現可能であることが確認できました。しかし、実際に Rules を動作させるためには、プロジェクトディレクトリへの書き込み権限が必要であることがわかりました。また、manual: true や agentRequested: true の設定を持つ Rules ファイルが不足しているため、今後作成する必要があります。

今回の検証を通して、Rules の分類方法やリポジトリの構造について、より具体的なイメージを持つことができました。また、Git Submodule の使い方についても理解が深まりました。

今後の課題

今後の課題としては、以下の点が挙げられます。

  • プロジェクトディレクトリへの書き込み権限を取得する。
  • manual: true や agentRequested: true の設定を持つ Rules ファイルを作成する。
  • 作成した Rules ファイルを実際に動作させ、効果を検証する。
  • 共通 Rules の更新テストを行う。

まとめ

今回は、Cursor Rules の管理・活用方法の検証を行いました。Git Submodule を使用した Rules の一元管理は技術的に可能であることが確認できましたが、いくつかの課題が残っています。今後は、これらの課題を解決し、より実用的な Rules 管理システムを構築していきたいと思います。

GitHubで編集を提案

Discussion