Integrate format code script #759
Conversation
Signed-off-by: Alan Jowett <[email protected]>
|
Warning Rate limit exceeded@Alan-Jowett has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 50 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe changes introduce a new Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 13
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
📒 Files selected for processing (3)
- scripts/format-code (1 hunks)
- scripts/format-code.ps1 (1 hunks)
- scripts/pre-commit (1 hunks)
🔇 Additional comments (4)
scripts/pre-commit (2)
40-43: LGTM! Well-structured integration of the formatting check.The implementation:
- Maintains consistent error handling with existing checks
- Provides clear, actionable error messages
- Includes cross-platform support with both bash and powershell commands
- Preserves the ability to skip checks with --no-verify
40-42: 🛠️ Refactor suggestionVerify the format-code script path and improve error handling.
While the implementation looks good, there are a few considerations:
Let's verify the script path and permissions:
Consider these improvements:
- Add error handling for the case when format-code script is not found
- Use array expansion for files to handle paths with spaces:
-if ! "$scripts/format-code" --quiet --whatif --files="${files[*]}"; then +if [[ ! -x "$scripts/format-code" ]]; then + exit_ "Commit failed: format-code script not found or not executable" +fi +if ! "$scripts/format-code" --quiet --whatif --files="${files[@]}"; thenscripts/format-code (1)
36-76:⚠️ Potential issueInitialize flag variables
The script uses several flag variables (usage, verbose, quiet, whatif) but doesn't initialize them. This could lead to undefined behavior.
Add these initializations at the start of the script:
+# Initialize flags +usage=0 +verbose=0 +quiet=0 +whatif=0Validate option values
The script doesn't validate the values provided to --exclude-dirs and --include-exts.
Consider adding validation:
--exclude-dirs=*) userExcludeDirs="${opt#*=}" + if [[ -z "$userExcludeDirs" ]]; then + echo "Error: --exclude-dirs requires a value" + exit 1 + fi ;;scripts/format-code.ps1 (1)
105-157: LGTM! Well-documented help message.The help message is comprehensive, well-structured, and includes clear examples.
| ##============================================================================== | ||
| ## | ||
| ## Echo if whatif flag is specified but not quiet flag | ||
| ## | ||
| ##============================================================================== | ||
| log_whatif() | ||
| { | ||
| if [[ ${whatif} -eq 1 && ${quiet} -ne 1 ]]; then | ||
| echo "$1" | ||
| fi | ||
| } |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Enhance function documentation clarity
The comment for log_whatif could be more precise about the condition logic.
Consider updating the comment to:
-## Echo if whatif flag is specified but not quiet flag
+## Echo if both conditions are met:
+## 1. whatif flag is specified (whatif=1)
+## 2. quiet flag is not specified (quiet!=1)📝 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.
| ##============================================================================== | |
| ## | |
| ## Echo if whatif flag is specified but not quiet flag | |
| ## | |
| ##============================================================================== | |
| log_whatif() | |
| { | |
| if [[ ${whatif} -eq 1 && ${quiet} -ne 1 ]]; then | |
| echo "$1" | |
| fi | |
| } | |
| ##============================================================================== | |
| ## | |
| ## Echo if both conditions are met: | |
| ## 1. whatif flag is specified (whatif=1) | |
| ## 2. quiet flag is not specified (quiet!=1) | |
| ## | |
| ##============================================================================== | |
| log_whatif() | |
| { | |
| if [[ ${whatif} -eq 1 && ${quiet} -ne 1 ]]; then | |
| echo "$1" | |
| fi | |
| } |
| check_clang-format() | ||
| { | ||
| # First check explicitly for the clang-format-7 executable. | ||
| cf=$(command -v clang-format-7 2> /dev/null) | ||
|
|
||
| if [[ -x ${cf} ]]; then | ||
| cf="clang-format-7" | ||
| return | ||
| else | ||
| cf=$(command -v clang-format 2> /dev/null) | ||
| if [[ ! -x ${cf} ]]; then | ||
| echo "clang-format is not installed" | ||
| exit 1 | ||
| fi | ||
| cf="clang-format" | ||
| fi | ||
|
|
||
| local required_cfver='17.0.3' | ||
| # shellcheck disable=SC2155 | ||
| local cfver=$(${cf} --version | grep -o -E '[0-9]+\.[0-9]+\.[0-9]+' | head -1) | ||
| check_version "${required_cfver}" "${cfver}" | ||
| } |
There was a problem hiding this comment.
Revise clang-format version handling
Several issues with the version checking:
- The script preferentially looks for clang-format-7 but requires version 17.0.3
- The version comparison only warns but continues execution
- Function name
check_clang-formatuses a hyphen which is unconventional in Bash
Consider these changes:
-check_clang-format()
+check_clang_format()
{
- # First check explicitly for the clang-format-7 executable.
- cf=$(command -v clang-format-7 2> /dev/null)
-
- if [[ -x ${cf} ]]; then
- cf="clang-format-7"
- return
- else
- cf=$(command -v clang-format 2> /dev/null)
- if [[ ! -x ${cf} ]]; then
- echo "clang-format is not installed"
- exit 1
- fi
- cf="clang-format"
- fi
+ cf=$(command -v clang-format 2> /dev/null)
+ if [[ ! -x ${cf} ]]; then
+ echo "clang-format is not installed"
+ exit 1
+ fi
+ cf="clang-format"
local required_cfver='17.0.3'
# shellcheck disable=SC2155
local cfver=$(${cf} --version | grep -o -E '[0-9]+\.[0-9]+\.[0-9]+' | head -1)
- check_version "${required_cfver}" "${cfver}"
+ if ! check_version "${required_cfver}" "${cfver}"; then
+ exit 1
+ fi
}📝 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.
| check_clang-format() | |
| { | |
| # First check explicitly for the clang-format-7 executable. | |
| cf=$(command -v clang-format-7 2> /dev/null) | |
| if [[ -x ${cf} ]]; then | |
| cf="clang-format-7" | |
| return | |
| else | |
| cf=$(command -v clang-format 2> /dev/null) | |
| if [[ ! -x ${cf} ]]; then | |
| echo "clang-format is not installed" | |
| exit 1 | |
| fi | |
| cf="clang-format" | |
| fi | |
| local required_cfver='17.0.3' | |
| # shellcheck disable=SC2155 | |
| local cfver=$(${cf} --version | grep -o -E '[0-9]+\.[0-9]+\.[0-9]+' | head -1) | |
| check_version "${required_cfver}" "${cfver}" | |
| } | |
| check_clang_format() | |
| { | |
| cf=$(command -v clang-format 2> /dev/null) | |
| if [[ ! -x ${cf} ]]; then | |
| echo "clang-format is not installed" | |
| exit 1 | |
| fi | |
| cf="clang-format" | |
| local required_cfver='17.0.3' | |
| # shellcheck disable=SC2155 | |
| local cfver=$(${cf} --version | grep -o -E '[0-9]+\.[0-9]+\.[0-9]+' | head -1) | |
| if ! check_version "${required_cfver}" "${cfver}"; then | |
| exit 1 | |
| fi | |
| } |
| if [[ ${usage} -eq 1 ]]; then | ||
| cat<<EOF | ||
|
|
||
| OVERVIEW: | ||
|
|
||
| Formats all C/C++ source files based on the .clang-format rules | ||
|
|
||
| $ format-code [-h] [-q] [-s] [-v] [-w] [--exclude-dirs="..."] [--include-exts="..."] [--files="..."] | ||
|
|
||
| OPTIONS: | ||
| -h, --help Print this help message. | ||
| -q, --quiet Display only clang-format output and errors. | ||
| -s, --staged Only format files which are staged to be committed. | ||
| -v, --verbose Display verbose output. | ||
| -w, --whatif Run the script without actually modifying the files | ||
| and display the diff of expected changes, if any. | ||
| --exclude-dirs Subdirectories to exclude. If unspecified, then | ||
| ./external, ./packages and ./x64 are excluded. | ||
| All subdirectories are relative to the current path. | ||
| --include-exts File extensions to include for formatting. If | ||
| unspecified, then *.h, *.hpp, *.c, *.cpp, *idl, and | ||
| *.acf are included. | ||
| --files Only run the script against the specified files from | ||
| the current directory. | ||
|
|
||
| EXAMPLES: | ||
|
|
||
| To determine what lines of each file in the default configuration would be | ||
| modified by format-code, you can run from the root folder: | ||
|
|
||
| $ ./scripts/format-code -w | ||
|
|
||
| To update only all .c and .cpp files in src/ except for src/tools/netsh, you | ||
| can run from the src folder: | ||
|
|
||
| src$ ../scripts/format-code --exclude-dirs="tools/netsh" \ | ||
| --include-exts="c cpp" | ||
|
|
||
| To run only against a specified set of comma separated files in the current directory: | ||
|
|
||
| $ ./scripts/format-code -w --files="file1 file2" | ||
|
|
||
| EOF | ||
| exit 0 | ||
| fi |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Add version requirement to help message
The help message should mention the required clang-format version (17.0.3) to help users understand compatibility requirements.
Add to the overview section:
OVERVIEW:
Formats all C/C++ source files based on the .clang-format rules
+
+Requires clang-format version 17.0.3📝 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.
| if [[ ${usage} -eq 1 ]]; then | |
| cat<<EOF | |
| OVERVIEW: | |
| Formats all C/C++ source files based on the .clang-format rules | |
| $ format-code [-h] [-q] [-s] [-v] [-w] [--exclude-dirs="..."] [--include-exts="..."] [--files="..."] | |
| OPTIONS: | |
| -h, --help Print this help message. | |
| -q, --quiet Display only clang-format output and errors. | |
| -s, --staged Only format files which are staged to be committed. | |
| -v, --verbose Display verbose output. | |
| -w, --whatif Run the script without actually modifying the files | |
| and display the diff of expected changes, if any. | |
| --exclude-dirs Subdirectories to exclude. If unspecified, then | |
| ./external, ./packages and ./x64 are excluded. | |
| All subdirectories are relative to the current path. | |
| --include-exts File extensions to include for formatting. If | |
| unspecified, then *.h, *.hpp, *.c, *.cpp, *idl, and | |
| *.acf are included. | |
| --files Only run the script against the specified files from | |
| the current directory. | |
| EXAMPLES: | |
| To determine what lines of each file in the default configuration would be | |
| modified by format-code, you can run from the root folder: | |
| $ ./scripts/format-code -w | |
| To update only all .c and .cpp files in src/ except for src/tools/netsh, you | |
| can run from the src folder: | |
| src$ ../scripts/format-code --exclude-dirs="tools/netsh" \ | |
| --include-exts="c cpp" | |
| To run only against a specified set of comma separated files in the current directory: | |
| $ ./scripts/format-code -w --files="file1 file2" | |
| EOF | |
| exit 0 | |
| fi | |
| if [[ ${usage} -eq 1 ]]; then | |
| cat<<EOF | |
| OVERVIEW: | |
| Formats all C/C++ source files based on the .clang-format rules | |
| Requires clang-format version 17.0.3 | |
| $ format-code [-h] [-q] [-s] [-v] [-w] [--exclude-dirs="..."] [--include-exts="..."] [--files="..."] | |
| OPTIONS: | |
| -h, --help Print this help message. | |
| -q, --quiet Display only clang-format output and errors. | |
| -s, --staged Only format files which are staged to be committed. | |
| -v, --verbose Display verbose output. | |
| -w, --whatif Run the script without actually modifying the files | |
| and display the diff of expected changes, if any. | |
| --exclude-dirs Subdirectories to exclude. If unspecified, then | |
| ./external, ./packages and ./x64 are excluded. | |
| All subdirectories are relative to the current path. | |
| --include-exts File extensions to include for formatting. If | |
| unspecified, then *.h, *.hpp, *.c, *.cpp, *idl, and | |
| *.acf are included. | |
| --files Only run the script against the specified files from | |
| the current directory. | |
| EXAMPLES: | |
| To determine what lines of each file in the default configuration would be | |
| modified by format-code, you can run from the root folder: | |
| $ ./scripts/format-code -w | |
| To update only all .c and .cpp files in src/ except for src/tools/netsh, you | |
| can run from the src folder: | |
| src$ ../scripts/format-code --exclude-dirs="tools/netsh" \ | |
| --include-exts="c cpp" | |
| To run only against a specified set of comma separated files in the current directory: | |
| $ ./scripts/format-code -w --files="file1 file2" | |
| EOF | |
| exit 0 | |
| fi |
| findargs='find .' | ||
|
|
||
| get_find_args() | ||
| { | ||
| local defaultExcludeDirs='./.git ./external ./packages ./x64' | ||
| local defaultIncludeExts='h hpp c cpp idl acf' | ||
|
|
||
| if [[ -z ${userExcludeDirs} ]]; then | ||
| read -r -a excludeDirs <<< "${defaultExcludeDirs}" | ||
| else | ||
| log_verbose "Using user directory exclusions: ${userExcludeDirs}" | ||
| read -r -a excludeDirs <<< "${userExcludeDirs}" | ||
| fi | ||
|
|
||
| for exc in "${excludeDirs[@]}" | ||
| do | ||
| findargs="${findargs} ! \( -path '${exc}' -prune \)" | ||
| done | ||
|
|
||
| if [[ -z ${userIncludeExts} ]]; then | ||
| # not local as this is used in get_file_list() too | ||
| read -r -a includeExts <<< "${defaultIncludeExts}" | ||
| else | ||
| log_verbose "Using user extension inclusions: ${userIncludeExts}" | ||
| read -r -a includeExts <<< "${userIncludeExts}" | ||
| fi | ||
|
|
||
| findargs="${findargs} \(" | ||
| for ((i=0; i<${#includeExts[@]}; i++)); | ||
| do | ||
| findargs="${findargs} -iname '*.${includeExts[$i]}'" | ||
| if [[ $((i + 1)) -lt ${#includeExts[@]} ]]; then | ||
| findargs="${findargs} -o" | ||
| fi | ||
| done | ||
| findargs="${findargs} \)" | ||
| } | ||
|
|
||
| get_find_args | ||
|
|
||
| log_verbose "Query for files for format:" | ||
| log_verbose "${findargs}" | ||
| log_verbose "" | ||
|
|
There was a problem hiding this comment.
Improve file finding security and validation
The current implementation has potential security and robustness issues:
- Command injection possible through userExcludeDirs
- No validation that found files exist and are readable
Consider these improvements:
for exc in "${excludeDirs[@]}"
do
+ # Validate directory name
+ if [[ "$exc" =~ [^a-zA-Z0-9_./-] ]]; then
+ echo "Invalid directory name: $exc"
+ exit 1
+ fi
findargs="${findargs} ! \( -path '${exc}' -prune \)"
doneAlso add file validation:
get_file_list()
{
if [[ -z "${userFiles[*]}" ]]; then
mapfile -t file_list < <(eval "$findargs")
if [[ ${#file_list[@]} -eq 0 ]]; then
echo "No files were found to format!"
exit 1
fi
+ # Validate files
+ for file in "${file_list[@]}"; do
+ if [[ ! -r "$file" ]]; then
+ echo "Cannot read file: $file"
+ exit 1
+ fi
+ done
elseCommittable suggestion was skipped due to low confidence.
|
|
||
| $findargs+=" -Include @( " | ||
| foreach ($ext in $includeExts) | ||
| { | ||
| $findargs+=("'*."+"$ext'") | ||
| if ($includeExts.IndexOf($ext) -lt $includeExts.count-1) | ||
| { | ||
| $findargs+=", " | ||
| } | ||
| } | ||
| $findargs+=") " | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Simplify string concatenation using array join.
The current string concatenation could be simplified using array join for better readability and maintainability.
- $findargs+=" -Include @( "
- foreach ($ext in $includeExts)
- {
- $findargs+=("'*."+"$ext'")
- if ($includeExts.IndexOf($ext) -lt $includeExts.count-1)
- {
- $findargs+=", "
- }
- }
- $findargs+=") "
+ $findargs += " -Include @('" + ($includeExts | ForEach-Object { "*.$_" } | Join-String -Separator "', '") + "') "📝 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.
| $findargs+=" -Include @( " | |
| foreach ($ext in $includeExts) | |
| { | |
| $findargs+=("'*."+"$ext'") | |
| if ($includeExts.IndexOf($ext) -lt $includeExts.count-1) | |
| { | |
| $findargs+=", " | |
| } | |
| } | |
| $findargs+=") " | |
| $findargs += " -Include @('" + ($includeExts | ForEach-Object { "*.$_" } | Join-String -Separator "', '") + "') " |
| "--exclude-dirs=*" { | ||
| $userExcludeDirs=($opt -split "=")[1]; | ||
| break; | ||
| } | ||
|
|
||
| "--include-exts=*" { | ||
| $userIncludeExts=($opt -split "=")[1]; | ||
| break; | ||
| } |
There was a problem hiding this comment.
Add input validation for exclude-dirs and include-exts.
The script should validate the user input for these parameters to ensure they contain valid directory names and file extensions.
"--exclude-dirs=*" {
- $userExcludeDirs=($opt -split "=")[1];
+ $dirs = ($opt -split "=")[1]
+ if ($dirs -match '^[a-zA-Z0-9_/.-]+(\s+[a-zA-Z0-9_/.-]+)*$') {
+ $userExcludeDirs = $dirs
+ } else {
+ Write-Error "Invalid directory names in --exclude-dirs"
+ exit 1
+ }
break;
}
"--include-exts=*" {
- $userIncludeExts=($opt -split "=")[1];
+ $exts = ($opt -split "=")[1]
+ if ($exts -match '^[a-zA-Z0-9]+(\s+[a-zA-Z0-9]+)*$') {
+ $userIncludeExts = $exts
+ } else {
+ Write-Error "Invalid file extensions in --include-exts"
+ exit 1
+ }
break;
}📝 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.
| "--exclude-dirs=*" { | |
| $userExcludeDirs=($opt -split "=")[1]; | |
| break; | |
| } | |
| "--include-exts=*" { | |
| $userIncludeExts=($opt -split "=")[1]; | |
| break; | |
| } | |
| "--exclude-dirs=*" { | |
| $dirs = ($opt -split "=")[1] | |
| if ($dirs -match '^[a-zA-Z0-9_/.-]+(\s+[a-zA-Z0-9_/.-]+)*$') { | |
| $userExcludeDirs = $dirs | |
| } else { | |
| Write-Error "Invalid directory names in --exclude-dirs" | |
| exit 1 | |
| } | |
| break; | |
| } | |
| "--include-exts=*" { | |
| $exts = ($opt -split "=")[1] | |
| if ($exts -match '^[a-zA-Z0-9]+(\s+[a-zA-Z0-9]+)*$') { | |
| $userIncludeExts = $exts | |
| } else { | |
| Write-Error "Invalid file extensions in --include-exts" | |
| exit 1 | |
| } | |
| break; | |
| } |
| foreach ( $file_name in $userfiles ) { | ||
| $user_file_name = get-ChildItem -Path '.' -Name $file_name | ||
| $file = New-Object System.IO.FileInfo($user_file_name) | ||
| foreach ( $ext in $includeExts ) { | ||
| if ( $file.Extension -eq ".$ext" ) { | ||
| $file_list += $file_name | ||
| log_verbose "Checking user file: $file_name" | ||
| break; | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Add error handling for non-existent files and fix potential path traversal.
The script should validate file existence and sanitize file paths to prevent path traversal attacks.
foreach ( $file_name in $userfiles ) {
- $user_file_name = get-ChildItem -Path '.' -Name $file_name
- $file = New-Object System.IO.FileInfo($user_file_name)
+ try {
+ # Resolve full path and ensure it's under current directory
+ $full_path = Resolve-Path -Path $file_name -ErrorAction Stop
+ if (-not $full_path.Path.StartsWith((Get-Location).Path)) {
+ Write-Error "File path '$file_name' is outside current directory"
+ continue
+ }
+ $file = Get-Item -Path $full_path -ErrorAction Stop
+ } catch {
+ Write-Error "Invalid or inaccessible file: $file_name"
+ continue
+ }📝 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.
| foreach ( $file_name in $userfiles ) { | |
| $user_file_name = get-ChildItem -Path '.' -Name $file_name | |
| $file = New-Object System.IO.FileInfo($user_file_name) | |
| foreach ( $ext in $includeExts ) { | |
| if ( $file.Extension -eq ".$ext" ) { | |
| $file_list += $file_name | |
| log_verbose "Checking user file: $file_name" | |
| break; | |
| } | |
| } | |
| } | |
| foreach ( $file_name in $userfiles ) { | |
| try { | |
| # Resolve full path and ensure it's under current directory | |
| $full_path = Resolve-Path -Path $file_name -ErrorAction Stop | |
| if (-not $full_path.Path.StartsWith((Get-Location).Path)) { | |
| Write-Error "File path '$file_name' is outside current directory" | |
| continue | |
| } | |
| $file = Get-Item -Path $full_path -ErrorAction Stop | |
| } catch { | |
| Write-Error "Invalid or inaccessible file: $file_name" | |
| continue | |
| } | |
| foreach ( $ext in $includeExts ) { | |
| if ( $file.Extension -eq ".$ext" ) { | |
| $file_list += $file_name | |
| log_verbose "Checking user file: $file_name" | |
| break; | |
| } | |
| } | |
| } |
There was a problem hiding this comment.
A couple of questions:
- Why specifically release 17.0.3? I now see that
BreakAfterAttributes: Alwayswas introduced in v16. - Can you check that the version is at least required_cfver, not equivalent to it?
- How about using git-clang-format? I've just find out about it, and it has the benefit of not bloating the diff when some previous commit was not properly formatted.
This code was taken from eBPF for Windows repo, so may need some tweaks. 17.0.3 was selected as that's the version that eBPF for Windows mandates (or rather that's the version that ships with Visual Studio and is compiled by MSFT and hence is considered safer from supply chain attacks). Follow-ups:
Note: |
Signed-off-by: Alan Jowett <[email protected]> Co-authored-by: Dave Thaler <[email protected]>
This pull request introduces two new scripts,
format-codeandformat-code.ps1, to format C/C++ source files based on.clang-formatrules. Additionally, it updates thepre-commitscript to include a formatting check. Here are the most important changes:New Formatting Scripts:
scripts/format-code: Added a Bash script to format C/C++ source files. It includes options for verbose output, quiet mode, staged files, and what-if scenarios. It also checks for an acceptable version ofclang-formatand processes command-line options.scripts/format-code.ps1: Added a PowerShell script with similar functionality to the Bash script, including handling of command-line options and checking forclang-format. It also includes verbose and what-if modes.Pre-commit Hook Update:
scripts/pre-commit: Updated to include a call to the newformat-codescript to check for formatting issues before committing. If formatting issues are found, the commit is aborted with instructions to fix the formatting.Summary by CodeRabbit
New Features
format-codescripts for formatting C/C++ source files according to.clang-formatrules, available in both Bash and PowerShell.Bug Fixes