Skip to content

MIGRATION.md

Latest commit

 

History

History
109 lines (78 loc) · 3.43 KB

MIGRATION.md

File metadata and controls

109 lines (78 loc) · 3.43 KB

Migration: From Clang Tools Binaries to Python Wheels

Overview

Starting from version v1.0.0, cpp-linter-hooks has migrated from using the clang-tools package to using Python wheel packages for clang-format and clang-tidy. This change provides:

  • Better cross-platform compatibility
  • Easier installation and dependency management
  • Improved performance and reliability
  • More predictable version management

What Changed

Core Changes

Aspect Before (< v1.0.0) After (≥ v1.0.0)
Installation clang-tools package (binary management) Python wheel packages (clang-format, clang-tidy)
Distribution Single package for both tools Separate packages for each tool
Version Control Limited version flexibility Enhanced version management with pip
Performance Standard performance Optimized wheel packages

Implementation Details

  • Dependencies: Updated to use separate clang-format==20.1.7 and clang-tidy==20.1.0 Python wheels
  • Installation Logic: Enhanced with pip-based installation and runtime version checks
  • Performance: Pre-commit hooks can now run in parallel for better speed

Breaking Changes

For End Users

No breaking changes for end users

  • Your existing .pre-commit-config.yaml files will continue to work without modification
  • All hook configurations remain backward compatible
  • No changes required to your workflow

Migration Steps

For End Users

No action required! Your existing configuration will continue to work seamlessly.

However, we recommend updating to the latest version for:

  • Better performance
  • Enhanced reliability
  • Latest features and bug fixes

Example Configuration (No Changes Needed)

repos:
  - repo: https://github.com/cpp-linter/cpp-linter-hooks
    rev: v1.0.0  # Use the latest version
    hooks:
      - id: clang-format
        args: [--style=Google]
      - id: clang-tidy
        args: [--checks=-*,readability-*]

Troubleshooting

Common Issues

Issue: Tool not found after migration

Solution: Clear your pre-commit cache:

pre-commit clean
pre-commit install

Issue: Version mismatch errors

Solution: Ensure you're using the latest version of cpp-linter-hooks:

rev: v1.0.0  # Update to latest version

Support

If you encounter issues after migration:

  1. Check this guide: Review the troubleshooting section above
  2. Search existing issues: GitHub Issues
  3. Report new issues: Include the following information:
    • Operating system and version
    • Python version
    • cpp-linter-hooks version
    • Complete error message/stack trace
    • Your .pre-commit-config.yaml configuration

References

Official Packages

Source Repositories

Documentation

Happy linting!