Skip to content

docs: Upgrade clang-format and clang-tidy to version 21 #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 1, 2025
Merged

docs: Upgrade clang-format and clang-tidy to version 21 #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ repos:
rev: v1.1.0
hooks:
- id: clang-format
args: [--style=file, --version=18] # Specifies version
args: [--style=file, --version=21] # Specifies version
- id: clang-tidy
args: [--checks=.clang-tidy, --version=18] # Specifies version
args: [--checks=.clang-tidy, --version=21] # Specifies version
```
Comment on lines +67 to 70
Copy link

@coderabbitai coderabbitai bot Sep 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix incorrect clang-tidy flag: use --config-file, not --checks=.clang-tidy

--checks=.clang-tidy is invalid; to load from a .clang-tidy file, use --config-file=.clang-tidy (or rely on default discovery).

Apply this diff:

       - id: clang-tidy
-        args: [--checks=.clang-tidy, --version=21] # Specifies version
+        args: [--config-file=.clang-tidy, --version=21] # Specifies version and loads config from file
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
args: [--style=file, --version=21] # Specifies version
- id: clang-tidy
args: [--checks=.clang-tidy, --version=18] # Specifies version
args: [--checks=.clang-tidy, --version=21] # Specifies version
```
args: [--style=file, --version=21] # Specifies version
- id: clang-tidy
args: [--config-file=.clang-tidy, --version=21] # Specifies version and loads config from file
🤖 Prompt for AI Agents 
In README.md around lines 67 to 70, the clang-tidy invocation uses an invalid
flag `--checks=.clang-tidy`; replace that flag with `--config-file=.clang-tidy`
(or remove the explicit flag to rely on clang-tidy's default discovery) so the
tool loads configuration from the .clang-tidy file; update the example args
accordingly and ensure the comment still notes the version if needed.


> [!NOTE]
Expand Down Expand Up @@ -180,7 +180,7 @@ repos:
rev: v1.1.0
hooks:
- id: clang-format
args: [--style=file, --version=18, --verbose] # Add -v or --verbose for detailed output
args: [--style=file, --version=21, --verbose] # Add -v or --verbose for detailed output
```

## FAQ
Expand Down
Loading