rulesync 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +125 -0
- package/dist/index.d.mts +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +704 -0
- package/dist/index.mjs +681 -0
- package/package.json +71 -0
package/README.md
ADDED
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
# rulesync
|
|
2
|
+
|
|
3
|
+
[](https://github.com/dyoshikawa/rulesync/actions/workflows/ci.yml)
|
|
4
|
+
[](https://www.npmjs.com/package/rulesync)
|
|
5
|
+
|
|
6
|
+
統一されたAIルール設定ファイル（`.rulesync/*.md`）から、各種AI開発支援ツールの設定ファイルを自動生成するNode.js CLIツールです。
|
|
7
|
+
|
|
8
|
+
## 対応ツール
|
|
9
|
+
|
|
10
|
+
- **GitHub Copilot Custom Instructions** (`.github/instructions/*.instructions.md`)
|
|
11
|
+
- **Cursor Project Rules** (`.cursor/rules/*.md`)
|
|
12
|
+
- **Cline Rules** (`.clinerules/*.md`)
|
|
13
|
+
|
|
14
|
+
## インストール
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install -g rulesync
|
|
18
|
+
# または
|
|
19
|
+
pnpm add -g rulesync
|
|
20
|
+
# または
|
|
21
|
+
yarn global add rulesync
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## 使用方法
|
|
25
|
+
|
|
26
|
+
### 1. 初期化
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
rulesync init
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
`.rulesync/` ディレクトリとサンプルルールファイルが作成されます。
|
|
33
|
+
|
|
34
|
+
### 2. ルールファイルの編集
|
|
35
|
+
|
|
36
|
+
各Markdownファイルにフロントマターでメタデータを記述します：
|
|
37
|
+
|
|
38
|
+
```markdown
|
|
39
|
+
---
|
|
40
|
+
priority: high
|
|
41
|
+
targets: ["*"] # または [copilot, cursor, cline]
|
|
42
|
+
description: "TypeScriptコーディングルール"
|
|
43
|
+
globs: ["**/*.ts", "**/*.tsx"]
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
# TypeScript Rules
|
|
47
|
+
|
|
48
|
+
- TypeScriptを使用する
|
|
49
|
+
- 型注釈を明確に記述する
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### 3. 設定ファイル生成
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
# 全ツール用設定ファイル生成
|
|
56
|
+
rulesync generate
|
|
57
|
+
|
|
58
|
+
# 特定ツールのみ
|
|
59
|
+
rulesync generate --copilot
|
|
60
|
+
rulesync generate --cursor
|
|
61
|
+
rulesync generate --cline
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### 4. その他のコマンド
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
# 設定の妥当性チェック
|
|
68
|
+
rulesync validate
|
|
69
|
+
|
|
70
|
+
# 現在の状況確認
|
|
71
|
+
rulesync status
|
|
72
|
+
|
|
73
|
+
# ファイル監視・自動生成
|
|
74
|
+
rulesync watch
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## 設定ファイル構造
|
|
78
|
+
|
|
79
|
+
```
|
|
80
|
+
.ai-rules/
|
|
81
|
+
├── coding-rules.md # コーディングルール
|
|
82
|
+
├── naming-conventions.md # 命名規則
|
|
83
|
+
├── architecture.md # アーキテクチャガイドライン
|
|
84
|
+
├── security.md # セキュリティルール
|
|
85
|
+
└── custom.md # プロジェクト固有ルール
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## 生成される設定ファイル
|
|
89
|
+
|
|
90
|
+
| ツール | 出力先 | 形式 |
|
|
91
|
+
|--------|--------|------|
|
|
92
|
+
| GitHub Copilot | `.github/instructions/*.instructions.md` | Front Matter + Markdown |
|
|
93
|
+
| Cursor | `.cursor/rules/*.md` | MDC (YAML header + Markdown) |
|
|
94
|
+
| Cline | `.clinerules/*.md` | プレーンMarkdown |
|
|
95
|
+
|
|
96
|
+
## 開発
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
# 依存関係インストール
|
|
100
|
+
pnpm install
|
|
101
|
+
|
|
102
|
+
# 開発実行
|
|
103
|
+
pnpm dev
|
|
104
|
+
|
|
105
|
+
# ビルド
|
|
106
|
+
pnpm build
|
|
107
|
+
|
|
108
|
+
# テスト
|
|
109
|
+
pnpm test
|
|
110
|
+
|
|
111
|
+
# コード品質チェック
|
|
112
|
+
pnpm lint
|
|
113
|
+
pnpm format
|
|
114
|
+
pnpm secretlint
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
## ライセンス
|
|
118
|
+
|
|
119
|
+
MIT License
|
|
120
|
+
|
|
121
|
+
## 貢献
|
|
122
|
+
|
|
123
|
+
Issue や Pull Request をお待ちしています！
|
|
124
|
+
|
|
125
|
+
詳細な仕様については [SPECIFICATION.md](./SPECIFICATION.md) をご覧ください。
|
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
#!/usr/bin/env node
|