[ci][format] Use clang-format for format check#11582

Author: CYFS3

.github/PULL_REQUEST_TEMPLATE.md

@@ -61,5 +61,5 @@ The following content must not be changed in the submitted PR message. Otherwise
 - [ ] 所有变更均有原因及合理的，并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
 - [ ] 对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
 - [ ] 代码是高质量的 Code in this PR is of high quality
-- [ ] 已经使用[formatting](https://github.com/mysterywolf/formatting) 等源码格式化工具确保格式符合[RT-Thread代码规范](https://github.com/RT-Thread/rt-thread/blob/master/documentation/contribution_guide/coding_style_cn.md) This PR complies with [RT-Thread code specification](https://github.com/RT-Thread/rt-thread/blob/master/documentation/contribution_guide/coding_style_en.md)
+- [ ] 已经使用[clang-format](https://clang.llvm.org/docs/ClangFormat.html) 源码格式化工具确保格式符合[RT-Thread代码规范](https://github.com/RT-Thread/rt-thread/blob/master/documentation/7.contribution/coding_style_cn.md) This PR has been formatted with clang-format and complies with [RT-Thread code specification](https://github.com/RT-Thread/rt-thread/blob/master/documentation/7.contribution/coding_style_en.md)
 - [ ] 如果是新增bsp, 已经添加ci检查到[.github/ALL_BSP_COMPILE.json](https://github.com/RT-Thread/rt-thread/blob/master/.github/ALL_BSP_COMPILE.json)  详细请参考链接[BSP自查](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/development-guide/bsp-selfcheck/bsp_selfcheck)

.github/workflows/format_check.yml

@@ -19,17 +19,24 @@ jobs:
     name: Scan code format and license
     if: github.repository_owner == 'RT-Thread'
     steps:
-      - uses: actions/checkout@main
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Set up Python
-        uses: actions/setup-python@main
+        uses: actions/setup-python@v5
         with:
           python-version: 3.8
-      
-      - name: Check Format and License
+
+      - name: Install clang-format
+        shell: bash
+        run: |
+          python -m pip install clang-format
+          clang-format --version
+
+      - name: Check clang-format
         shell: bash
         run: |
-          pip install click chardet PyYaml
-          python tools/ci/file_check.py check 'https://github.com/RT-Thread/rt-thread' 'master'
+          python tools/ci/clang_format_check.py --repo 'https://github.com/RT-Thread/rt-thread' --branch 'master'
 
   # # Post CI status to PR comment
   # post-ci-status:
@@ -42,4 +49,4 @@ jobs:
   #     pr_number: ${{ github.event.pull_request.number }}
   #   permissions:
   #     pull-requests: write
-  #     issues: write
+  #     issues: write

bsp/.clang-format

@@ -0,0 +1,266 @@
+#
+# Copyright (c) 2006-2026, RT-Thread Development Team
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# Change Logs:
+# Date           Author       Notes
+# 2026-07-07     RT-Thread    add clang-format CI check
+#
+
+import argparse
+import fnmatch
+import logging
+import re
+import subprocess
+import sys
+from pathlib import Path
+
+
+SOURCE_EXTENSIONS = (
+    ".c",
+    ".h",
+    ".cpp",
+    ".hpp",
+    ".cc",
+    ".hh",
+    ".C",
+    ".H",
+    ".cp",
+    ".cxx",
+    ".hxx",
+    ".inc",
+    ".inl",
+    ".ipp",
+    ".tpp",
+    ".txx",
+)
+
+
+HUNK_HEADER = re.compile(r"^@@ -\d+(?:,\d+)? \+(\d+)(?:,(\d+))? @@")
+
+
+def init_logger():
+    logging.basicConfig(level=logging.INFO, format="[%(filename)s %(lineno)d %(levelname)s] %(message)s ")
+
+
+def run_git(args, check=True):
+    result = subprocess.run(["git"] + args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+    if check and result.returncode != 0:
+        raise RuntimeError(result.stderr.decode("utf-8", errors="replace"))
+    return result
+
+
+def ensure_remote(remote, repo):
+    result = run_git(["remote", "get-url", remote], check=False)
+    if result.returncode == 0:
+        run_git(["remote", "set-url", remote, repo])
+    else:
+        run_git(["remote", "add", remote, repo])
+
+
+def split_git_paths(output):
+    paths = []
+    for item in output.split(b"\0"):
+        if item:
+            paths.append(item.decode("utf-8", errors="surrogateescape"))
+    return paths
+
+
+def get_changed_files(repo, branch, remote):
+    ensure_remote(remote, repo)
+    run_git(["fetch", "--no-tags", remote, branch])
+
+    merge_base = run_git(["merge-base", "FETCH_HEAD", "HEAD"]).stdout.decode("utf-8", errors="replace").strip()
+    if not merge_base:
+        raise RuntimeError("git merge-base FETCH_HEAD HEAD returned no commit")
+
+    diff_range = [merge_base, "HEAD"]
+    result = run_git(["diff", "--name-only", "-z", "--diff-filter=ACMR", "--no-renames"] + diff_range + ["--"])
+    return split_git_paths(result.stdout), diff_range
+
+
+def merge_line_ranges(ranges):
+    if not ranges:
+        return []
+
+    merged = []
+    for start, end in sorted(ranges):
+        if not merged or start > merged[-1][1] + 1:
+            merged.append([start, end])
+        else:
+            merged[-1][1] = max(merged[-1][1], end)
+    return [(start, end) for start, end in merged]
+
+
+def parse_changed_line_ranges(diff_text):
+    ranges = []
+    for line in diff_text.splitlines():
+        match = HUNK_HEADER.match(line)
+        if not match:
+            continue
+
+        start = int(match.group(1))
+        count = int(match.group(2) or "1")
+        if count == 0:
+            continue
+        ranges.append((start, start + count - 1))
+
+    return merge_line_ranges(ranges)
+
+
+def get_changed_line_ranges(diff_range, files):
+    line_ranges = {}
+    for file_path in files:
+        result = run_git(["diff", "--unified=0", "--diff-filter=ACMR", "--no-renames"] + diff_range + ["--", file_path])
+        line_ranges[file_path] = parse_changed_line_ranges(result.stdout.decode("utf-8", errors="replace"))
+    return line_ranges
+
+
+def normalize_path(path):
+    return path.as_posix().strip("/")
+
+
+def match_path(path, pattern):
+    return fnmatch.fnmatchcase(path, pattern) or fnmatch.fnmatchcase("/" + path, pattern)
+
+
+def ignore_pattern_matches(pattern, relative_file):
+    pattern = pattern.strip()
+    if not pattern or pattern.startswith("#"):
+        return False
+
+    pattern = pattern.lstrip("/")
+    dir_only = pattern.endswith("/")
+    pattern = pattern.rstrip("/")
+    if not pattern:
+        return False
+
+    relative_file = relative_file.strip("/")
+    if dir_only:
+        parts = relative_file.split("/")
+        dirs = ["/".join(parts[:index]) for index in range(1, len(parts))]
+        return match_path(relative_file, pattern) or any(match_path(directory, pattern) for directory in dirs)
+
+    if "/" not in pattern:
+        return any(fnmatch.fnmatchcase(part, pattern) for part in relative_file.split("/"))
+
+    return match_path(relative_file, pattern)
+
+
+def is_ignored_by_clang_format(root, file_path):
+    absolute_file = (root / file_path).resolve()
+    try:
+        relative_to_root = absolute_file.relative_to(root)
+    except ValueError:
+        return False
+
+    current_dir = absolute_file.parent
+    ignore_files = []
+    while True:
+        ignore_file = current_dir / ".clang-format-ignore"
+        if ignore_file.exists():
+            ignore_files.append(ignore_file)
+        if current_dir == root:
+            break
+        current_dir = current_dir.parent
+
+    for ignore_file in reversed(ignore_files):
+        try:
+            ignore_dir = ignore_file.parent.relative_to(root)
+            if str(ignore_dir) == ".":
+                relative_file = normalize_path(relative_to_root)
+            else:
+                relative_file = normalize_path(relative_to_root.relative_to(ignore_dir))
+        except ValueError:
+            continue
+        with open(ignore_file, "r", encoding="utf-8") as ignore:
+            for line in ignore:
+                if ignore_pattern_matches(line, relative_file):
+                    logging.info("ignore file by %s: %s", ignore_file.relative_to(root).as_posix(), file_path)
+                    return True
+    return False
+
+
+def filter_source_files(root, files):
+    source_files = []
+    for file_path in files:
+        path = root / file_path
+        if not path.is_file():
+            continue
+        if not file_path.endswith(SOURCE_EXTENSIONS):
+            continue
+        if is_ignored_by_clang_format(root, Path(file_path)):
+            continue
+        source_files.append(file_path)
+    return source_files
+
+
+def check_clang_format(files, clang_format, line_ranges=None):
+    failed_files = []
+    for file_path in files:
+        invocation = [clang_format, "--dry-run", "--Werror", "--style=file"]
+        if line_ranges is not None:
+            ranges = line_ranges.get(file_path, [])
+            if not ranges:
+                logging.info("skip clang-format, no changed lines -> %s", file_path)
+                continue
+            for start, end in ranges:
+                invocation.append("--lines={}:{}".format(start, end))
+
+        invocation.append(file_path)
+        logging.info("check clang-format -> %s", file_path)
+        result = subprocess.run(
+            invocation,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            universal_newlines=True,
+        )
+        if result.stdout:
+            sys.stdout.write(result.stdout)
+        if result.stderr:
+            sys.stderr.write(result.stderr)
+        if result.returncode != 0:
+            failed_files.append(file_path)
+
+    if failed_files:
+        logging.error("clang-format check failed, please run clang-format on the files above.")
+        return False
+    return True
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Check changed source files with clang-format.")
+    parser.add_argument("--repo", default="https://github.com/RT-Thread/rt-thread")
+    parser.add_argument("--branch", default="master")
+    parser.add_argument("--remote", default="rtt_repo")
+    parser.add_argument("--clang-format-executable", default="clang-format")
+    parser.add_argument("files", nargs="*", help="files to check; git diff is used when omitted")
+    args = parser.parse_args()
+
+    init_logger()
+    root = Path.cwd().resolve()
+    if args.files:
+        files = args.files
+        line_ranges = None
+    else:
+        files, diff_range = get_changed_files(args.repo, args.branch, args.remote)
+        line_ranges = get_changed_line_ranges(diff_range, files)
+
+    source_files = filter_source_files(root, files)
+    if line_ranges is not None:
+        line_ranges = {file_path: line_ranges.get(file_path, []) for file_path in source_files}
+
+    if not source_files:
+        logging.warning("There are no source files to check format.")
+        return 0
+
+    if not check_clang_format(source_files, args.clang_format_executable, line_ranges):
+        return 1
+
+    logging.info("clang-format check success.")
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())