sdd-flow-kit 1.0.6 → 1.0.7
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
CHANGED
|
@@ -14,14 +14,13 @@
|
|
|
14
14
|
#### 安装教程
|
|
15
15
|
|
|
16
16
|
1. 进入你要开发的项目目录
|
|
17
|
-
2. 安装:`pnpm add -D sdd-flow-kit
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
3.
|
|
22
|
-
-
|
|
23
|
-
|
|
24
|
-
- 会自动注入 `.opsx/config.json`(按所选工具写入 editor/skillsDir/commandsDir)
|
|
17
|
+
2. 安装:`pnpm add -D sdd-flow-kit `
|
|
18
|
+
检查是否安装 - `ls .cursor/skills/sdd-flow-kit/SKILL.md`
|
|
19
|
+
- `ls .claude/skills/sdd-flow-kit/SKILL.md`
|
|
20
|
+
- `ls docs/*-doc-skill/SKILL.md`
|
|
21
|
+
3. 若仍未生成,执行手动兜底(100%触发初始化):
|
|
22
|
+
- `node ./node_modules/sdd-flow-kit/dist/postinstall.js`
|
|
23
|
+
|
|
25
24
|
4. (可选)预演安装:`npx sdd-flow-kit install --dry-run --plan-json`
|
|
26
25
|
5. (可选)环境健检:`npx sdd-flow-kit doctor --agent claude-code`
|
|
27
26
|
6. 完成后,直接在 Cursor / Claude Code / Codex / OpenClaw 中用自然语言发起需求,例如:`开发 ADI 2.3.2 需求`
|
package/package.json
CHANGED
|
@@ -1,23 +1,5 @@
|
|
|
1
1
|
#!/usr/bin/env python3
|
|
2
|
-
"""
|
|
3
|
-
Confluence 需求文档获取脚本(Playwright)
|
|
4
|
-
|
|
5
|
-
用法:
|
|
6
|
-
python3 confluence-doc.py <版本号>
|
|
7
|
-
|
|
8
|
-
环境变量:
|
|
9
|
-
CONFLUENCE_BASE_URL 例如 https://confluence.huan.tv
|
|
10
|
-
CONFLUENCE_SEARCH_URL 例如 https://confluence.huan.tv/dosearchsite.action?includeArchivedSpaces=false
|
|
11
|
-
CONFLUENCE_USERNAME
|
|
12
|
-
CONFLUENCE_PASSWORD
|
|
13
|
-
DOC_PRODUCT_PREFIX 例如 ADI / OMS / HUAN / ADTOOLS
|
|
14
|
-
DOC_DOWNLOAD_DIR 输出目录(默认当前脚本所在目录的上级 docs/)
|
|
15
|
-
|
|
16
|
-
注意:
|
|
17
|
-
- 为安全起见,本模板不包含任何默认账号密码
|
|
18
|
-
- 你需要先安装 playwright:
|
|
19
|
-
pip install playwright && playwright install chromium
|
|
20
|
-
"""
|
|
2
|
+
"""Confluence 需求文档获取脚本(Playwright - 通用版)"""
|
|
21
3
|
|
|
22
4
|
import sys
|
|
23
5
|
import os
|
|
@@ -34,9 +16,9 @@ except ImportError:
|
|
|
34
16
|
|
|
35
17
|
def env(name: str, default: str | None = None) -> str:
|
|
36
18
|
v = os.environ.get(name, default)
|
|
37
|
-
if v is None
|
|
38
|
-
|
|
39
|
-
return str(v)
|
|
19
|
+
if v is None:
|
|
20
|
+
return ""
|
|
21
|
+
return str(v).strip()
|
|
40
22
|
|
|
41
23
|
|
|
42
24
|
def load_env_file(file_path: Path) -> None:
|
|
@@ -89,6 +71,11 @@ def parse_html_to_markdown(html_content: str) -> str:
|
|
|
89
71
|
md = re.sub(r"<li[^>]*>(.*?)</li>", r"- \1\n", md, flags=re.DOTALL | re.IGNORECASE)
|
|
90
72
|
md = re.sub(r'<a[^>]*href="([^"]+)"[^>]*>(.*?)</a>', r"[\2](\1)", md, flags=re.DOTALL | re.IGNORECASE)
|
|
91
73
|
md = re.sub(r'<img[^>]*src="([^"]+)"[^>]*>', r"", md, flags=re.DOTALL | re.IGNORECASE)
|
|
74
|
+
md = re.sub(r"<table[^>]*>", r"\n", md, flags=re.DOTALL | re.IGNORECASE)
|
|
75
|
+
md = re.sub(r"</table>", r"\n", md, flags=re.DOTALL | re.IGNORECASE)
|
|
76
|
+
md = re.sub(r"<tr[^>]*>", r"|", md, flags=re.DOTALL | re.IGNORECASE)
|
|
77
|
+
md = re.sub(r"</tr>", r"\n", md, flags=re.DOTALL | re.IGNORECASE)
|
|
78
|
+
md = re.sub(r"<t[dh][^>]*>(.*?)</t[dh]>", r"|\1", md, flags=re.DOTALL | re.IGNORECASE)
|
|
92
79
|
md = re.sub(r"<p[^>]*>(.*?)</p>", r"\1\n\n", md, flags=re.DOTALL | re.IGNORECASE)
|
|
93
80
|
md = re.sub(r"<br[^>]*>", r"\n", md, flags=re.DOTALL | re.IGNORECASE)
|
|
94
81
|
md = re.sub(r"<strong[^>]*>(.*?)</strong>", r"**\1**", md, flags=re.DOTALL | re.IGNORECASE)
|
|
@@ -167,20 +154,20 @@ def find_search_result(page, base_url: str, keyword: str):
|
|
|
167
154
|
return best
|
|
168
155
|
|
|
169
156
|
|
|
170
|
-
def run_search(page, base_url: str, keyword: str
|
|
171
|
-
page.goto(search_url, wait_until="networkidle", timeout=60000)
|
|
172
|
-
page.wait_for_timeout(800)
|
|
157
|
+
def run_search(page, base_url: str, keyword: str) -> str | None:
|
|
173
158
|
search_selector = None
|
|
174
159
|
for selector in ["#search-query-input", "input[name='search-query']", "input.search-query", "input[id*='search']"]:
|
|
175
160
|
if page.locator(selector).count() > 0:
|
|
176
161
|
search_selector = selector
|
|
177
162
|
break
|
|
178
163
|
if not search_selector:
|
|
164
|
+
if page.locator("input[type='text']").count() == 0:
|
|
165
|
+
return None
|
|
179
166
|
search_selector = "input[type='text']"
|
|
180
|
-
page.fill(search_selector, keyword)
|
|
167
|
+
page.fill(search_selector, keyword, timeout=8000)
|
|
181
168
|
page.keyboard.press("Enter")
|
|
182
169
|
page.wait_for_load_state("networkidle", timeout=30000)
|
|
183
|
-
page.wait_for_timeout(
|
|
170
|
+
page.wait_for_timeout(2000)
|
|
184
171
|
return find_search_result(page, base_url, keyword)
|
|
185
172
|
|
|
186
173
|
|
|
@@ -195,10 +182,10 @@ def main():
|
|
|
195
182
|
for env_name in [".env.pre", ".env", ".env.local", ".env.development", ".env.test"]:
|
|
196
183
|
load_env_file(repo_root / env_name)
|
|
197
184
|
|
|
198
|
-
base_url = env("CONFLUENCE_BASE_URL")
|
|
199
|
-
search_url = env("CONFLUENCE_SEARCH_URL"
|
|
200
|
-
username = env("CONFLUENCE_USERNAME")
|
|
201
|
-
password = env("CONFLUENCE_PASSWORD")
|
|
185
|
+
base_url = env("CONFLUENCE_BASE_URL", "https://confluence.huan.tv") or "https://confluence.huan.tv"
|
|
186
|
+
search_url = env("CONFLUENCE_SEARCH_URL") or f"{base_url.rstrip('/')}/dosearchsite.action?includeArchivedSpaces=false"
|
|
187
|
+
username = env("CONFLUENCE_USERNAME") or env("CONFLUENCE_USER")
|
|
188
|
+
password = env("CONFLUENCE_PASSWORD") or env("CONFLUENCE_PASS")
|
|
202
189
|
prefix = os.environ.get("DOC_PRODUCT_PREFIX", "{{DOC_PRODUCT_PREFIX}}").strip() or "{{DOC_PRODUCT_PREFIX}}"
|
|
203
190
|
version = normalize_version(sys.argv[1])
|
|
204
191
|
keywords = search_keywords(prefix, version)
|
|
@@ -221,23 +208,34 @@ def main():
|
|
|
221
208
|
|
|
222
209
|
with sync_playwright() as p:
|
|
223
210
|
browser = p.chromium.launch(headless=True)
|
|
224
|
-
context = browser.new_context(
|
|
211
|
+
context = browser.new_context(
|
|
212
|
+
user_agent=(
|
|
213
|
+
"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) "
|
|
214
|
+
"AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"
|
|
215
|
+
)
|
|
216
|
+
)
|
|
225
217
|
page = context.new_page()
|
|
226
218
|
try:
|
|
227
|
-
|
|
228
|
-
page.goto(search_url, wait_until="networkidle", timeout=60000)
|
|
219
|
+
print("\n📄 访问搜索页面...")
|
|
220
|
+
response = page.goto(search_url, wait_until="networkidle", timeout=60000)
|
|
221
|
+
if response:
|
|
222
|
+
print(f" 状态码: {response.status}")
|
|
229
223
|
if "login" in page.url.lower():
|
|
224
|
+
if not username or not password:
|
|
225
|
+
raise RuntimeError("检测到登录页但未提供 CONFLUENCE_USERNAME / CONFLUENCE_PASSWORD")
|
|
226
|
+
print("🔐 检测到需要登录,开始自动登录...")
|
|
230
227
|
page.wait_for_selector("#username-field", timeout=10000)
|
|
231
228
|
page.fill("#username-field", username)
|
|
232
229
|
page.fill("#password-field", password)
|
|
233
230
|
page.click("#login-button")
|
|
234
231
|
page.wait_for_load_state("networkidle", timeout=30000)
|
|
232
|
+
print("✅ 登录完成")
|
|
235
233
|
|
|
236
234
|
target_url = None
|
|
237
235
|
matched_keyword = None
|
|
238
236
|
for kw in keywords:
|
|
239
237
|
print(f"\n🔍 搜索关键词: {kw}")
|
|
240
|
-
found = run_search(page, base_url, kw
|
|
238
|
+
found = run_search(page, base_url, kw)
|
|
241
239
|
if found:
|
|
242
240
|
target_url = found
|
|
243
241
|
matched_keyword = kw
|
|
@@ -260,6 +258,8 @@ def main():
|
|
|
260
258
|
content_elem = page.locator("#main-content")
|
|
261
259
|
if not content_elem.count():
|
|
262
260
|
content_elem = page.locator(".wiki-content")
|
|
261
|
+
if not content_elem.count():
|
|
262
|
+
content_elem = page.locator(".content-body")
|
|
263
263
|
content_html = content_elem.inner_html() if content_elem.count() else ""
|
|
264
264
|
|
|
265
265
|
img_urls = re.findall(r'<img[^>]*src="([^"]+)"', content_html)
|
|
@@ -304,6 +304,9 @@ def main():
|
|
|
304
304
|
print("\n✅ 获取完成!")
|
|
305
305
|
print(f"📄 主文档: {md_path}")
|
|
306
306
|
print(f"🖼️ 图片目录: {version_dir}")
|
|
307
|
+
except Exception as e:
|
|
308
|
+
print(f"\n❌ 获取失败: {e}")
|
|
309
|
+
raise
|
|
307
310
|
finally:
|
|
308
311
|
browser.close()
|
|
309
312
|
|
|
@@ -21,7 +21,6 @@ description: |
|
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
23
|
cd docs/{{SKILL_DIR}}
|
|
24
|
-
export CONFLUENCE_BASE_URL="https://confluence.huan.tv"
|
|
25
24
|
export CONFLUENCE_USERNAME="<你的账号>"
|
|
26
25
|
export CONFLUENCE_PASSWORD="<你的密码>"
|
|
27
26
|
export DOC_PRODUCT_PREFIX="{{PRODUCT_PREFIX}}"
|
|
@@ -52,5 +51,6 @@ python3 confluence-doc.py {{PRODUCT_PREFIX}}_V1.2.3
|
|
|
52
51
|
- 依赖 Playwright:`pip install playwright && playwright install chromium`
|
|
53
52
|
- 脚本:`docs/{{SKILL_DIR}}/confluence-doc.py`
|
|
54
53
|
- 为安全起见,脚本不包含默认账号密码,请用环境变量注入
|
|
55
|
-
-
|
|
54
|
+
- 默认 Confluence 地址为 `https://confluence.huan.tv`(可用 `CONFLUENCE_BASE_URL` 覆盖)
|
|
55
|
+
- 脚本会自动尝试读取仓库根目录的 `.env.pre` / `.env` / `.env.local` / `.env.development` / `.env.test`(若其中存在 `CONFLUENCE_*` 配置可直接复用)
|
|
56
56
|
|