Package Exports
- rulesync
- rulesync/dist/index.js
- rulesync/dist/index.mjs
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (rulesync) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
rulesync
統一されたAIルール設定ファイル（.rulesync/*.md）から、各種AI開発支援ツールの設定ファイルを自動生成するNode.js CLIツールです。
対応ツール
- GitHub Copilot Custom Instructions (
.github/instructions/*.instructions.md) - Cursor Project Rules (
.cursor/rules/*.md) - Cline Rules (
.clinerules/*.md)
インストール
npm install -g rulesync
# または
pnpm add -g rulesync
# または
yarn global add rulesync使用方法
1. 初期化
rulesync init.rulesync/ ディレクトリとサンプルルールファイルが作成されます。
2. ルールファイルの編集
各Markdownファイルにフロントマターでメタデータを記述します：
---
priority: high
targets: ["*"] # または [copilot, cursor, cline]
description: "TypeScriptコーディングルール"
globs: ["**/*.ts", "**/*.tsx"]
---
# TypeScript Rules
- TypeScriptを使用する
- 型注釈を明確に記述する3. 設定ファイル生成
# 全ツール用設定ファイル生成
rulesync generate
# 特定ツールのみ
rulesync generate --copilot
rulesync generate --cursor
rulesync generate --cline4. その他のコマンド
# 設定の妥当性チェック
rulesync validate
# 現在の状況確認
rulesync status
# ファイル監視・自動生成
rulesync watch設定ファイル構造
.ai-rules/
├── coding-rules.md # コーディングルール
├── naming-conventions.md # 命名規則
├── architecture.md # アーキテクチャガイドライン
├── security.md # セキュリティルール
└── custom.md # プロジェクト固有ルール生成される設定ファイル
| ツール | 出力先 | 形式 |
|---|---|---|
| GitHub Copilot | .github/instructions/*.instructions.md |
Front Matter + Markdown |
| Cursor | .cursor/rules/*.md |
MDC (YAML header + Markdown) |
| Cline | .clinerules/*.md |
プレーンMarkdown |
開発
# 依存関係インストール
pnpm install
# 開発実行
pnpm dev
# ビルド
pnpm build
# テスト
pnpm test
# コード品質チェック
pnpm lint
pnpm format
pnpm secretlintライセンス
MIT License
貢献
Issue や Pull Request をお待ちしています！
詳細な仕様については SPECIFICATION.md をご覧ください。