Refactor/clang style (#175)

Author: thomaslaurenson

.clang-format

@@ -1,9 +1,8 @@
-BasedOnStyle: Google
-PointerAlignment: Right
-DerivePointerAlignment: false
-ColumnLimit: 100
+BasedOnStyle: LLVM
 IndentWidth: 4
+ColumnLimit: 100
 AccessModifierOffset: -4
+AllowShortFunctionsOnASingleLine: InlineOnly
 IncludeBlocks: Regroup
 IncludeIsMainRegex: '([-_]test)?$'
 IncludeCategories:
@@ -13,8 +12,3 @@ IncludeCategories:
     Priority: 1
   - Regex: '^"'
     Priority: 3
-ReflowComments: true
-BreakBeforeBraces: Attach
-Cpp11BracedListStyle: true
-AllowShortFunctionsOnASingleLine: InlineOnly
-SortIncludes: true

.clang-tidy

@@ -15,3 +15,16 @@ Checks: >
   readability-container-size-empty
 WarningsAsErrors: "*"
 FormatStyle: file
+CheckOptions:
+  - { key: readability-identifier-naming.FunctionCase,        value: CamelCase  }
+  - { key: readability-identifier-naming.MethodCase,          value: CamelCase  }
+  - { key: readability-identifier-naming.ClassCase,           value: CamelCase  }
+  - { key: readability-identifier-naming.StructCase,          value: CamelCase  }
+  - { key: readability-identifier-naming.EnumCase,            value: CamelCase  }
+  - { key: readability-identifier-naming.EnumConstantCase,    value: UPPER_CASE }
+  - { key: readability-identifier-naming.VariableCase,        value: lower_case }
+  - { key: readability-identifier-naming.ParameterCase,       value: lower_case }
+  - { key: readability-identifier-naming.MemberCase,          value: lower_case }
+  - { key: readability-identifier-naming.PrivateMemberCase,   value: lower_case }
+  - { key: readability-identifier-naming.PrivateMemberSuffix, value: _          }
+  - { key: readability-identifier-naming.ConstantCase,        value: lower_case }

.github/workflows/pr.yml

@@ -14,7 +14,7 @@ on:
       - "Dockerfile.musl"
 
 permissions:
-  contents: write
+  contents: read
 
 jobs:
   build:

.github/workflows/release.yml

@@ -10,10 +10,16 @@ permissions:
 jobs:
   release_binaries:
     runs-on: ubuntu-24.04
+    outputs:
+      version: ${{ steps.version.outputs.version }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v6
 
+      - name: Resolve release version
+        id: version
+        run: echo "version=$(make get_project_version)" >> "$GITHUB_OUTPUT"
+
       - name: Download Linux GLIBC binary
         uses: actions/download-artifact@v8
         with:
@@ -39,13 +45,14 @@ jobs:
         with:
           name: mpqcli-windows-amd64.exe
 
-      - name: Extract latest changelog section
+      - name: Extract changelog for this tag
         id: changelog
         run: |
-          CHANGELOG_CONTENT=$(awk '/^## /{i++} i==1{print}' CHANGELOG.md | tail -n +2)
-          echo "content<<EOF" >> $GITHUB_OUTPUT
-          echo "$CHANGELOG_CONTENT" >> $GITHUB_OUTPUT
-          echo "EOF" >> $GITHUB_OUTPUT
+          {
+            echo "content<<EOF"
+            make get_changelog TAG="${{ steps.version.outputs.version }}"
+            echo "EOF"
+          } >> "$GITHUB_OUTPUT"
 
       - name: Release package
         run: |
@@ -74,17 +81,13 @@ jobs:
         run: |
           docker load -i mpqcli-docker.tar
 
-      - name: Extract version without "v"
-        id: version
-        run: echo "VERSION=${GITHUB_REF_NAME#v}" >> $GITHUB_ENV
-
       - name: Tag Docker image with version
         run: |
-          docker tag mpqcli ghcr.io/thegraydot/mpqcli:${{ env.VERSION }}
+          docker tag mpqcli ghcr.io/thegraydot/mpqcli:${{ needs.release_binaries.outputs.version }}
           docker tag mpqcli ghcr.io/thegraydot/mpqcli:latest
 
       - name: Push Docker image to GitHub Container Registry
         run: |
           echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
-          docker push ghcr.io/thegraydot/mpqcli:${{ env.VERSION }}
+          docker push ghcr.io/thegraydot/mpqcli:${{ needs.release_binaries.outputs.version }}
           docker push ghcr.io/thegraydot/mpqcli:latest

.github/workflows/test.yml

@@ -4,7 +4,7 @@ on:
   workflow_call
 
 permissions:
-  contents: write
+  contents: read
 
 jobs:
   test_linux:

CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 0.10.1 - 2026-07-03
+
+### Added
+
+- Command completion for common shells (bash, zsh, fish and powershell)
+
+### Fixed
+
+- Memory leak in read subcommand
+- Inconsistencies in documentation
+
+### Updated
+
+- Code style to conform to Google CPP style with slight variations
+- StormLib dependency for a variety of fixes
+
+### Thanks
+
+- Thanks to @sjoblomj for the contributions in this release
+
 ## 0.10.0 - 2026-06-07
 
 ### Added

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.10)
 
-project(MPQCLI VERSION 0.10.0)
+project(MPQCLI VERSION 0.10.1)
 
 # Options
 option(BUILD_MPQCLI "Build the mpqcli CLI app" ON)
@@ -25,11 +25,17 @@ if(BUILD_STATIC)
 endif()
 
 # Determine git commit hash
-execute_process (
+execute_process(
     COMMAND git rev-parse HEAD
+    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
     OUTPUT_STRIP_TRAILING_WHITESPACE
     OUTPUT_VARIABLE GIT_COMMIT_HASH
+    RESULT_VARIABLE GIT_COMMIT_RESULT
+    ERROR_QUIET
 )
+if(NOT GIT_COMMIT_RESULT EQUAL 0 OR NOT GIT_COMMIT_HASH)
+    set(GIT_COMMIT_HASH "unknown")
+endif()
 
 # Handle StormLib dependency
 if (NOT EXISTS "${CMAKE_SOURCE_DIR}/extern/StormLib/CMakeLists.txt")

CONTRIBUTING.md

@@ -31,6 +31,7 @@ Run `make help` to list all available targets. Common ones:
 | Target                     | Description                                                        |
 |----------------------------|--------------------------------------------------------------------|
 | `make install_clang_tools` | Install clang-format and clang-tidy via apt                        |
+| `make configure`           | Configure cmake build with clang (required before `make lint`)     |
 | `make build_linux`         | Build for Linux using cmake                                        |
 | `make build_windows`       | Build for Windows using cmake                                      |
 | `make build_clean`         | Remove the cmake build directory                                   |
@@ -72,9 +73,10 @@ If your change adds or modifies user-facing functionality - such as a new subcom
 
 ### 4. Linting must pass
 
-All C++ code is formatted with clang-format and analysed with clang-tidy. Run the full suite before submitting:
+All C++ code is formatted with clang-format and analysed with clang-tidy. `clang-tidy` needs a compile database generated with clang, so run `make configure` first (`make build_linux`/`make build_windows` alone will not work, since they don't set up the compiler flags clang-tidy needs):
 
 ```
+make configure
 make lint
 ```
 
@@ -88,7 +90,7 @@ Then re-run `make lint` to confirm everything passes.
 
 ### 5. Match the existing code style
 
-C++ formatting is enforced by `.clang-format` (Google style base). Static analysis is enforced by `.clang-tidy`. Both configs live in the repo root. Python tests should follow the style of the existing test files.
+C++ formatting is enforced by `.clang-format` (LLVM style base). Static analysis is enforced by `.clang-tidy`. Both configs live in the repo root. Python tests should follow the style of the existing test files.
 
 #### Suppression policy
 
@@ -106,7 +108,8 @@ Suppressions are occasionally necessary for third-party code or intentional patt
 Use `// clang-format off` / `// clang-format on` only when the default formatting genuinely hurts readability (e.g. column-aligned tables). Add a brief comment explaining the intent:
 
 ```cpp
-// clang-format off: preserve column-aligned flag-to-char mappings for readability
+// Preserve column-aligned flag-to-char mappings for readability
+// clang-format off
 if (flags & MPQ_FILE_IMPLODE)   result += 'i';
 if (flags & MPQ_FILE_COMPRESS)  result += 'c';
 // clang-format on
@@ -131,6 +134,6 @@ If you add a new StormLib call that is locale-sensitive, follow the existing pat
 2. Run `git submodule update --init --recursive` after cloning
 3. Run `make install_clang_tools` to install lint dependencies
 4. Make your changes and verify they build: `make build_linux`
-5. Run `make lint` and fix any issues
+5. Run `make configure` and then `make lint`, fixing any issues
 6. Run `make test_mpqcli` and confirm all tests pass
 7. Open a pull request with a clear description of what was changed and why

README.md

@@ -4,7 +4,7 @@
 
 ![Release Version](https://img.shields.io/github/v/release/thegraydot/mpqcli?style=flat)
 
-![Release downloads](https://img.shields.io/github/downloads/thegraydot/mpqcli/total?label=release_downloads) ![Package downloads](https://img.shields.io/badge/package_downloads-894-green)
+![Release downloads](https://img.shields.io/github/downloads/thegraydot/mpqcli/total?label=release_downloads) ![Package downloads](https://img.shields.io/badge/package_downloads-996-green)
 
 A command-line tool to create, add, remove, list, extract, read, and verify MPQ archives using the [StormLib library](https://github.com/ladislav-zezula/StormLib).
 

docs/commands/completion.md

@@ -21,7 +21,7 @@ $ source ~/.bash_completion.d/mpqcli
 Alternatively, write the script to a system-wide completions directory (requires root):
 
 ```bash
-$ mpqcli completion bash > /etc/bash_completion.d/mpqcli
+$ mpqcli completion bash | sudo tee /etc/bash_completion.d/mpqcli > /dev/null
 ```
 
 ## Zsh
@@ -32,18 +32,18 @@ Write the completion script to a directory that is on your `$fpath`.
 $ mpqcli completion zsh > "${fpath[1]}/_mpqcli"
 ```
 
-## PowerShell
-
-Append the completion script to your PowerShell profile so it loads automatically.
-
-```powershell
-PS> mpqcli completion powershell >> $PROFILE
-```
-
 ## Fish
 
 Write the completion script to the fish completions directory.
 
 ```fish
 $ mpqcli completion fish > ~/.config/fish/completions/mpqcli.fish
 ```
+
+## PowerShell
+
+Append the completion script to your PowerShell profile so it loads automatically.
+
+```powershell
+PS> mpqcli completion powershell >> $PROFILE
+```