ruviz 0.4.2

High-performance 2D plotting library for Rust
Documentation 
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

#!/usr/bin/env python3
"""Fail if published docs reference generated preview assets."""

from __future__ import annotations

import re
from pathlib import Path


ROOTS = [
    Path("README.md"),
    Path("src"),
    Path("docs"),
    Path("python/README.md"),
    Path("python/docs"),
    Path("packages/ruviz-web/README.md"),
    Path("packages/ruviz-web/docs"),
    Path("crates/ruviz-web/README.md"),
    Path("crates/ruviz-web/src"),
    Path("crates/ruviz-gpui/README.md"),
    Path("crates/ruviz-gpui/src"),
]

TEXT_SUFFIXES = {".md", ".rs"}
PATTERNS = [
    re.compile(r"!\[[^\]]*\]\(\s*(?:\./)?generated/"),
    re.compile(r"\[[^\]]+\]\(\s*(?:\./)?generated/"),
    re.compile(r"""(?:src|href)=["'](?:\./)?generated/"""),
    re.compile(r"""https://raw\.githubusercontent\.com/[^"'\s)]+/generated/"""),
]


def iter_files(root: Path) -> list[Path]:
    if root.is_file():
        return [root]
    return sorted(
        path
        for path in root.rglob("*")
        if path.is_file() and path.suffix in TEXT_SUFFIXES
    )


def main() -> int:
    violations: list[str] = []

    for root in ROOTS:
        for path in iter_files(root):
            with path.open("r", encoding="utf-8") as handle:
                in_fence = False
                for line_number, line in enumerate(handle, start=1):
                    if path.suffix == ".md" and line.strip().startswith("```"):
                        in_fence = not in_fence
                    if in_fence:
                        continue

                    for pattern in PATTERNS:
                        if pattern.search(line):
                            violations.append(f"{path}:{line_number}: {line.rstrip()}")
                            break

    if violations:
        print("Published docs must not reference generated preview assets:")
        for violation in violations:
            print(violation)
        return 1

    print("No published docs reference generated preview assets.")
    return 0


if __name__ == "__main__":
    raise SystemExit(main())