@@ -15,9 +15,8 @@ Starting from version **v1.0.0**, `cpp-linter-hooks` has migrated from using the
15
15
16
16
| Aspect | Before (< v1.0.0) | After (≥ v1.0.0) |
17
17
| --------| -------------------| -------------------|
18
- | ** Installation** | ` clang-tools ` package (binary management) | Python wheel packages (` clang-format ` , ` clang-tidy ` ) |
19
- | ** Distribution** | Single package for both tools | Separate packages for each tool |
20
- | ** Version Control** | Limited version flexibility | Enhanced version management with pip |
18
+ | ** Installation** | Install from GitHub release | Install with from PyPI |
19
+ | ** Distribution** | Binary packages | Python wheel packages |
21
20
| ** Performance** | Standard performance | Optimized wheel packages |
22
21
23
22
### Implementation Details
@@ -28,55 +27,21 @@ Starting from version **v1.0.0**, `cpp-linter-hooks` has migrated from using the
28
27
29
28
## Breaking Changes
30
29
31
- ### For End Users
32
-
33
- > ** No breaking changes for end users**
30
+ ** No breaking changes for end users**
34
31
35
32
- Your existing ` .pre-commit-config.yaml ` files will continue to work without modification
36
33
- All hook configurations remain backward compatible
37
34
- No changes required to your workflow
38
35
39
36
## Migration Steps
40
37
41
- ### For End Users
42
-
43
38
** No action required!** Your existing configuration will continue to work seamlessly.
44
39
45
40
However, we recommend updating to the latest version for:
46
41
- Better performance
47
42
- Enhanced reliability
48
43
- Latest features and bug fixes
49
44
50
- #### Example Configuration (No Changes Needed)
51
-
52
- ``` yaml
53
- repos :
54
- - repo : https://github.com/cpp-linter/cpp-linter-hooks
55
- rev : v1.0.0 # Use the latest version
56
- hooks :
57
- - id : clang-format
58
- args : [--style=Google]
59
- - id : clang-tidy
60
- args : [--checks=-*,readability-*]
61
- ` ` `
62
-
63
- ## Troubleshooting
64
-
65
- ### Common Issues
66
-
67
- #### Issue: Tool not found after migration
68
- **Solution**: Clear your pre-commit cache:
69
- ` ` ` bash
70
- pre-commit clean
71
- pre-commit install
72
- ```
73
-
74
- #### Issue: Version mismatch errors
75
- ** Solution** : Ensure you're using the latest version of ` cpp-linter-hooks ` :
76
- ``` yaml
77
- rev : v1.0.0 # Update to latest version
78
- ` ` `
79
-
80
45
## Support
81
46
82
47
If you encounter issues after migration:
0 commit comments