cpp-linter 1.13.0__tar.gz → 1.14.0__tar.gz

{cpp_linter-1.13.0 → cpp_linter-1.14.0}/.github/dependabot.yml

@@ -9,6 +9,8 @@ updates:
     directory: /
     schedule:
       interval: "monthly"
+    cooldown:
+      default-days: 7
     groups:
       actions:
         patterns:

{cpp_linter-1.13.0 → cpp_linter-1.14.0}/.github/workflows/analyze-workflows.yml

@@ -12,11 +12,11 @@ jobs:
   analyze-ci:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
           persist-credentials: false
       - name: Set up Python
-        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
         with:
           python-version: '3.x'
       - name: Run zizmor

{cpp_linter-1.13.0 → cpp_linter-1.14.0}/.github/workflows/release.yml

@@ -20,13 +20,13 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         # use fetch --all for setuptools_scm to work
         with:
           fetch-depth: 0
           persist-credentials: false
       - name: Set up Python
-        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
         with:
           python-version: '3.x'
       - name: Build distributions
@@ -51,7 +51,7 @@ jobs:
           path: dist
       - name: Set up Python
         if: ${{ !startsWith(github.ref, 'refs/tags/') }}
-        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
         with:
           python-version: '3.x'
       - name: Check distributions
@@ -59,4 +59,4 @@ jobs:
         run: pipx run twine check dist/*
       - name: Deploy to PyPI
         if: startsWith(github.ref, 'refs/tags/')
-        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

{cpp_linter-1.13.0 → cpp_linter-1.14.0}/.github/workflows/tests.yml

@@ -23,12 +23,38 @@ on:
 permissions: {}
 
 jobs:
+  pre-seed-versions:
+    runs-on: ubuntu-latest
+    outputs:
+      versions: ${{ steps.extract-version-range.outputs.versions }}
+    steps:
+      - env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: >-
+          gh release download
+          -R cpp-linter/clang-tools-static-binaries
+          --pattern versions.json
+          --output versions.json
+      - name: Extract version range
+        id: extract-version-range
+        shell: python
+        run: |-
+          import json
+          from os import environ
+          from pathlib import Path
+          content = Path("versions.json").read_text(encoding="utf-8")
+          metadata = json.loads(content)
+          versions = list(metadata["llvm_versions"].keys())
+          versions.sort()
+          with open(environ["GITHUB_OUTPUT"], mode="a") as gh_out:
+              gh_out.write(f"versions={json.dumps(versions)}\n")
   test:
+    needs: pre-seed-versions
     strategy:
       fail-fast: false
       matrix:
         os: ['windows-latest', 'ubuntu-latest']
-        version: ['22', '21', '20', '19', '18', '17', '16', '15', '14', '13', '12', '11']
+        version: ${{ fromJSON(needs.pre-seed-versions.outputs.versions) }}
     env:
       MAX_PYTHON_VERSION: '3.14'
       # only used when installing for a pre-released python version
@@ -36,11 +62,11 @@ jobs:
 
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
           persist-credentials: false
 
-      - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
         with:
           python-version: 3.x
 
@@ -60,7 +86,7 @@ jobs:
       #     sudo cmake --install build
 
       - name: Install uv
-        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
         with:
           enable-cache: true
           cache-dependency-glob: "uv.lock"
@@ -76,30 +102,38 @@ jobs:
       - name: Install Linux clang dependencies
         if: runner.os == 'Linux'
         shell: bash
+        env:
+          CLANG_VERSION: ${{ matrix.version }}
         run: |
           sudo apt-get update
           # First try installing from default Ubuntu repositories before trying LLVM script
-          if ! sudo apt-get install -y clang-format-${{ matrix.version }} clang-tidy-${{ matrix.version }}; then
+          if ! sudo apt-get install -y clang-format-${CLANG_VERSION} clang-tidy-${CLANG_VERSION}; then
             # This LLVM script will add the relevant LLVM PPA: https://apt.llvm.org/
             wget https://apt.llvm.org/llvm.sh -O ${{ runner.temp }}/llvm_install.sh
             chmod +x ${{ runner.temp }}/llvm_install.sh
-            if sudo ${{ runner.temp }}/llvm_install.sh ${{ matrix.version }}; then
-              sudo apt-get install -y clang-format-${{ matrix.version }} clang-tidy-${{ matrix.version }}
+            if sudo ${{ runner.temp }}/llvm_install.sh ${CLANG_VERSION}; then
+              sudo apt-get install -y clang-format-${CLANG_VERSION} clang-tidy-${CLANG_VERSION}
             fi
           fi
 
       - name: Install clang-tools
+        shell: bash
+        env:
+          CLANG_VERSION: ${{ matrix.version }}
         run: |
           python -m pip install clang-tools
-          clang-tools install clang-format clang-tidy --version ${{ matrix.version }}
+          clang-tools install clang-format clang-tidy --version "${CLANG_VERSION}"
 
       - name: Is clang-only tests?
         id: clang-dep
         shell: python
+        env:
+          CLANG_VERSION: ${{ matrix.version }}
         run: |-
           from os import environ
           with open(environ["GITHUB_OUTPUT"], mode="a") as gh_out:
-            if "${{ matrix.version }}" == "21":
+            curr_test_ver = environ["CLANG_VERSION"]
+            if curr_test_ver == "21":
                 gh_out.write("args=\n")
             else:
                 gh_out.write("args=not no_clang\n")
@@ -125,7 +159,7 @@ jobs:
       name: test-coverage
       url: https://app.codecov.io/gh/cpp-linter/cpp-linter
     steps:
-      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
           persist-credentials: false
 
@@ -136,12 +170,12 @@ jobs:
           merge-multiple: true
 
       - name: Setup python
-        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
         with:
           python-version: '3.x'
 
       - name: Install uv
-        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
         with:
           enable-cache: true
           cache-dependency-glob: "uv.lock"

{cpp_linter-1.13.0 → cpp_linter-1.14.0}/.pre-commit-config.yaml

@@ -20,14 +20,14 @@ repos:
         args: ["--fix=lf"]
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.15.9
+    rev: v0.15.20
     hooks:
       # Run the linter.
       - id: ruff-check
       # Run the formatter.
       - id: ruff-format
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 'v1.20.0'
+    rev: 'v2.1.0'
     hooks:
       - id: mypy
         additional_dependencies:
@@ -38,6 +38,6 @@ repos:
           - requests-mock
           - '.'
   - repo: https://github.com/streetsidesoftware/cspell-cli
-    rev: v9.8.0
+    rev: v10.0.1
     hooks:
       - id: cspell

{cpp_linter-1.13.0/cpp_linter.egg-info → cpp_linter-1.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cpp-linter
-Version: 1.13.0
+Version: 1.14.0
 Summary: Run clang-format and clang-tidy on a batch of files.
 Author-email: Brendan Doherty <2bndy5@gmail.com>, Xianpeng Shen <xianpeng.shen@gmail.com>
 License-Expression: MIT
@@ -65,6 +65,16 @@ For usage in a CI workflow, see `the cpp-linter/cpp-linter-action repository <ht
 
 For the description of supported Command Line Interface options, see `the CLI documentation <https://cpp-linter.github.io/cpp-linter/cli_args.html>`_
 
+Applying fixes
+--------------
+
+Passing the ``--fix`` option makes cpp-linter apply clang-format fixes in-place to
+any files that have formatting problems.
+
+.. note::
+    ``--fix`` only applies **clang-format** fixes. clang-tidy fixes are not applied
+    automatically.
+
 Have question or feedback?
 --------------------------
 

{cpp_linter-1.13.0 → cpp_linter-1.14.0}/README.rst

@@ -34,6 +34,16 @@ For usage in a CI workflow, see `the cpp-linter/cpp-linter-action repository <ht
 
 For the description of supported Command Line Interface options, see `the CLI documentation <https://cpp-linter.github.io/cpp-linter/cli_args.html>`_
 
+Applying fixes
+--------------
+
+Passing the ``--fix`` option makes cpp-linter apply clang-format fixes in-place to
+any files that have formatting problems.
+
+.. note::
+    ``--fix`` only applies **clang-format** fixes. clang-tidy fixes are not applied
+    automatically.
+
 Have question or feedback?
 --------------------------
 

{cpp_linter-1.13.0 → cpp_linter-1.14.0}/cpp_linter/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '1.13.0'
-__version_tuple__ = version_tuple = (1, 13, 0)
+__version__ = version = '1.14.0'
+__version_tuple__ = version_tuple = (1, 14, 0)
 
-__commit_id__ = commit_id = 'ge8981d1cf'
+__commit_id__ = commit_id = 'g2e850a5d0'

{cpp_linter-1.13.0 → cpp_linter-1.14.0}/cpp_linter/clang_tools/__init__.py

@@ -8,7 +8,13 @@ import shutil
 
 from ..common_fs import FileObj, FileIOTimeout
 from ..common_fs.file_filter import TidyFileFilter, FormatFileFilter
-from ..loggers import start_log_group, end_log_group, worker_log_init, logger
+from ..loggers import (
+    start_log_group,
+    end_log_group,
+    worker_log_init,
+    should_use_rich,
+    logger,
+)
 from .clang_tidy import run_clang_tidy, TidyAdvice
 from .clang_format import run_clang_format, FormatAdvice
 from ..cli import Args
@@ -37,6 +43,7 @@ def assemble_version_exec(tool_name: str, specified_version: str) -> str | None:
 def _run_on_single_file(
     file: FileObj,
     log_lvl: int,
+    use_rich: bool,
     tidy_cmd: str | None,
     db_json: list[dict[str, str]] | None,
     format_cmd: str | None,
@@ -44,31 +51,14 @@ def _run_on_single_file(
     tidy_filter: TidyFileFilter | None,
     args: Args,
 ) -> tuple[str, str, TidyAdvice | None, FormatAdvice | None]:
-    log_stream = worker_log_init(log_lvl)
+    log_stream = worker_log_init(log_lvl, use_rich)
     filename = Path(file.name).as_posix()
 
-    format_advice = None
-    if format_cmd is not None and (
-        format_filter is None or format_filter.is_source_or_ignored(file.name)
-    ):
-        try:
-            format_advice = run_clang_format(
-                command=format_cmd,
-                file_obj=file,
-                style=args.style,
-                lines_changed_only=args.lines_changed_only,
-                format_review=args.format_review,
-            )
-        except FileIOTimeout:  # pragma: no cover
-            logger.error(
-                "Failed to read or write contents of %s when running clang-format",
-                filename,
-            )
-        except OSError:  # pragma: no cover
-            logger.error(
-                "Failed to open the file %s when running clang-format", filename
-            )
-
+    # clang-tidy must run *before* clang-format, because `--fix` rewrites the
+    # file in place. clang-tidy reports line numbers from the file on disk, but
+    # its `--line-filter` (and the PR review comments built from its output) use
+    # line numbers from the event's diff. Formatting first would shift every
+    # subsequent diagnostic, silently dropping some and misplacing the rest.
     tidy_note = None
     if tidy_cmd is not None and (
         tidy_filter is None or tidy_filter.is_source_or_ignored(file.name)
@@ -92,6 +82,29 @@ def _run_on_single_file(
         except OSError:  # pragma: no cover
             logger.error("Failed to open the file %s when running clang-tidy", filename)
 
+    format_advice = None
+    if format_cmd is not None and (
+        format_filter is None or format_filter.is_source_or_ignored(file.name)
+    ):
+        try:
+            format_advice = run_clang_format(
+                command=format_cmd,
+                file_obj=file,
+                style=args.style,
+                lines_changed_only=args.lines_changed_only,
+                format_review=args.format_review,
+                fix=args.fix,
+            )
+        except FileIOTimeout:  # pragma: no cover
+            logger.error(
+                "Failed to read or write contents of %s when running clang-format",
+                filename,
+            )
+        except OSError:  # pragma: no cover
+            logger.error(
+                "Failed to open the file %s when running clang-format", filename
+            )
+
     return file.name, log_stream.getvalue(), tidy_note, format_advice
 
 
@@ -161,11 +174,15 @@ def capture_clang_tools_output(files: list[FileObj], args: Args) -> ClangVersion
 
     with ProcessPoolExecutor(args.jobs) as executor:
         log_lvl = logger.getEffectiveLevel()
+        # Decided here, not in the worker: with the forkserver start method
+        # workers do not see environment changes made after the server started.
+        use_rich = should_use_rich()
         futures = [
             executor.submit(
                 _run_on_single_file,
                 file,
                 log_lvl=log_lvl,
+                use_rich=use_rich,
                 tidy_cmd=tidy_cmd,
                 db_json=db_json,
                 format_cmd=format_cmd,
@@ -194,4 +211,5 @@ def capture_clang_tools_output(files: list[FileObj], args: Args) -> ClangVersion
                         break
                 else:  # pragma: no cover
                     raise ValueError(f"Failed to find {file_name} in list of files.")
+
     return clang_versions

{cpp_linter-1.13.0 → cpp_linter-1.14.0}/cpp_linter/clang_tools/clang_format.py

@@ -166,6 +166,7 @@ def run_clang_format(
     style: str,
     lines_changed_only: int,
     format_review: bool,
+    fix: bool = False,
 ) -> FormatAdvice:
     """Run clang-format on a certain file
 
@@ -177,6 +178,8 @@ def run_clang_format(
         diff info.
     :param format_review: A flag to enable/disable creating a diff suggestion for
         PR review comments.
+    :param fix: A flag to enable applying clang-format's fixes in-place. Only the
+        lines selected by ``lines_changed_only`` are reformatted.
     """
     cmds = [
         command,
@@ -200,6 +203,29 @@ def run_clang_format(
     advice = parse_format_replacements_xml(
         results.stdout.decode(encoding="utf-8").strip(), file_obj, lines_changed_only
     )
+    if fix and advice.replaced_lines:
+        # Reuse the assembled (range-aware) args to apply fixes in-place. This
+        # runs in the same parallel worker as the analysis above, and honors
+        # --lines-changed-only via the --lines args already in `cmds`.
+        fix_cmds = [arg for arg in cmds if arg != "--output-replacements-xml"]
+        fix_cmds.insert(-1, "-i")  # apply edits in-place, just before the file path
+        logger.info('Applying formatting fixes with "%s"', " ".join(fix_cmds))
+        fix_results = subprocess.run(fix_cmds, capture_output=True)
+        if fix_results.returncode:  # pragma: no cover
+            logger.error(
+                "Failed to apply clang-format fixes to %s:\n%s",
+                file_obj.name,
+                fix_results.stderr.decode(),
+            )
+        else:
+            # The file is now formatted, so it has no outstanding issues.
+            advice = FormatAdvice(file_obj.name)
+            if not format_review:
+                return advice
+            # A review was asked for, so `patched` still has to be populated:
+            # the review pass asserts on it. Fall through and re-run
+            # clang-format on the now-formatted file -- it returns the file
+            # unchanged, so the review carries no suggestions for it.
     if format_review:
         del cmds[2]  # remove `--output-replacements-xml` flag
         logger.info('Getting fixes with "%s"', " ".join(cmds))

{cpp_linter-1.13.0 → cpp_linter-1.14.0}/cpp_linter/cli.py

@@ -73,6 +73,8 @@ class Args(UserDict):
     ignore_format: str = ""
     #: See :std:option:`--passive-reviews`.
     passive_reviews: bool = False
+    #: See :std:option:`--fix`.
+    fix: bool = False
     #: See :std:option:`--summary-output-file`.
     summary_output_file: str = ""
     #: A subcommand if provided
@@ -388,6 +390,19 @@ _parser_args[("-R", "--passive-reviews")] = dict(
     help="""Set to ``true`` to prevent Pull Request
 reviews from requesting or approving changes.""",
 )
+_parser_args[("-F", "--fix")] = dict(
+    default=False,
+    action="store_true",
+    help="""Apply clang-format fixes in-place to files with
+style issues. Only the lines selected by
+:std:option:`--lines-changed-only` are reformatted.
+
+.. note::
+    This option only applies to clang-format.
+    clang-tidy fixes are not applied automatically.
+
+Defaults to ``%(default)s``""",
+)
 _parser_args[("-o", "--summary-output-file")] = dict(
     default="",
     help="""Supply a path to which the step summary will be written.

{cpp_linter-1.13.0 → cpp_linter-1.14.0}/cpp_linter/loggers.py

@@ -57,16 +57,36 @@ def log_response_msg(response: Response):
         )
 
 
-def worker_log_init(log_lvl: int):
+def should_use_rich() -> bool:
+    """Decide whether log output should be rendered with ``rich``.
+
+    Call this in the parent process and hand the result to worker processes.
+    With the ``forkserver`` start method (the default on Linux since Python 3.14)
+    workers inherit the environment of the long-lived forkserver, not the parent's
+    current environment, so a check of ``os.environ`` inside the worker can be stale.
+    """
+    return FOUND_RICH_LIB and "CPP_LINTER_PYTEST_NO_RICH" not in os.environ
+
+
+def worker_log_init(log_lvl: int, use_rich: bool | None = None):
+    """Set up logging inside a worker process.
+
+    :param log_lvl: The log level to apply; passed in because Windows does not
+        copy the parent's log level to subprocesses.
+    :param use_rich: Whether to render logs with ``rich``. Compute this in the
+        parent with :func:`should_use_rich` and pass it in; ``None`` falls back to
+        evaluating it in the current process.
+    """
     log_stream = io.StringIO()
 
     logger.handlers.clear()
     logger.propagate = False
 
+    if use_rich is None:
+        use_rich = should_use_rich()
+
     handler: logging.Handler
-    if (
-        FOUND_RICH_LIB and "CPP_LINTER_PYTEST_NO_RICH" not in os.environ
-    ):  # pragma: no cover
+    if use_rich:  # pragma: no cover
         console = get_console()
         console.file = log_stream
         handler = RichHandler(show_time=False, console=console)

{cpp_linter-1.13.0 → cpp_linter-1.14.0/cpp_linter.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cpp-linter
-Version: 1.13.0
+Version: 1.14.0
 Summary: Run clang-format and clang-tidy on a batch of files.
 Author-email: Brendan Doherty <2bndy5@gmail.com>, Xianpeng Shen <xianpeng.shen@gmail.com>
 License-Expression: MIT
@@ -65,6 +65,16 @@ For usage in a CI workflow, see `the cpp-linter/cpp-linter-action repository <ht
 
 For the description of supported Command Line Interface options, see `the CLI documentation <https://cpp-linter.github.io/cpp-linter/cli_args.html>`_
 
+Applying fixes
+--------------
+
+Passing the ``--fix`` option makes cpp-linter apply clang-format fixes in-place to
+any files that have formatting problems.
+
+.. note::
+    ``--fix`` only applies **clang-format** fixes. clang-tidy fixes are not applied
+    automatically.
+
 Have question or feedback?
 --------------------------
 

{cpp_linter-1.13.0 → cpp_linter-1.14.0}/cpp_linter.egg-info/SOURCES.txt

@@ -11,7 +11,6 @@ noxfile.py
 pyproject.toml
 setup.py
 uv.lock
-.github/FUNDING.yml
 .github/dependabot.yml
 .github/zizmor.yml
 .github/workflows/analyze-workflows.yml
@@ -74,6 +73,7 @@ tests/test_git_str.py
 tests/test_misc.py
 tests/test_parse_clang_tidy_stdout.py
 tests/test_rate_limits.py
+tests/capture_tools_output/test_auto_fix.py
 tests/capture_tools_output/test_database_path.py
 tests/capture_tools_output/test_tools_output.py
 tests/capture_tools_output/chocolate-doom/chocolate-doom/.clang-format