Function main

scripts/website/check_paragraph_capitalization.py:171–209

()

def main():
    parser = argparse.ArgumentParser(description=__doc__)
    parser.add_argument("paths", nargs="+", help="Markdown files or directories")
    parser.add_argument("--output", help="Write a JSON report to this path")
    parser.add_argument(
        "--repo-root",
        default=os.getcwd(),
        help="Root used to relativize file paths in the report (default: cwd)",
    )
    args = parser.parse_args()

    files = expand_paths(args.paths)
    errors = []
    for path in files:
        errors.extend(check_file(path, args.repo_root))

    if args.output:
        os.makedirs(os.path.dirname(args.output) or ".", exist_ok=True)
        with open(args.output, "w", encoding="utf-8") as fh:
            json.dump({"total": len(errors), "findings": errors}, fh, indent=2)

    if errors:
        print(
            f"Paragraph capitalization check failed: {len(errors)} paragraph(s) "
            f"start with a lowercase word.",
            file=sys.stderr,
        )
        for e in errors:
            print(f"  {e['file']}:{e['line']}: '{e['word']}' — {e['excerpt']}", file=sys.stderr)
        print(
            "\nEach flagged paragraph must be rewritten so its first prose word "
            "begins with a capital letter.\n"
            'Example: "many ways to animate..." → "There are many ways to animate..."',
            file=sys.stderr,
        )
        return 1

    print(f"Paragraph capitalization check passed: {len(files)} file(s), 0 issue(s).")
    return 0


if __name__ == "__main__":