girt 0.11.2

An incremental, idiomatic Rust implementation of Git
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

#!/usr/bin/env python3
"""Compile and run the standalone Rust programs in girt's developer guides.

Use Cargo's artifact paths so the examples use the same compiler dependencies as the library,
including custom target directories. Website content is excluded from published packages; an
archive without these guides has nothing to check.
"""

import json
import os
import re
from pathlib import Path
import subprocess

ROOT = Path(__file__).resolve().parent.parent
GUIDES = ROOT / "site/src/content/docs/guides"


def main():
    pages = sorted(
        page for page in GUIDES.rglob("*")
        if page.suffix in (".md", ".mdx")
        and re.search(r"^```rust(?:[, \t][^\n]*)?\s*$", page.read_text(), re.MULTILINE)
    )
    if not pages:
        print("No developer website guides in this checkout.")
        return
    result = subprocess.run(
        ["cargo", "build", "--locked", "--lib", "--all-features", "--message-format=json"],
        cwd=ROOT, check=True, text=True, stdout=subprocess.PIPE,
    )
    libraries = {}
    for line in result.stdout.splitlines():
        message = json.loads(line)
        if message.get("reason") != "compiler-artifact":
            continue
        name = message["target"]["name"]
        if name in ("girt", "tempfile"):
            for filename in message["filenames"]:
                if filename.endswith(".rlib"):
                    libraries[name] = Path(filename)
    missing = {"girt", "tempfile"} - libraries.keys()
    if missing:
        raise RuntimeError(f"Cargo did not report library artifacts for: {sorted(missing)}")
    externs = []
    for name in ("girt", "tempfile"):
        externs.extend(["--extern", f"{name}={libraries[name]}"])
    search_paths = []
    for directory in sorted({library.parent for library in libraries.values()}):
        search_paths.extend(["-L", f"dependency={directory}"])
    for page in pages:
        subprocess.run(
            [os.environ.get("RUSTDOC", "rustdoc"), "--test", "--edition=2024",
             str(page), *search_paths, *externs],
            cwd=ROOT, check=True,
        )


if __name__ == "__main__":
    main()