ngword_check.py

import glob
import os
import sys
import re

NGWORD_LIST = [
    ("", "<br>", "<br/>"),
    ("", "</br>", "<br/>"),
    ("", "acccess", "access"),
    ("", "ALING", "ALIGN"),
    ("", "alloacte", "allocate"),
    ("", "alocator", "allocator"),
    ("", "asssert", "assert"),
    ("", "asssume", "assume"),
    ("", "algined", "aligned"),
    ("", "concpet", "concept"),
    ("", "condtion", "condition"),
    ("", "construcitble", "constructible"),
    ("", "construtible", "constructible"),
    ("", "contraint", "constraint"),
    ("", "Dimentional", "Dimensional"),
    ("", "deccltype", "decltype"),
    ("", "Doamin", "Domain"),
    ("", "eror", "error"),
    ("", "enumrate", "enumerate"),
    ("", "exectution", "execution"),
    ("", "expceted", "expected"),
    ("", "exposion", "exposition"),
    ("", "functon", "function"),
    ("", "generetor", "generator"),
    ("", "greator", "greater"),
    ("", "invocalbe", "invocable"),
    ("", "namespase", "namespace"),
    ("", "noexpcet", "noexcept"),
    ("", "oeprator", "operator"),
    ("", "opreator", "operator"),
    ("", "opton", "option"),
    ("", "Ohter", "Other"),
    ("", "poinetr", "pointer"),
    ("", "protmise_type", "promise_type"),
    ("", "pvalue", "prvalue"),
    ("", "Recevier", "Receiver"),
    ("", "reciever", "receiver"),
    ("", "refernce", "reference"),
    ("", "repear", "repeat"),
    ("", "schedue", "schedule"),
    ("", "staitc", "static"),
    ("", "std::range::", "std::ranges::"),
    ("", "swtich", "switch"),
    ("", "voaltile", "volatile"),
    ("", "Updated upstream", ""),
    ("", "Stashed changes", ""),
    ("", "アラインメント", "アライメント"),
    ("", "イテレーター", "イテレータ"),
    ("", "子ルーチン", "コルーチン"),
    ("", "移譲", "委譲"),
    ("", r'型]\((.*?)\)型', "型](link)"),
    ("", "括弧", "カッコ"),
    ("", "スロー", "送出"),
    ("", "constepx", "constexpr"),
    ("", "wsting", "wstring"),
    ("", r"\[lin ", "[link "), # コード修飾ミス
    ("reference/chrono", "dulation", "duration"),
    ("reference/random", "施行", "試行"),
    ("reference/random", "疑似", "擬似"),
]

def check_ngword(text: str, filename: str) -> bool:
    found_error: bool = False

    for target_dir, ngword, correct in NGWORD_LIST:
        if not filename.startswith(target_dir):
            continue

        m = re.search(ngword, text)
        if m:
            print("{}: the file includes ngword \"{}\". you should fix to \"{}\".".format(filename, ngword, correct))
            found_error = True
    return not found_error

def check() -> bool:
    found_error = False
    for p in sorted(list(glob.glob("**/*.md", recursive=True))):
        if p.startswith("start_editing/"):
            continue

        with open(p) as f:
            text = f.read()

        if not check_ngword(text, p):
            found_error = True

    return not found_error

if __name__ == '__main__':
    if not check():
        sys.exit(1)