File size: 4,607 Bytes
7acbd80 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | """Tests for website/scripts/generate-skill-docs.py.
The generator turns every `skills/**/SKILL.md` into a Docusaurus page before
the `docs-site-checks` CI workflow runs `ascii-guard lint` on the result. If
a SKILL.md contains ASCII diagrams (box-drawing chars in a fenced code block)
without its own `<!-- ascii-guard-ignore -->` markers, the generator must
add them defensively — otherwise every PR touching `website/**` fails lint
on unrelated skill content.
Regression for issue #15305.
"""
from __future__ import annotations
import importlib.util
from pathlib import Path
import pytest
REPO_ROOT = Path(__file__).resolve().parents[2]
GENERATOR = REPO_ROOT / "website" / "scripts" / "generate-skill-docs.py"
@pytest.fixture(scope="module")
def gen_module():
"""Load generate-skill-docs.py as a module (hyphenated filename, not importable via normal import)."""
spec = importlib.util.spec_from_file_location("generate_skill_docs", GENERATOR)
assert spec is not None and spec.loader is not None
module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(module)
return module
def test_code_block_without_box_chars_is_not_wrapped(gen_module):
"""Plain bash/python code blocks should stay uncluttered."""
body = "Intro.\n\n```bash\npip install foo\nfoo --run\n```\n\nOutro."
result = gen_module.mdx_escape_body(body)
assert "ascii-guard-ignore" not in result
assert "pip install foo" in result
def test_code_block_with_box_chars_gets_wrapped(gen_module):
"""A code fence containing Unicode box-drawing chars must be wrapped in
ascii-guard-ignore comments so the docs-site-checks lint can't fail on
a skill's own diagram (issue #15305)."""
body = (
"Some text.\n\n"
"```\n"
"┌─────────┐\n"
"│ diagram │\n"
"└─────────┘\n"
"```\n\n"
"More text."
)
result = gen_module.mdx_escape_body(body)
assert "<!-- ascii-guard-ignore -->" in result
assert "<!-- ascii-guard-ignore-end -->" in result
# The wrapper must sit OUTSIDE the fence, not inside.
wrap_open = result.index("<!-- ascii-guard-ignore -->")
fence_open = result.index("```\n┌")
assert wrap_open < fence_open
def test_multiple_code_blocks_only_box_ones_wrapped(gen_module):
"""Mixed body: plain code stays plain, box code gets wrapped."""
body = (
"```bash\necho hi\n```\n\n"
"```\n┌──┐\n│ │\n└──┘\n```\n\n"
"```python\nprint('ok')\n```"
)
result = gen_module.mdx_escape_body(body)
# exactly one wrap pair
assert result.count("<!-- ascii-guard-ignore -->") == 1
assert result.count("<!-- ascii-guard-ignore-end -->") == 1
# plain blocks untouched
assert "echo hi" in result
assert "print('ok')" in result
def test_tilde_fenced_box_is_wrapped(gen_module):
"""The generator supports both ``` and ~~~ fences — both must be covered."""
body = "~~~\n│ box │\n~~~"
result = gen_module.mdx_escape_body(body)
assert "<!-- ascii-guard-ignore -->" in result
def test_already_wrapped_source_double_wraps_harmlessly(gen_module):
"""If the SKILL.md already has ascii-guard-ignore markers, the generator's
extra wrap is harmless (ascii-guard tolerates adjacent duplicate markers).
The test just verifies we don't crash and the content survives."""
body = (
"<!-- ascii-guard-ignore -->\n"
"```\n┌─┐\n└─┘\n```\n"
"<!-- ascii-guard-ignore-end -->"
)
result = gen_module.mdx_escape_body(body)
assert "┌─┐" in result
# At least one marker pair survives
assert "<!-- ascii-guard-ignore -->" in result
assert "<!-- ascii-guard-ignore-end -->" in result
def test_box_drawing_detection_covers_common_chars(gen_module):
"""Smoke-test that the char set covers box-drawing ranges actually used
in skill diagrams."""
# Sample from real SKILL.md diagrams (segment-anything, research-paper-writing, etc.)
for ch in "┌┐└┘─│├┤┬┴┼═║╔╗╚╝╭╮╯╰▶◀▲▼":
assert ch in gen_module._BOX_DRAWING_CHARS, f"missing: {ch!r}"
def test_bundled_catalog_explains_missing_local_skills(gen_module):
"""The bundled catalog should explain how to restore a listed skill that
was removed from the local profile's skills tree."""
result = gen_module.build_catalog_md_bundled([])
assert "respects local deletions and user edits" in result
assert "hermes skills reset <name> --restore" in result
|