cpp client code format

Author: hongzhi-gao

.clang-format

@@ -0,0 +1,15 @@
+---
+BasedOnStyle: LLVM
+IndentWidth: 2
+TabWidth: 2
+UseTab: Never
+ColumnLimit: 100
+BreakBeforeBraces: Attach
+AllowShortIfStatementsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Empty
+PointerAlignment: Left
+DerivePointerAlignment: false
+SortIncludes: false
+ReflowComments: false
+Standard: c++11
+...

.github/workflows/client-cpp-package.yml

@@ -87,7 +87,8 @@ jobs:
         run: |
           set -euxo pipefail
           sudo apt-get update
-          sudo apt-get install -y libboost-all-dev openssl libssl-dev
+          sudo apt-get install -y libboost-all-dev openssl libssl-dev clang-format-17
+          clang-format-17 --version
       - name: Cache Maven packages
         uses: actions/cache@v5
         with:
@@ -99,9 +100,7 @@ jobs:
         shell: bash
         run: |
           set -euxo pipefail
-          ./mvnw clean package -P with-cpp -pl iotdb-client/client-cpp -am \
-            -DskipTests \
-            -Dspotless.check.skip=true -Dspotless.apply.skip=true
+          ./mvnw clean package -P with-cpp -pl iotdb-client/client-cpp -am -DskipTests
       - name: Upload zip artifact
         uses: actions/upload-artifact@v6
         with:
@@ -133,7 +132,9 @@ jobs:
         shell: bash
         run: |
           set -euxo pipefail
-          brew install boost openssl
+          brew install boost openssl llvm@17
+          echo "$(brew --prefix llvm@17)/bin" >> "$GITHUB_PATH"
+          clang-format --version
       - name: Cache Maven packages
         uses: actions/cache@v5
         with:
@@ -147,9 +148,7 @@ jobs:
           MACOSX_DEPLOYMENT_TARGET: "12.0"
         run: |
           set -euxo pipefail
-          ./mvnw clean package -P with-cpp -pl iotdb-client/client-cpp -am \
-            -DskipTests \
-            -Dspotless.check.skip=true -Dspotless.apply.skip=true
+          ./mvnw clean package -P with-cpp -pl iotdb-client/client-cpp -am -DskipTests
       - name: Upload zip artifact
         uses: actions/upload-artifact@v6
         with:
@@ -194,6 +193,8 @@ jobs:
           $sslPath = (Get-ChildItem 'C:\Program Files\OpenSSL*' -Directory | Select-Object -First 1).FullName
           echo "$sslPath\bin" >> $env:GITHUB_PATH
           echo "OPENSSL_ROOT_DIR=$sslPath" >> $env:GITHUB_ENV
+          choco install llvm --version=17.0.6 -y
+          clang-format --version
       - name: Cache Maven packages
         uses: actions/cache@v5
         with:
@@ -208,9 +209,7 @@ jobs:
           IOTDB_TOOLS_THRIFT_VERSION: ${{ matrix.iotdb_tools_thrift_version }}
         run: |
           set -euxo pipefail
-          MVN_ARGS=(./mvnw clean package -P with-cpp -pl iotdb-client/client-cpp -am \
-            -DskipTests \
-            -Dspotless.check.skip=true -Dspotless.apply.skip=true)
+          MVN_ARGS=(./mvnw clean package -P with-cpp -pl iotdb-client/client-cpp -am -DskipTests)
           if [ -n "${CMAKE_GENERATOR:-}" ]; then
             MVN_ARGS+=("-Dcmake.generator=${CMAKE_GENERATOR}")
           fi

.github/workflows/multi-language-client.yml

@@ -55,15 +55,18 @@ jobs:
         shell: bash
         run: |
           sudo apt-get update
-          sudo apt-get install libboost-all-dev
-          sudo apt-get install openssl libssl-dev
+          sudo apt-get install -y libboost-all-dev
+          sudo apt-get install -y openssl libssl-dev clang-format-17
+          clang-format-17 --version
       - name: Install CPP Dependencies (Mac)
         # remove some xcode to release disk space
         if: runner.os == 'macOS'
         shell: bash
         run: |
           brew install boost
-          brew install openssl
+          brew install openssl llvm@17
+          echo "$(brew --prefix llvm@17)/bin" >> "$GITHUB_PATH"
+          clang-format --version
           sudo rm -rf /Applications/Xcode_14.3.1.app
           sudo rm -rf /Applications/Xcode_15.0.1.app
           sudo rm -rf /Applications/Xcode_15.1.app
@@ -72,21 +75,28 @@ jobs:
       - name: Install CPP Dependencies (Windows)
         if: runner.os == 'Windows'
         run: |
-          choco install winflexbison3
-          choco install boost-msvc-14.3
+          choco install winflexbison3 -y
+          choco install boost-msvc-14.3 -y
           $boost_path = (Get-ChildItem -Path 'C:\local\' -Filter 'boost_*').FullName
           echo $boost_path >> $env:GITHUB_PATH
           
-          choco install openssl
+          choco install openssl -y
           $sslPath = (Get-ChildItem 'C:\Program Files\OpenSSL*' -Directory | Select-Object -First 1).FullName
           echo "$sslPath\bin" >> $env:GITHUB_PATH
           echo "OPENSSL_ROOT_DIR=$sslPath" >> $env:GITHUB_ENV
+          choco install llvm --version=17.0.6 -y
+          clang-format --version
       - name: Cache Maven packages
         uses: actions/cache@v5
         with:
           path: ~/.m2
           key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
           restore-keys: ${{ runner.os }}-m2-
+      - name: Check C++ format (Spotless)
+        shell: bash
+        run: |
+          ./mvnw -P with-cpp -pl iotdb-client/client-cpp spotless:check
+          ./mvnw -P with-cpp -pl example/client-cpp-example spotless:check
       - name: Build IoTDB server
         shell: bash
         run: ./mvnw clean install -pl distribution -am -DskipTests

CONTRIBUTING.md

@@ -107,6 +107,31 @@ plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven) together wi
    import static all other imports
 ```
 
+### C++ formatting
+
+- Formatter: `clang-format` only
+- Version: `17.0.6` (must match CI)
+- Entrypoint: Maven Spotless
+
+Check only:
+
+`./mvnw -P with-cpp -pl iotdb-client/client-cpp spotless:check`
+
+`./mvnw -P with-cpp -pl example/client-cpp-example spotless:check`
+
+Auto-fix:
+
+`./mvnw -P with-cpp -pl iotdb-client/client-cpp spotless:apply`
+
+`./mvnw -P with-cpp -pl example/client-cpp-example spotless:apply`
+
+On Windows PowerShell, a comma inside `-pl` can be parsed incorrectly; use the two commands above, or quote the full `-pl` value, for example `./mvnw -P with-cpp "-pl=iotdb-client/client-cpp,example/client-cpp-example" spotless:check`.
+
+Temporarily skip Spotless (not recommended except emergency CI triage):
+
+`-Dspotless.skip=true`
+
+Risk: skipping formatting checks can introduce style drift between contributors and CI, and often causes follow-up format-only commits.
 
 ## Contributing code