@k2works/claude-code-booster 0.9.0 → 0.10.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/lib/assets/.claude/README.md +57 -10
- package/lib/assets/.claude/commands/analysis-architecture.md +98 -0
- package/lib/assets/.claude/commands/analysis-data-model.md +94 -0
- package/lib/assets/.claude/commands/analysis-domain-model.md +101 -0
- package/lib/assets/.claude/commands/analysis-non-functional.md +103 -0
- package/lib/assets/.claude/commands/analysis-operation.md +104 -0
- package/lib/assets/.claude/commands/analysis-requirements.md +100 -0
- package/lib/assets/.claude/commands/analysis-tech-stack.md +113 -0
- package/lib/assets/.claude/commands/analysis-test-strategy.md +101 -0
- package/lib/assets/.claude/commands/analysis-ui-design.md +100 -0
- package/lib/assets/.claude/commands/analysis-usecases.md +100 -0
- package/lib/assets/.claude/commands/analysis.md +49 -177
- package/lib/assets/.claude/commands/dev-backend.md +144 -0
- package/lib/assets/.claude/commands/dev-frontend.md +126 -0
- package/lib/assets/.claude/commands/dev.md +39 -49
- package/lib/assets/.claude/commands/docs.md +213 -0
- package/lib/assets/.claude/commands/plan-github.md +212 -0
- package/lib/assets/.claude/commands/plan.md +17 -0
- package/lib/assets/.claude/settings.json +3 -160
- package/lib/assets/README.md +1 -1
- package/lib/assets/docker-compose.yml +2 -2
- package/lib/assets/gulpfile.js +2 -2
- package/lib/assets/mkdocs.yml +3 -0
- package/lib/assets/{scripts → ops/scripts}/mkdocs.js +21 -3
- package/package.json +1 -1
- /package/lib/assets/{docs → ops/docker/mkdoc}/Dockerfile +0 -0
- /package/lib/assets/{scripts → ops/scripts}/journal.js +0 -0
|
@@ -0,0 +1,212 @@
|
|
|
1
|
+
## Plan GitHub
|
|
2
|
+
|
|
3
|
+
リリース計画を GitHub Project・Issue・Milestone に反映し、プロジェクト管理を GitHub 上で一元化します。
|
|
4
|
+
|
|
5
|
+
### 使い方
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
/plan-github [オプション]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
### オプション
|
|
12
|
+
|
|
13
|
+
- なし : 全体の同期を実行(Project作成、Issue作成、フィールド設定、Milestone作成)
|
|
14
|
+
- `--project` : GitHub Project のみを作成
|
|
15
|
+
- `--issues` : Issue のみを作成(Project が存在する前提)
|
|
16
|
+
- `--fields` : Project フィールド値のみを設定
|
|
17
|
+
- `--milestones` : Milestone のみを作成し Issue に割り当て
|
|
18
|
+
- `--verify` : release_plan.md と GitHub の差異を確認
|
|
19
|
+
- `--status` : 現在の GitHub Project 状態を表示
|
|
20
|
+
|
|
21
|
+
### 基本例
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# 初回の完全同期(Project、Issue、Milestone すべて作成)
|
|
25
|
+
/plan-github
|
|
26
|
+
「リリース計画を GitHub Project に反映して」
|
|
27
|
+
|
|
28
|
+
# GitHub Project のみ作成
|
|
29
|
+
/plan-github --project
|
|
30
|
+
「GitHub Project を作成して」
|
|
31
|
+
|
|
32
|
+
# 差異確認
|
|
33
|
+
/plan-github --verify
|
|
34
|
+
「release_plan.md と GitHub Issue の差異を確認して」
|
|
35
|
+
|
|
36
|
+
# 現在の状態確認
|
|
37
|
+
/plan-github --status
|
|
38
|
+
「GitHub Project の現在の状態を表示して」
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### 詳細機能
|
|
42
|
+
|
|
43
|
+
#### GitHub Project の作成
|
|
44
|
+
|
|
45
|
+
release_plan.md に基づいて GitHub Project を作成し、カスタムフィールドを設定します。
|
|
46
|
+
|
|
47
|
+
**作成されるフィールド**:
|
|
48
|
+
|
|
49
|
+
- **リリース**: 1.0 MVP / 2.0 機能拡張版 / 3.0 完成版
|
|
50
|
+
- **イテレーション**: 1〜12
|
|
51
|
+
- **優先度**: 必須 / 重要
|
|
52
|
+
- **SP**: ストーリーポイント(数値)
|
|
53
|
+
- **カテゴリ**: 認証・ユーザー管理 / マスタ管理 / 仕訳管理 / 元帳・残高管理 / 財務諸表 / システム管理
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
# GitHub Project の作成
|
|
57
|
+
/plan-github --project
|
|
58
|
+
「カスタムフィールド付きの GitHub Project を作成して」
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
#### Issue の作成
|
|
62
|
+
|
|
63
|
+
ユーザーストーリーを GitHub Issue として作成し、Project に追加します。
|
|
64
|
+
|
|
65
|
+
**Issue の構成**:
|
|
66
|
+
|
|
67
|
+
- **タイトル**: `[ストーリーID] ストーリー名`
|
|
68
|
+
- **本文**: ユーザーストーリー、受け入れ基準、見積もり情報
|
|
69
|
+
- **Project 紐付け**: 作成した Project に自動追加
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
# Issue の作成と Project への追加
|
|
73
|
+
/plan-github --issues
|
|
74
|
+
「ユーザーストーリーを Issue として作成して Project に追加して」
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
#### フィールド値の設定
|
|
78
|
+
|
|
79
|
+
各 Issue の Project フィールドに release_plan.md の値を反映します。
|
|
80
|
+
|
|
81
|
+
**設定される情報**:
|
|
82
|
+
|
|
83
|
+
- リリース(マイルストーン対応)
|
|
84
|
+
- イテレーション番号
|
|
85
|
+
- 優先度(必須/重要)
|
|
86
|
+
- ストーリーポイント
|
|
87
|
+
- カテゴリ
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
# フィールド値の一括設定
|
|
91
|
+
/plan-github --fields
|
|
92
|
+
「release_plan.md の内容で Project フィールドを更新して」
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
#### Milestone の作成
|
|
96
|
+
|
|
97
|
+
リリースを GitHub Milestone として作成し、Issue に割り当てます。
|
|
98
|
+
|
|
99
|
+
**作成される Milestone**:
|
|
100
|
+
|
|
101
|
+
- **リリース 1.0 MVP**: 基本的な仕訳入力と元帳管理
|
|
102
|
+
- **リリース 2.0 機能拡張版**: 承認ワークフローと財務諸表
|
|
103
|
+
- **リリース 3.0 完成版**: 高度な分析機能とシステム管理
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
# Milestone の作成と Issue 割り当て
|
|
107
|
+
/plan-github --milestones
|
|
108
|
+
「リリースを Milestone として作成して Issue に割り当てて」
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
#### 差異確認
|
|
112
|
+
|
|
113
|
+
release_plan.md と GitHub Issue/Project の整合性を確認します。
|
|
114
|
+
|
|
115
|
+
**確認項目**:
|
|
116
|
+
|
|
117
|
+
- ストーリー数の一致
|
|
118
|
+
- ストーリーポイントの一致
|
|
119
|
+
- リリース/Milestone 割り当ての一致
|
|
120
|
+
- 優先度の一致
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
# 差異確認
|
|
124
|
+
/plan-github --verify
|
|
125
|
+
「release_plan.md と GitHub の差異がないか確認して」
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### 出力例
|
|
129
|
+
|
|
130
|
+
```
|
|
131
|
+
📊 GitHub Project 同期結果
|
|
132
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
133
|
+
|
|
134
|
+
🎯 Project: 会計システムのケーススタディ
|
|
135
|
+
URL: https://github.com/users/k2works/projects/8
|
|
136
|
+
|
|
137
|
+
📋 Issue 作成状況
|
|
138
|
+
├─ 認証・ユーザー管理: 6件(21SP)
|
|
139
|
+
├─ マスタ管理: 8件(29SP)
|
|
140
|
+
├─ 仕訳管理: 10件(45SP)
|
|
141
|
+
├─ 元帳・残高管理: 5件(26SP)
|
|
142
|
+
├─ 財務諸表: 3件(21SP)
|
|
143
|
+
└─ システム管理: 2件(13SP)
|
|
144
|
+
合計: 34件(155SP)
|
|
145
|
+
|
|
146
|
+
🏁 Milestone 割り当て
|
|
147
|
+
├─ リリース 1.0 MVP: 14件(期日: 2026-02-27)
|
|
148
|
+
├─ リリース 2.0 機能拡張版: 12件(期日: 2026-04-24)
|
|
149
|
+
└─ リリース 3.0 完成版: 8件(期日: 2026-06-19)
|
|
150
|
+
|
|
151
|
+
✅ 差異確認: release_plan.md と完全一致
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### Claude との連携
|
|
155
|
+
|
|
156
|
+
```bash
|
|
157
|
+
# リリース計画から完全同期
|
|
158
|
+
cat docs/development/release_plan.md
|
|
159
|
+
/plan-github
|
|
160
|
+
「このリリース計画を GitHub Project に完全同期して」
|
|
161
|
+
|
|
162
|
+
# 計画更新後の差異確認と同期
|
|
163
|
+
cat docs/development/release_plan.md
|
|
164
|
+
/plan-github --verify
|
|
165
|
+
「更新したリリース計画と GitHub の差異を確認して」
|
|
166
|
+
|
|
167
|
+
# 既存 Project へのフィールド更新
|
|
168
|
+
/plan-github --fields
|
|
169
|
+
「release_plan.md の最新内容で Project フィールドを更新して」
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### 注意事項
|
|
173
|
+
|
|
174
|
+
- **前提条件**:
|
|
175
|
+
- `docs/development/release_plan.md` が存在すること
|
|
176
|
+
- `gh` CLI がインストールされ認証済みであること
|
|
177
|
+
- Project API スコープが有効であること(`gh auth refresh -s project,read:project`)
|
|
178
|
+
- **制限事項**:
|
|
179
|
+
- 既存の Project/Issue がある場合は重複作成に注意
|
|
180
|
+
- フィールド値の更新は既存値を上書き
|
|
181
|
+
- **推奨事項**:
|
|
182
|
+
- 初回は `--verify` で差異確認してから同期
|
|
183
|
+
- 大規模な変更前にはバックアップを推奨
|
|
184
|
+
|
|
185
|
+
### ベストプラクティス
|
|
186
|
+
|
|
187
|
+
1. **初回同期**: `/plan-github` で全体を一括作成
|
|
188
|
+
2. **計画更新時**: `/plan-github --verify` で差異確認後、必要な部分のみ更新
|
|
189
|
+
3. **定期確認**: `/plan-github --status` で進捗状況を定期的に確認
|
|
190
|
+
4. **一貫性維持**: release_plan.md を Single Source of Truth として管理
|
|
191
|
+
|
|
192
|
+
### 同期フロー
|
|
193
|
+
|
|
194
|
+
```mermaid
|
|
195
|
+
graph TD
|
|
196
|
+
A[release_plan.md] --> B{/plan-github}
|
|
197
|
+
B --> C[GitHub Project 作成]
|
|
198
|
+
C --> D[カスタムフィールド設定]
|
|
199
|
+
D --> E[Issue 作成]
|
|
200
|
+
E --> F[Project にItem追加]
|
|
201
|
+
F --> G[フィールド値設定]
|
|
202
|
+
G --> H[Milestone 作成]
|
|
203
|
+
H --> I[Issue に Milestone 割当]
|
|
204
|
+
I --> J[差異確認]
|
|
205
|
+
J --> K[同期完了]
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### 関連コマンド
|
|
209
|
+
|
|
210
|
+
- `/plan` : リリース計画とイテレーション計画の作成
|
|
211
|
+
- `/progress` : 進捗状況の確認と更新
|
|
212
|
+
- `/git-commit` : 変更のコミット
|
|
@@ -191,6 +191,23 @@ cat retrospective_notes.md
|
|
|
191
191
|
- **前提条件**: 要件定義書またはユーザーストーリーが存在すること
|
|
192
192
|
- **制限事項**: 初回ベロシティは推測値のため、3イテレーション後に再調整推奨
|
|
193
193
|
- **推奨事項**: 各イテレーション終了時に計画を更新し、生きた文書として管理
|
|
194
|
+
- 以下の記述ルールに従うこと
|
|
195
|
+
- タスク項目などは一行開けて記述する
|
|
196
|
+
- NG
|
|
197
|
+
```markdown
|
|
198
|
+
**受入条件**:
|
|
199
|
+
- [ ] ログアウトボタンをクリックするとログアウトできる
|
|
200
|
+
- [ ] ログアウト後、ログイン画面に遷移する
|
|
201
|
+
- [ ] JWT トークンが無効化される
|
|
202
|
+
```
|
|
203
|
+
- OK
|
|
204
|
+
```markdown
|
|
205
|
+
**受入条件**:
|
|
206
|
+
|
|
207
|
+
- [ ] ログアウトボタンをクリックするとログアウトできる
|
|
208
|
+
- [ ] ログアウト後、ログイン画面に遷移する
|
|
209
|
+
- [ ] JWT トークンが無効化される
|
|
210
|
+
```
|
|
194
211
|
|
|
195
212
|
### ベストプラクティス
|
|
196
213
|
|
|
@@ -1,164 +1,7 @@
|
|
|
1
1
|
{
|
|
2
|
-
"cleanupPeriodDays": 30,
|
|
3
|
-
"env": {
|
|
4
|
-
"BASH_DEFAULT_TIMEOUT_MS": "600000",
|
|
5
|
-
"BASH_MAX_TIMEOUT_MS": "600000",
|
|
6
|
-
"CLAUDE_BASH_MAINTAIN_PROJECT_WORKING_DIR": "true",
|
|
7
|
-
"SHELL": "/opt/homebrew/bin/zsh"
|
|
8
|
-
},
|
|
9
|
-
"includeCoAuthoredBy": false,
|
|
10
2
|
"permissions": {
|
|
11
|
-
"allow": [
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
"Glob(**)",
|
|
15
|
-
"GlobTool(**)",
|
|
16
|
-
"Grep(**)",
|
|
17
|
-
"GrepTool(**)",
|
|
18
|
-
"LS(**)",
|
|
19
|
-
"MultiEdit(**)",
|
|
20
|
-
"Read(**)",
|
|
21
|
-
"TodoRead()",
|
|
22
|
-
"TodoWrite(**)",
|
|
23
|
-
"WebFetch(domain:*)",
|
|
24
|
-
"WebSearch(**)",
|
|
25
|
-
"Write(**)"
|
|
26
|
-
],
|
|
27
|
-
"deny": [
|
|
28
|
-
"Bash(* | bash)",
|
|
29
|
-
"Bash(* | sh)",
|
|
30
|
-
"Bash(:(){ :|:& };:)",
|
|
31
|
-
"Bash(> /dev/sda*)",
|
|
32
|
-
"Bash(apt-get install*)",
|
|
33
|
-
"Bash(brew install*)",
|
|
34
|
-
"Bash(bundle install*)",
|
|
35
|
-
"Bash(chmod -R 777*)",
|
|
36
|
-
"Bash(chmod 777*)",
|
|
37
|
-
"Bash(chown -R*)",
|
|
38
|
-
"Bash(dd*)",
|
|
39
|
-
"Bash(format*)",
|
|
40
|
-
"Bash(gem install*)",
|
|
41
|
-
"Bash(gh api --method DELETE*)",
|
|
42
|
-
"Bash(gh auth logout*)",
|
|
43
|
-
"Bash(gh auth refresh*)",
|
|
44
|
-
"Bash(gh gist create*)",
|
|
45
|
-
"Bash(gh gist delete*)",
|
|
46
|
-
"Bash(gh gpg-key add*)",
|
|
47
|
-
"Bash(gh gpg-key delete*)",
|
|
48
|
-
"Bash(gh release create*)",
|
|
49
|
-
"Bash(gh release delete*)",
|
|
50
|
-
"Bash(gh release upload*)",
|
|
51
|
-
"Bash(gh repo archive*)",
|
|
52
|
-
"Bash(gh repo clone*)",
|
|
53
|
-
"Bash(gh repo create*)",
|
|
54
|
-
"Bash(gh repo delete*)",
|
|
55
|
-
"Bash(gh repo deploy-key*)",
|
|
56
|
-
"Bash(gh repo edit*)",
|
|
57
|
-
"Bash(gh repo fork*)",
|
|
58
|
-
"Bash(gh repo rename*)",
|
|
59
|
-
"Bash(gh repo sync*)",
|
|
60
|
-
"Bash(gh repo unarchive*)",
|
|
61
|
-
"Bash(gh secret delete*)",
|
|
62
|
-
"Bash(gh secret set*)",
|
|
63
|
-
"Bash(gh ssh-key add*)",
|
|
64
|
-
"Bash(gh ssh-key delete*)",
|
|
65
|
-
"Bash(gh workflow disable*)",
|
|
66
|
-
"Bash(gh workflow enable*)",
|
|
67
|
-
"Bash(gh workflow run:*)",
|
|
68
|
-
"Bash(git checkout*)",
|
|
69
|
-
"Bash(git config*)",
|
|
70
|
-
"Bash(git rebase*)",
|
|
71
|
-
"Bash(git reset --hard*)",
|
|
72
|
-
"Bash(git restore*)",
|
|
73
|
-
"Bash(mkfs*)",
|
|
74
|
-
"Bash(npm install -g*)",
|
|
75
|
-
"Bash(pip install*)",
|
|
76
|
-
"Bash(rm -rf ../*)",
|
|
77
|
-
"Bash(rm -rf /)",
|
|
78
|
-
"Bash(rm -rf /*)",
|
|
79
|
-
"Bash(rm -rf ~/*)",
|
|
80
|
-
"Bash(sudo*)",
|
|
81
|
-
"Bash(yum install*)"
|
|
82
|
-
]
|
|
83
|
-
},
|
|
84
|
-
"hooks": {
|
|
85
|
-
"PreToolUse": [
|
|
86
|
-
{
|
|
87
|
-
"matcher": "Bash",
|
|
88
|
-
"hooks": [
|
|
89
|
-
{
|
|
90
|
-
"type": "command",
|
|
91
|
-
"command": "~/.claude/scripts/deny-check.sh"
|
|
92
|
-
},
|
|
93
|
-
{
|
|
94
|
-
"type": "command",
|
|
95
|
-
"command": "~/.claude/scripts/check-ai-commit.sh"
|
|
96
|
-
}
|
|
97
|
-
]
|
|
98
|
-
},
|
|
99
|
-
{
|
|
100
|
-
"matcher": "Write|Edit|MultiEdit",
|
|
101
|
-
"hooks": [
|
|
102
|
-
{
|
|
103
|
-
"type": "command",
|
|
104
|
-
"command": "~/.claude/scripts/preserve-file-permissions.sh"
|
|
105
|
-
}
|
|
106
|
-
]
|
|
107
|
-
}
|
|
108
|
-
],
|
|
109
|
-
"PostToolUse": [
|
|
110
|
-
{
|
|
111
|
-
"matcher": "Edit|Write|MultiEdit",
|
|
112
|
-
"hooks": [
|
|
113
|
-
{
|
|
114
|
-
"type": "command",
|
|
115
|
-
"command": "~/.claude/scripts/ja-space-format.sh"
|
|
116
|
-
},
|
|
117
|
-
{
|
|
118
|
-
"type": "command",
|
|
119
|
-
"command": "~/.claude/scripts/auto-comment.sh"
|
|
120
|
-
}
|
|
121
|
-
]
|
|
122
|
-
},
|
|
123
|
-
{
|
|
124
|
-
"matcher": "Edit|Write|MultiEdit",
|
|
125
|
-
"hooks": [
|
|
126
|
-
{
|
|
127
|
-
"type": "command",
|
|
128
|
-
"command": "~/.claude/scripts/preserve-file-permissions.sh"
|
|
129
|
-
}
|
|
130
|
-
]
|
|
131
|
-
}
|
|
132
|
-
],
|
|
133
|
-
"Notification": [
|
|
134
|
-
{
|
|
135
|
-
"matcher": "*",
|
|
136
|
-
"hooks": [
|
|
137
|
-
{
|
|
138
|
-
"type": "command",
|
|
139
|
-
"command": "osascript -e 'display notification \"Awaiting confirmation\" with title \"Claude Code\"' && afplay -v 0.3 ~/.claude/assets/confirm.mp3"
|
|
140
|
-
}
|
|
141
|
-
]
|
|
142
|
-
}
|
|
143
|
-
],
|
|
144
|
-
"Stop": [
|
|
145
|
-
{
|
|
146
|
-
"matcher": "*",
|
|
147
|
-
"hooks": [
|
|
148
|
-
{
|
|
149
|
-
"type": "command",
|
|
150
|
-
"command": "~/.claude/scripts/check-continue.sh"
|
|
151
|
-
},
|
|
152
|
-
{
|
|
153
|
-
"type": "command",
|
|
154
|
-
"command": "osascript -e 'display notification \"Task completed\" with title \"Claude Code\"' && afplay -v 0.3 ~/.claude/assets/perfect.mp3"
|
|
155
|
-
}
|
|
156
|
-
]
|
|
157
|
-
}
|
|
158
|
-
]
|
|
159
|
-
},
|
|
160
|
-
"statusLine": {
|
|
161
|
-
"type": "command",
|
|
162
|
-
"command": "~/.claude/scripts/statusline.sh"
|
|
3
|
+
"allow": [],
|
|
4
|
+
"deny": [],
|
|
5
|
+
"ask": []
|
|
163
6
|
}
|
|
164
7
|
}
|
package/lib/assets/README.md
CHANGED
|
@@ -156,7 +156,7 @@ GHCR からイメージを取得して実行するには:
|
|
|
156
156
|
docker pull ghcr.io/k2works/{project_name}:latest
|
|
157
157
|
|
|
158
158
|
# または特定バージョン
|
|
159
|
-
docker pull ghcr.io/k2works/
|
|
159
|
+
docker pull ghcr.io/k2works/{project_name}:0.0.1
|
|
160
160
|
|
|
161
161
|
# コンテナを実行
|
|
162
162
|
docker run -it -v $(pwd):/srv ghcr.io/k2works/{project_name}:latest
|
|
@@ -2,7 +2,7 @@ services:
|
|
|
2
2
|
mkdocs:
|
|
3
3
|
build:
|
|
4
4
|
context: .
|
|
5
|
-
dockerfile: ./
|
|
5
|
+
dockerfile: ./ops/docker/mkdoc/Dockerfile
|
|
6
6
|
environment:
|
|
7
7
|
PLANTUML_SERVER_URL: http://plantuml:8080/plantuml
|
|
8
8
|
volumes:
|
|
@@ -12,7 +12,7 @@ services:
|
|
|
12
12
|
- ./site:/docs/site
|
|
13
13
|
ports:
|
|
14
14
|
- "8000:8000"
|
|
15
|
-
command: mkdocs serve --dev-addr=0.0.0.0:8000
|
|
15
|
+
command: mkdocs serve --dev-addr=0.0.0.0:8000 --livereload
|
|
16
16
|
links:
|
|
17
17
|
- plantuml
|
|
18
18
|
|
package/lib/assets/gulpfile.js
CHANGED
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
*/
|
|
6
6
|
|
|
7
7
|
import gulp from 'gulp';
|
|
8
|
-
import mkdocsTasks from './scripts/mkdocs.js';
|
|
9
|
-
import journalTasks from './scripts/journal.js';
|
|
8
|
+
import mkdocsTasks from './ops/scripts/mkdocs.js';
|
|
9
|
+
import journalTasks from './ops/scripts/journal.js';
|
|
10
10
|
|
|
11
11
|
// Load gulp tasks from script modules
|
|
12
12
|
mkdocsTasks(gulp);
|
package/lib/assets/mkdocs.yml
CHANGED
|
@@ -26,8 +26,14 @@ export default function (gulp) {
|
|
|
26
26
|
try {
|
|
27
27
|
console.log('Starting MkDocs server using Docker Compose...');
|
|
28
28
|
|
|
29
|
+
// Normalize DOCKER_HOST on Windows if it's incorrect
|
|
30
|
+
const env = { ...process.env };
|
|
31
|
+
if (isWindows && env.DOCKER_HOST === 'npipe://./pipe/docker_engine') {
|
|
32
|
+
env.DOCKER_HOST = 'npipe:////./pipe/docker_engine';
|
|
33
|
+
}
|
|
34
|
+
|
|
29
35
|
// Execute docker-compose up command to start mkdocs service
|
|
30
|
-
execSync('docker compose up -d mkdocs', {stdio: 'inherit'});
|
|
36
|
+
execSync('docker compose up -d mkdocs', {stdio: 'inherit', env});
|
|
31
37
|
|
|
32
38
|
console.log('\nMkDocs server started successfully!');
|
|
33
39
|
console.log('Documentation is now available at http://localhost:8000');
|
|
@@ -45,11 +51,17 @@ export default function (gulp) {
|
|
|
45
51
|
try {
|
|
46
52
|
console.log('Building MkDocs documentation...');
|
|
47
53
|
|
|
54
|
+
// Normalize DOCKER_HOST on Windows if it's incorrect
|
|
55
|
+
const env = { ...process.env };
|
|
56
|
+
if (isWindows && env.DOCKER_HOST === 'npipe://./pipe/docker_engine') {
|
|
57
|
+
env.DOCKER_HOST = 'npipe:////./pipe/docker_engine';
|
|
58
|
+
}
|
|
59
|
+
|
|
48
60
|
// Remove existing site directory before building
|
|
49
61
|
removeSiteDirectory();
|
|
50
62
|
|
|
51
63
|
// Execute docker-compose run command to build mkdocs documentation
|
|
52
|
-
execSync('docker compose run --rm mkdocs mkdocs build', {stdio: 'inherit'});
|
|
64
|
+
execSync('docker compose run --rm mkdocs mkdocs build', {stdio: 'inherit', env});
|
|
53
65
|
|
|
54
66
|
console.log('\nMkDocs documentation built successfully!');
|
|
55
67
|
|
|
@@ -65,8 +77,14 @@ export default function (gulp) {
|
|
|
65
77
|
try {
|
|
66
78
|
console.log('Stopping MkDocs server...');
|
|
67
79
|
|
|
80
|
+
// Normalize DOCKER_HOST on Windows if it's incorrect
|
|
81
|
+
const env = { ...process.env };
|
|
82
|
+
if (isWindows && env.DOCKER_HOST === 'npipe://./pipe/docker_engine') {
|
|
83
|
+
env.DOCKER_HOST = 'npipe:////./pipe/docker_engine';
|
|
84
|
+
}
|
|
85
|
+
|
|
68
86
|
// Execute docker-compose down command to stop mkdocs service
|
|
69
|
-
execSync('docker compose down', {stdio: 'inherit'});
|
|
87
|
+
execSync('docker compose down', {stdio: 'inherit', env});
|
|
70
88
|
|
|
71
89
|
console.log('MkDocs server stopped successfully!');
|
|
72
90
|
|
package/package.json
CHANGED
|
File without changes
|
|
File without changes
|