|
| 1 | +"""Sync categories and labels to the issue template form |
| 2 | +
|
| 3 | +projects.yaml → .github/ISSUE_TEMPLATE/01_suggest-project.yml |
| 4 | +
|
| 5 | +Note that this script does NOT update `.vscode/projects.schema.json`. |
| 6 | +""" |
| 7 | + |
| 8 | +from __future__ import annotations |
| 9 | + |
| 10 | +from argparse import ArgumentParser |
| 11 | +from collections import deque |
| 12 | +from pathlib import Path |
| 13 | +from typing import TYPE_CHECKING |
| 14 | + |
| 15 | +from ruamel.yaml import YAML |
| 16 | + |
| 17 | +if TYPE_CHECKING: |
| 18 | + from collections.abc import Generator |
| 19 | + from typing import Literal |
| 20 | + |
| 21 | + |
| 22 | +def build_parser() -> ArgumentParser: |
| 23 | + parser = ArgumentParser( |
| 24 | + description=__doc__, |
| 25 | + epilog="Read from source, substitute the content in destination between " |
| 26 | + "“# sync-{categories,labels}: start” and “# sync-{categories,labels}: end”.", |
| 27 | + ) |
| 28 | + parser.add_argument("source", type=Path, help="projects.yaml") |
| 29 | + parser.add_argument( |
| 30 | + "destination", type=Path, help=".github/ISSUE_TEMPLATE/01_suggest-project.yml" |
| 31 | + ) |
| 32 | + return parser |
| 33 | + |
| 34 | + |
| 35 | +def format_categories(projects_yaml: dict, *, tab: str) -> Generator[str, None, None]: |
| 36 | + return (f"{tab}- {c['title']}" for c in projects_yaml["categories"]) |
| 37 | + |
| 38 | + |
| 39 | +def format_labels(projects_yaml: dict, *, tab: str) -> Generator[str, None, None]: |
| 40 | + return ( |
| 41 | + f""" |
| 42 | +{tab}- label: | |
| 43 | +{tab} {label["name"]} |
| 44 | +{tab} {label["description"]} |
| 45 | +""".strip("\n") |
| 46 | + for label in projects_yaml["labels"] |
| 47 | + ) |
| 48 | + |
| 49 | + |
| 50 | +def transform(issue_template: str, projects_yaml: dict) -> str: |
| 51 | + original_rows = issue_template.splitlines() |
| 52 | + |
| 53 | + rows: deque[str] = deque() |
| 54 | + interlude: None | Literal["categories", "labels"] = None |
| 55 | + for r in original_rows: |
| 56 | + match (interlude, r.strip()): |
| 57 | + case (None, "# sync-categories: start"): |
| 58 | + rows.append(r) |
| 59 | + |
| 60 | + tab = r[: r.index("#")] |
| 61 | + rows.extend(format_categories(projects_yaml, tab=tab)) |
| 62 | + interlude = "categories" |
| 63 | + case (_, "# sync-categories: end"): |
| 64 | + rows.append(r) |
| 65 | + interlude = None |
| 66 | + |
| 67 | + case (None, "# sync-labels: start"): |
| 68 | + rows.append(r) |
| 69 | + |
| 70 | + tab = r[: r.index("#")] |
| 71 | + rows.extend(format_labels(projects_yaml, tab=tab)) |
| 72 | + interlude = "labels" |
| 73 | + case (_, "# sync-labels: end"): |
| 74 | + rows.append(r) |
| 75 | + interlude = None |
| 76 | + |
| 77 | + case (None, _): |
| 78 | + rows.append(r) |
| 79 | + |
| 80 | + case _: |
| 81 | + # Skip original interludes |
| 82 | + pass |
| 83 | + |
| 84 | + return "\n".join(rows) + "\n" |
| 85 | + |
| 86 | + |
| 87 | +if __name__ == "__main__": |
| 88 | + args = build_parser().parse_args() |
| 89 | + src: Path = args.source |
| 90 | + dst: Path = args.destination |
| 91 | + |
| 92 | + yaml = YAML(typ="safe") |
| 93 | + projects_yaml = yaml.load(src.read_text(encoding="utf-8")) |
| 94 | + issue_template = dst.read_text(encoding="utf-8") |
| 95 | + |
| 96 | + dst.write_text(transform(issue_template, projects_yaml), encoding="utf-8") |
0 commit comments