mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-11-12 14:00:35 +00:00
6fe87b65fa
* feat(extensions): show package-owned usage in extension details * test(extensions): align bookmark checks with detail UI * fix(extensions): reconcile package documentation and locale fallbacks * fix(extensions): align discovery locale fallback * fix(extensions): isolate malformed optional documentation * docs: keep backend guidance within inherited budget
48 lines
1.7 KiB
Python
48 lines
1.7 KiB
Python
"""Validate package documentation and regenerate the frontend's discovery copy."""
|
|
|
|
import argparse
|
|
import json
|
|
import runpy
|
|
from pathlib import Path
|
|
|
|
ROOT = Path(__file__).resolve().parents[1]
|
|
CONTRACT = runpy.run_path(
|
|
str(ROOT / "backend/packages/harness/deerflow/extensions/documentation.py")
|
|
)
|
|
VALIDATE = CONTRACT["validate_documentation"]
|
|
MAX_BYTES = CONTRACT["MAX_BYTES"]
|
|
DESTINATION = ROOT / "frontend/src/core/extensions/bundled-documentation.json"
|
|
|
|
|
|
def render():
|
|
pages = {}
|
|
for path in sorted(
|
|
(ROOT / "examples").glob("deerflow-extension-*/*/deerflow-extension.json")
|
|
):
|
|
raw = path.read_bytes()
|
|
if len(raw) > MAX_BYTES:
|
|
raise ValueError(f"Documentation is too large: {path}")
|
|
page = VALIDATE(json.loads(raw))
|
|
languages = {tag.lower().split("-")[0] for tag in page["locales"]}
|
|
if not {"en", "zh"}.issubset(languages):
|
|
raise ValueError(f"Bundled documentation requires English and Chinese: {path}")
|
|
if any(existing["id"] == page["id"] for existing in pages.values()):
|
|
raise ValueError(f"Duplicate extension documentation id: {page['id']}")
|
|
pages[path.parent.parent.name] = page
|
|
return json.dumps(pages, ensure_ascii=False, indent=2) + "\n"
|
|
|
|
|
|
if __name__ == "__main__":
|
|
parser = argparse.ArgumentParser(description=__doc__)
|
|
parser.add_argument("--check", action="store_true")
|
|
args = parser.parse_args()
|
|
content = render()
|
|
if args.check:
|
|
if DESTINATION.read_text(encoding="utf-8") != content:
|
|
parser.exit(
|
|
1,
|
|
"Extension copy is stale; run python scripts/sync_extension_documentation.py\n",
|
|
)
|
|
else:
|
|
DESTINATION.write_text(content, encoding="utf-8")
|