quickdbd-cli 0.4.2__tar.gz → 0.5.0__tar.gz

{quickdbd_cli-0.4.2 → quickdbd_cli-0.5.0}/.gitignore

@@ -223,3 +223,6 @@ __marimo__/
 site/
 jaffle-erd/
 graphify-out/
+
+# Hallmark design-lint records and screenshots
+.hallmark/

{quickdbd_cli-0.4.2 → quickdbd_cli-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: quickdbd-cli
-Version: 0.4.2
+Version: 0.5.0
 Summary: Compile QuickDBD-syntax schema files into interactive HTML ER diagrams, with no table limit.
 Project-URL: Homepage, https://qdbd.dev/
 Project-URL: Documentation, https://qdbd.dev/guide/
@@ -193,7 +193,7 @@ jobs:
     permissions: { contents: read, pull-requests: write }
     steps:
       - uses: actions/checkout@v4
-      - uses: MarkPhamm/quickdbd-cli@v0.4.2
+      - uses: MarkPhamm/quickdbd-cli@v0.5.0
         with:
           path: erd/                  # schema file(s) or folder(s)
           output: site/index.html

{quickdbd_cli-0.4.2 → quickdbd_cli-0.5.0}/README.md

@@ -155,7 +155,7 @@ jobs:
     permissions: { contents: read, pull-requests: write }
     steps:
       - uses: actions/checkout@v4
-      - uses: MarkPhamm/quickdbd-cli@v0.4.2
+      - uses: MarkPhamm/quickdbd-cli@v0.5.0
         with:
           path: erd/                  # schema file(s) or folder(s)
           output: site/index.html

{quickdbd_cli-0.4.2 → quickdbd_cli-0.5.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "quickdbd-cli"
-version = "0.4.2"
+version = "0.5.0"
 description = "Compile QuickDBD-syntax schema files into interactive HTML ER diagrams, with no table limit."
 readme = "README.md"
 license = "Apache-2.0"

{quickdbd_cli-0.4.2 → quickdbd_cli-0.5.0}/scripts/gen_thumbnails.py

@@ -42,7 +42,7 @@ body {{ width: {w}px; height: {h}px; overflow: hidden; font-family: Geist, Inter
 .text {{ position: absolute; left: 56px; top: 60px; width: 360px; }}
 .brand {{ display: flex; align-items: center; gap: 10px; font-weight: 600; font-size: 26px; letter-spacing: -.02em;
   margin-bottom: 40px; }}
-.brand svg {{ color: #2f5bea; }}
+.brand svg {{ color: #2b5797; }}
 .brand span {{ font: 16px "Geist Mono", monospace; color: #646a75; border: 1px solid rgba(21, 24, 30, .24);
   border-radius: 6px; padding: 3px 8px; margin-left: 4px; letter-spacing: 0; }}
 h1 {{ font-size: 48px; line-height: 1.04; font-weight: 600; letter-spacing: -.04em; }}

quickdbd_cli-0.5.0/src/quickdbd_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.5.0"

{quickdbd_cli-0.4.2 → quickdbd_cli-0.5.0}/src/quickdbd_cli/assets/icon.svg

@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><rect width="128" height="128" rx="28" fill="#2563eb"/><rect x="22" y="22" width="42" height="36" rx="9" fill="#fff"/><path d="M44 58v19a10 10 0 0 0 10 10h12" fill="none" stroke="#fff" stroke-width="8"/><rect x="64" y="70" width="42" height="33" rx="8" fill="#a8c1f7"/></svg>
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><rect width="128" height="128" rx="28" fill="#2b5797"/><rect x="22" y="22" width="42" height="36" rx="9" fill="#fff"/><path d="M44 58v19a10 10 0 0 0 10 10h12" fill="none" stroke="#fff" stroke-width="8"/><rect x="64" y="70" width="42" height="33" rx="8" fill="#a9bfdd"/></svg>

{quickdbd_cli-0.4.2 → quickdbd_cli-0.5.0}/src/quickdbd_cli/assets/style.css

@@ -34,8 +34,8 @@
   --t-edge: #b8bcc2;
   --row-hl: #dbe6f6;
   --row-hover: #eef3fa;
-  --lit: #4361ee;
-  --lit-deep: #2a3fb8;
+  --lit: #2b5797;
+  --lit-deep: #1c3a66;
 }
 /* Dark theme. viewer.js sets data-theme from the toggle, or from prefers-color-scheme when it's on auto. */
 :root[data-theme="dark"] {

{quickdbd_cli-0.4.2 → quickdbd_cli-0.5.0}/src/quickdbd_cli/cli.py

@@ -32,11 +32,12 @@ def _open(args) -> Project:
     return Project.open([Path(p) for p in args.paths], Path(args.layout) if getattr(args, "layout", None) else None)
 
 
+def _name(p: Path) -> str:
+    return p.stem if p.is_file() else (p.resolve().name or "diagram")
+
+
 def _title(project: Project) -> str:
-    if len(project.inputs) == 1:
-        p = project.inputs[0]
-        return p.stem if p.is_file() else (p.resolve().name or "diagram")
-    return "diagram"
+    return _name(project.inputs[0]) if len(project.inputs) == 1 else "diagram"
 
 
 def _github_annotation(d: Diagnostic, level: str) -> str:
@@ -76,7 +77,30 @@ def _symbols(schema: Schema) -> dict:
     return {"tables": tables, "rels": rels}
 
 
+def _check_each(args) -> int:
+    """Check each PATH on its own, as ``build --site`` builds them; folders with no schema files are skipped."""
+    from .project import discover
+
+    if args.format == "json" or args.stdin_file:
+        print("error: --each can't be used with --format json or --stdin-file", file=sys.stderr)
+        return 2
+    code, checked = 0, 0
+    for p in args.paths:
+        if Path(p).is_dir() and not discover([Path(p)]):
+            print(f"Skipped {p}: no .txt or .dbml schema files", file=sys.stderr)
+            continue
+        print(f"{p}:")
+        code = max(code, cmd_check(argparse.Namespace(**{**vars(args), "paths": [p], "each": False})))
+        checked += 1
+    if not checked:
+        print("error: no schema files found in: " + ", ".join(args.paths), file=sys.stderr)
+        return 2
+    return code
+
+
 def cmd_check(args) -> int:
+    if args.each:
+        return _check_each(args)
     project = _open(args)
     overrides = None
     if args.stdin_file:
@@ -143,7 +167,52 @@ def _built_page(args) -> tuple[str, dict] | int:
     return render_page(model, pos, _title(project)), model
 
 
+def _build_site(args) -> int:
+    """One page per PATH plus an index linking them, in the folder ``args.site``."""
+    from urllib.parse import quote
+
+    from .html import render_index
+    from .project import discover
+
+    if args.layout:
+        print("error: --layout can't be used with --site: each PATH uses its own layout file", file=sys.stderr)
+        return 2
+    pages, seen, failed = [], {}, 0
+    for p in map(Path, args.paths):
+        if p.is_dir() and not discover([p]):
+            print(f"Skipped {p}: no .txt or .dbml schema files", file=sys.stderr)
+            continue
+        name = _name(p)
+        if name.lower() in seen or name.lower() == "index":
+            other = seen.get(name.lower(), "the index page")
+            print(f"error: {p} and {other} would both be written to {name}.html", file=sys.stderr)
+            return 2
+        seen[name.lower()] = p
+        res = _built_page(argparse.Namespace(**{**vars(args), "paths": [str(p)]}))
+        if isinstance(res, int):
+            failed = max(failed, res)
+            continue
+        pages.append((name, *res))
+    if failed:  # nothing is written, so a failed build never leaves a half-updated site
+        return failed
+    if not pages:
+        print("error: no schema files found in: " + ", ".join(args.paths), file=sys.stderr)
+        return 2
+    out = Path(args.site)
+    out.mkdir(parents=True, exist_ok=True)
+    index = []
+    for name, page, model in pages:
+        (out / f"{name}.html").write_text(page, encoding="utf-8")
+        index.append((name, quote(f"{name}.html"), len(model["tables"]), len(model["rels"])))
+        print(f"Wrote {out / f'{name}.html'} ({len(model['tables'])} tables, {len(model['rels'])} relationships)")
+    (out / "index.html").write_text(render_index(index), encoding="utf-8")
+    print(f"Wrote {out / 'index.html'} ({len(pages)} diagrams)")
+    return 0
+
+
 def cmd_build(args) -> int:
+    if args.site:
+        return _build_site(args)
     res = _built_page(args)
     if isinstance(res, int):
         return res
@@ -575,11 +644,20 @@ def build_parser() -> argparse.ArgumentParser:
         metavar="PATH",
         help="read this schema file's text from stdin instead of disk (an editor's unsaved buffer)",
     )
+    sp.add_argument(
+        "--each",
+        action="store_true",
+        help="check each PATH as its own schema, as build --site does (folders with no schema files are skipped)",
+    )
     sp.set_defaults(func=cmd_check)
 
     sp = sub.add_parser("build", help="write an interactive HTML diagram")
     paths(sp)
-    sp.add_argument("-o", "--output", default="diagram.html")
+    out = sp.add_mutually_exclusive_group()
+    out.add_argument("-o", "--output", default="diagram.html")
+    out.add_argument(
+        "--site", metavar="DIR", help="one page per PATH (named after it) plus an index.html linking them, in DIR"
+    )
     selectors(sp)
     sp.add_argument(
         "--diff-base", metavar="GIT_REF", help="colour tables/columns changed since this git ref (e.g. origin/main)"

{quickdbd_cli-0.4.2 → quickdbd_cli-0.5.0}/src/quickdbd_cli/html.py

@@ -190,3 +190,28 @@ def render_page(
         f"<script>{_asset('viewer.js')}</script>"
         f"{scripts}</body></html>\n"
     )
+
+
+INDEX_CSS = (
+    ":root{color-scheme:light dark;--fg:#1f2328;--muted:#656d76;--bg:#fff;--line:#d0d7de}"
+    "@media (prefers-color-scheme:dark){:root{--fg:#e6edf3;--muted:#8d96a0;--bg:#0d1117;--line:#30363d}}"
+    "body{margin:0;background:var(--bg);color:var(--fg);font:15px/1.5 system-ui,sans-serif}"
+    "main{max-width:640px;margin:0 auto;padding:32px 16px}h1{font-size:20px;margin:0 0 16px}"
+    "ul{list-style:none;margin:0;padding:0}li{border-top:1px solid var(--line);padding:10px 0}"
+    "a{color:inherit;font-weight:600}span{color:var(--muted);margin-left:8px}"
+)
+
+
+def render_index(pages: list[tuple[str, str, int, int]], title: str = "Diagrams") -> str:
+    """``qdbd build --site``'s index: a link per (name, href, tables, relationships)."""
+    items = "".join(
+        f'<li><a href="{_escape(href)}">{_escape(name)}</a><span>{t} tables, {r} relationships</span></li>'
+        for name, href, t, r in pages
+    )
+    return (
+        '<!doctype html>\n<html lang="en"><head><meta charset="utf-8">'
+        '<meta name="viewport" content="width=device-width, initial-scale=1">'
+        '<meta name="generator" content="qdbd">'
+        f"{favicon()}<title>{_escape(title)}</title><style>{INDEX_CSS}</style></head>"
+        f"<body><main><h1>{_escape(title)}</h1><ul>{items}</ul></main></body></html>\n"
+    )

{quickdbd_cli-0.4.2 → quickdbd_cli-0.5.0}/tests/test_pipeline.py

@@ -252,6 +252,55 @@ def test_build_is_deterministic_and_does_not_write_sidecar(tmp_path):
     assert '<link rel="icon" href="data:image/svg+xml,%3Csvg ' in html
 
 
+def test_build_site_writes_a_page_per_path_and_an_index(tmp_path, capsys):
+    for name in ("sales", "hr"):
+        (tmp_path / "erd" / name).mkdir(parents=True)
+        (tmp_path / "erd" / name / "s.txt").write_text(SMALL)
+    (tmp_path / "erd" / "empty").mkdir()
+    site = tmp_path / "public"
+    dirs = [str(tmp_path / "erd" / n) for n in ("hr", "empty", "sales")]
+    assert main(["build", *dirs, "--site", str(site)]) == 0
+    assert sorted(f.name for f in site.iterdir()) == ["hr.html", "index.html", "sales.html"]
+    assert "<title>hr</title>" in (site / "hr.html").read_text()
+    index = (site / "index.html").read_text()
+    assert index.index('href="hr.html"') < index.index('href="sales.html"')
+    assert "2 tables, 1 relationships" in index
+    assert "Skipped" in capsys.readouterr().err
+
+
+def test_check_each_keeps_namespaces_apart(tmp_path, capsys):
+    for name in ("sales", "hr"):
+        (tmp_path / name).mkdir()
+        (tmp_path / name / "s.txt").write_text(SMALL)
+    (tmp_path / "empty").mkdir()
+    dirs = [str(tmp_path / n) for n in ("hr", "empty", "sales")]
+    assert main(["check", *dirs]) == 1  # one namespace: Customer and Order are duplicates
+    assert main(["check", "--each", *dirs]) == 0
+    assert main(["check", "--each", str(tmp_path / "empty")]) == 2
+    assert main(["check", "--each", "--format", "json", *dirs]) == 2
+    capsys.readouterr()
+
+
+def test_build_site_writes_nothing_when_a_schema_fails(tmp_path):
+    (tmp_path / "ok").mkdir()
+    (tmp_path / "ok" / "s.txt").write_text(SMALL)
+    (tmp_path / "bad").mkdir()
+    (tmp_path / "bad" / "s.txt").write_text("Order\n-\nId int FK >- Missing.Id\n")
+    site = tmp_path / "public"
+    assert main(["build", str(tmp_path / "ok"), str(tmp_path / "bad"), "--site", str(site)]) == 1
+    assert not site.exists()
+
+
+def test_build_site_refuses_clashing_names(tmp_path, capsys):
+    for d in ("a/sales", "b/sales"):
+        (tmp_path / d).mkdir(parents=True)
+        (tmp_path / d / "s.txt").write_text(SMALL)
+    assert main(["build", str(tmp_path / "a/sales"), str(tmp_path / "b/sales"), "--site", str(tmp_path / "o")]) == 2
+    assert "both be written to sales.html" in capsys.readouterr().err
+    with pytest.raises(SystemExit):
+        main(["build", str(tmp_path / "a/sales"), "-o", "x.html", "--site", str(tmp_path / "o")])
+
+
 def test_layout_command_writes_sidecar_and_reset(tmp_path):
     f = tmp_path / "s.txt"
     f.write_text(SMALL)

quickdbd_cli-0.4.2/src/quickdbd_cli/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.4.2"