All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

• Drop support for Python 3.8 and 3.9 (end-of-life)
• Add support for Python 3.13
• Minimum required Python version is now 3.10

• Fixed PowerShell system test script using $? instead of $LASTEXITCODE for exit code handling

• Fix SonarCloud violations:

  • Fix return type annotation for _load_from_toml method in _argparse.py
  • Reduce cognitive complexity in _cmake.py by extracting helper methods
  • Reduce cognitive complexity in _cmake_test.py by extracting test helpers
  • Fix variable naming conventions in test files
  • Fix GitHub Actions security issues by using environment variables for user-controlled data
  • Add input validation for workflow_dispatch parameters
  • Fix shell script issues in run_tests.sh (use [[ instead of [, add return statements)

• Fixed Windows CI by using pip to install cppcheck (Chocolatey package is broken)

• Modernize ruff configuration to follow latest guidelines

  • Remove deprecated settings (target-version, ANN101, ASYNC1, etc.)
  • Replace TCH with TC (renamed rule set)
  • Add new rule sets: DOC, PYI, PD
  • Configure blacken-docs to use ruff instead of black

• Clarify where to put the settings in pyproject.toml

• Update GitHub Action actions/download-artifact to v4

• Update GitHub Action actions/upload-artifact to v4

• Update GitHub Action codecov/codecov-action from v4 to v5

• Use GitHub Action SonarSource/sonarqube-scan-action v7

• Update GitHub Action github/codeql-action from v3 to v4

• Update GitHub Action stefanzweifel/git-auto-commit-action from v5 to v7

• Update github.com/pre-commit/pre-commit-hooks hook to v6.0.0

• Update https://github.com/PyCQA/doc8/ hook to v2.0.0

• Update github.com/codespell-project/codespell hook to v2.4.1

• Update github.com/shellcheck-py/shellcheck-py hook to v0.11.0.1

• Update github.com/adrienverge/yamllint.git hook to v1.37.1

• Update github.com/asottile/blacken-docs hook to 1.19.1

• Update github.com/astral-sh/ruff-pre-commit hook to v0.14.10

• Apply new linter/formatters

• Fixed a bug where a condition always evaluated to true

• Update GitHub Action action/setup-python to v5
• Update GitHub Action codecov/codecov-action from v3 to v4
• Update GitHub Action ilammy/msvc-dev-cmd from v1.12.1 to v1.13.0
• Update GitHub Action thomaseizinger/create-pull-request to v1.4.0
• Update adrienverge/yamllint hook to v1.35.1
• Update astral-sh/ruff-pre-commit hook to v0.4.5
• Update codespell-project/codespell hook to v2.3.0
• Update Lucas-C/pre-commit-hook hook to v1.5.5
• Update pre-commit/pre-commit-hooks hook to v4.6.0
• Update shellcheck-py/shellcheck-py hook to v0.10.0

• Added metadata to mark support for Python 3.12 and enabled CI checks for it
• Implemented PEP-621

• Remove all Python linters/formatters in favour of ruff
• Require setuptools>=61.0 in preparation for PEP-621

• Fix GitHub workflows
• Update astral-sh/ruff-pre-commit to v0.1.8
• Update adrienverge/yamllint hook to v1.33.0

• Added dependency on the Python attrs library

• Improved the printing of output when multiple files have been processed

• Update pre-commit/pre-commit-hooks hook to v4.5.0

• Fixed an issue when handling -- arguments

• Update asottile/blacken-docs hook to v1.16.0
• Update astral-sh/ruff-pre-commit to v0.0.292
• Update codespell-project/codespell hook to v2.2.6
• Update Lucas-C/pre-commit-hooks hook to v1.5.4
• Update psf/black hook to v23.9.1
• Update shellcheck-py/shellcheck-py hook to v0.9.0.6
• Update GitHub Action stefanzweifel/git-auto-commit-action to v5

• Added --no-cmake-configure option to avoid calling CMake configure but still use a compilation database if one can be found

• Update asottile/blacken-docs hook to v1.15.0
• Update astral-sh/ruff-pre-commit to v0.0.278
• Update charliermarsh/ruff-pre-commit hook to v0.0.275
• Update codespell-project/codespell hook to v2.2.5
• Update psf/black hook to v23.7.0
• Upgrade GitHub Action thomaseizinger/create-pull-request to v1.3.1

• Add proper support for clang-format "linter" mode (ie. --dry-run)

• Avoid setting up CMake arguments for clang-format hook

• Update release drafting GitHub workflow
• Modify pull requests workflow to automatically update CHANGELOG file if it was created by pre-commit.ci
• Update charliermarsh/ruff-pre-commit hook to v0.0.272
• Update shellcheck-py/shellcheck-py hook to v0.9.0.5

• Added Python tests using PyTest
• Added support for parsing hook parameters from TOML configuration files
• Added option to dump the current configuration as TOML-formatted output on the standard output (--dump-toml)
• Added option to parse CMake trace output to detect files generated using configure_file(...)

• Fixed potential issue with CppCheck hook always running on all files in compile database

• CppCheck hook will now exclude C++ header files by default since those are not present within the compilatioon databasebecauzse
• Make default logging level INFO instead of WARNING
• Move all CMake handling code into dedicated sub-module
• Minor adjustments to logging output format
• Update README

• Use ruff for linting over other Python linters
• System tests now run using LOGLEVEL=DEBUG
• Improved configuration for external linters (e.g. SonarCloud, Codacy)
• Update yamllint hook to v1.32.0

• Added support for C++ module files by default

• Fixed some typos in the README file (thanks to @onuralpszr)

• Require users to explicitly set -B|--build-dir if they pass --preset to CMake (see issue #63)

• Update Lucas-C/pre-commit-hooks hook to v1.5.1
• Update codespell to v2.2.4
• Update yamllint hook to v1.30.0
• Update black hook to v23.3.0
• Update bandit hook to v1.7.5
• Update isort hook to v5.12.0

• Added support for the CMake --preset command line argument

• Added support for reading compile_commands.json (generated by CMake) when running the hooks in order to automatically discover files

• Added some more pre-commit hooks:
  • shellcheck
  • bandit

• Add new badges to README file for CodeFactor.io and SonarCloud
• Update black hook to v23.1.0

• Added include-what-you-use-conda and cppcheck-conda hooks to install both tools using conda environments

• Changed minimum Python version to 3.8.X
• Allow lizard hook to handle Fortran files

• Update GitHub release publishing workflow
• Added some more pre-commit hooks:
  • doc8
  • codespell
  • yamllint
  • blacken-docs
  • pyupgrade

• Update action/setup-python GitHub Action to v5
• Update action/checkout GitHub Action to v4
• Update github/codeql-action/analyze GitHub Action to v3
• Update ilammy/msvc-dev-cmd GitHub Action to v1.12.1
• Update thomaseizinger/create-pull-request GitHub Action to v1.3.0
• Update Lucas-C/pre-commit-hooks hook to v1.4.2
• Update asottile/pyupgrade to v3.2.0
• Update black hook to v22.10.0
• Update blacken-docs hook to v1.13.0
• Update flake8 hook to v5.0.4
• Update pre-commit/mirrors-pylint to v3.0.0a5
• Update pre-commit/pre-commit-hooks to v4.3.0
• Update pyupgrade hook to v3.3.1
• Update yamllint hook to v1.29.0
• Update isort hook to v5.12.0

• Add support for installing clang-format using Python if not found on the system
• Add support for installing lizard automatically if not found on the system

• Correctly pass on the default argument list to CLinters
• Fixed issues with release publishing workflows on GitHub

• Update GitHub's CodeQL action to v2
• Update astral-sh/ruff-pre-commit hook to v0.4.7
• Update pre-commit/pre-commit-hooks hook to v4.3.0
• Update Lucas-C/pre-commit-hooks hook to v1.2.0
• Update pre-commit/mirrors-pylint hook to v3.0.0a5
• Update dangoslen/changelog-enforcer GitHub action to v3
• Update thomaseizinger/create-pull-request GitHub action to v1.2.2
• Update black hook to v22.3.0
• Update check-manifest to v0.48

• Fixed indentation issue

• Fixed locating of compilation database in presence of a symbolic link in the source directory

• New step in "Format" GitHub action to make sure the CHANGELOG is updated with proper version section for hotfix/_ and release/_ branches
• Update isort hook to v5.10.1
• Update black hook to v21.12b0
• Disable macOS CI for Python < 3.11 (now runs on M1 macs on GitHub)

• Support for cpplint
• Support for lizard, a code complexity analyzer

• Update pre-commit hooks
• Update thomaseizinger/create-pull-request GiHub action to v1.3.0
• Update isort hook to v5.10.0
• Update black hook to v21.10b0
• Update check-manifest hook to v0.47
• Update flake8 hook to v4.0.1

• Support for simultaneous processing of all files using --all-at-once

• Improved code handling standard output and error stream in case of multiple files
• Minor improvements to debugging output

• Do not attempt to copy the compilation database in the source directory if it exists and is a symbolic link
• Properly handle the --cmake command line option

• Cleanup of pre-commit-config.yaml and added
• Added some more flake8 plugins to the list used by pre-commit:
  • flake8-breakpoint
  • flake8-comprehensions
  • flake8-docstrings
  • flake8-eradicate
  • flake8-mutable

• Support for platform-specific CMake options Use --linux, --mac and --win to specify CMake flags that need to be provided only on the specific platform. --unix can be used as a shortcut to specifying --linux and --mac.

• Support for Include-What-You-Use

• Double-dash arguments not present in debug output

• Add tests that use pre-commit directly
• Add isort pre-commit hook

• Added debug command line option to show the exact commands being run when using pre-commit regardless of exit status

• Properly handle double-dash arguments for clang-tidy when multiple files are passed to the hook

• Added support for CUDA files by default

• Default source directory is now correctly set to the current directory

• Fix automatic release publication workflow

• Added Python 3.9 in the package's metadata
• Support for specifying more than one build directory If one of those exists and contains a configured CMake directory, that one will be chosen. If none already exist, the first specified alternative will be chosen.

• Issues with arguments parsing for arguments that are specified more than once
• Fix issue with CMake configure step when running hooks in parallel

• Update pre-commit configuration

• Support for GitHub actions
• Small test scripts for Linux, MacOS and Windows (only partial testing)

• Slightly more verbose output on certain failures

• Issue when passing paths to subprocess.run() on Windows
• CMake arguments being parsed more than once

Initial release with support for:

• clang-format
• clang-tidy
• cppcheck