@nahisaho/katashiro 2.1.2 → 2.1.3

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.
Files changed (2) hide show
  1. package/AGENTS.md +69 -0
  2. package/package.json +1 -1
package/AGENTS.md CHANGED
@@ -26,6 +26,75 @@
26
26
 
27
27
  ---
28
28
 
29
+ ## ⚠️ 重要: TypeScriptコード生成・実行ワークフロー
30
+
31
+ DeepResearchやその他の機能でTypeScriptコードを生成・実行する際は、**必ず以下のワークフローに従ってください**。
32
+
33
+ ### 必須ワークフロー
34
+
35
+ ```
36
+ 1. コード生成
37
+
38
+ 2. TypeScript型チェック(tsc --noEmit)
39
+
40
+ 3. エラーがあれば修正
41
+
42
+ 4. 実行
43
+ ```
44
+
45
+ ### 実行前チェックリスト
46
+
47
+ 生成したTypeScriptコードを実行する前に、以下を確認してください:
48
+
49
+ #### 1. Result型APIのチェック
50
+ ```typescript
51
+ // ❌ 間違い - WebScraper.scrape()はResult型を返す
52
+ const page = await scraper.scrape(url);
53
+ console.log(page.content); // エラー!
54
+
55
+ // ✅ 正しい
56
+ const page = await scraper.scrape(url);
57
+ if (isOk(page)) {
58
+ console.log(page.value.content);
59
+ }
60
+ ```
61
+
62
+ #### 2. 直接値APIのチェック
63
+ ```typescript
64
+ // ❌ 間違い - TextAnalyzer.analyze()は直接オブジェクトを返す
65
+ const analysis = await analyzer.analyze(text);
66
+ if (isOk(analysis)) { // エラー!isOk()は不要
67
+ console.log(analysis.value.keywords);
68
+ }
69
+
70
+ // ✅ 正しい
71
+ const analysis = await analyzer.analyze(text);
72
+ console.log(analysis.keywords);
73
+ ```
74
+
75
+ #### 3. 型チェックコマンド
76
+ ```bash
77
+ # 生成したファイルの型チェック
78
+ npx tsc --noEmit your-script.ts
79
+
80
+ # エラーがあれば修正してから実行
81
+ npx tsx your-script.ts
82
+ ```
83
+
84
+ ### AIエージェントへの指示
85
+
86
+ **DeepResearch実行時のワークフロー**:
87
+
88
+ 1. **コード生成**: KATASHIROのAPIを使用してTypeScriptコードを生成
89
+ 2. **型チェック**: `npx tsc --noEmit` でコンパイルエラーをチェック
90
+ 3. **エラー修正**: 型エラーがあれば、このドキュメントの「戻り値の型について」セクションを参照して修正
91
+ 4. **実行**: エラーがなくなってから `npx tsx` で実行
92
+ 5. **結果確認**: 実行結果を確認し、必要に応じて修正
93
+
94
+ **重要**: 型チェックをスキップしてはいけません。Result型と直接値の混同は最も一般的なエラーです。
95
+
96
+ ---
97
+
29
98
  ## 🔄 課題解決ワークフロー
30
99
 
31
100
  ### ステップ1: 課題の分析
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nahisaho/katashiro",
3
- "version": "2.1.2",
3
+ "version": "2.1.3",
4
4
  "description": "KATASHIRO - VS Code Agent Mode向け情報収集・分析・生成システム(オールインワンパッケージ)",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",