metadata changes

- move pre-commit local hooks into CI workflow and call org's reusable workflow
- separate CLI options into categories and add a version subcommand (to print cpp-linter version)
- consolidate cpp-linter-cli crate into cpp-linter-lib crate.
- add vscode workspace config for recommended extensions
- increment version in toml during CI runs

Author: 2bndy5

.gitattributes

@@ -5,6 +5,9 @@
 # to native line endings on checkout.
 *.py text eol=lf
 *.rst text eol=lf
+*.rs text eol=lf
+*.yaml text eol=lf
+*.yml text eol=lf
 *.sh text eol=lf
 *.cpp text eol=lf
 *.hpp text eol=lf

.github/dependabot.yml

@@ -0,0 +1,23 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: "weekly"
+    groups:
+      actions:
+        patterns:
+          - "*"
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: "daily"
+    groups:
+      pip:
+        patterns:
+          - "*"

.github/workflows/binary-builds.yml

@@ -53,16 +53,6 @@ jobs:
     permissions:
       contents: write
     steps:
-      - name: Calculate Release Version
-        id: calc-version
-        run: |
-          if [ "${{ github.event_name }}" = "pull_request" ]; then
-            short_sha=$(echo "${{ github.sha }}" | awk '{print substr($0,0,5)}')
-            echo "RELEASE_VERSION=nightly-$(date '+%Y-%m-%d')-$short_sha" >> $GITHUB_OUTPUT
-          else
-            echo "RELEASE_VERSION=${{ github.ref_name }}" >> $GITHUB_OUTPUT
-          fi
-
       - name: Install native OpenSSL on Linux
         if: runner.os == 'Linux' && !(startsWith(matrix.target, 'aarch64') || endsWith(matrix.target, 'musl'))
         run: sudo apt-get install -y pkg-config libssl-dev
@@ -94,6 +84,15 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - uses: actions/setup-python@v5
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          python-version: '3.x'
+
+      - name: Increment version
+        if: startsWith(github.ref, 'refs/tags/')
+        run: python .github/workflows/replace_version_spec.py --new-version=${{ github.ref_name }}
+
       - name: Setup Rust
         uses: dtolnay/rust-toolchain@stable
         with:
@@ -111,41 +110,21 @@ jobs:
         env:
           # problems with cross-compiling aarch64 linux with gnu
           CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER: /usr/bin/aarch64-linux-gnu-gcc
-        run: cargo build --manifest-path cpp-linter-cli/Cargo.toml --release --bin cpp-linter-cli --target ${{ matrix.target }} ${{ steps.is-openssl-vendored.outputs.enabled }}
+        run: cargo build --manifest-path cpp-linter-lib/Cargo.toml --release --bin cpp-linter --target ${{ matrix.target }} ${{ steps.is-openssl-vendored.outputs.enabled }}
 
-      - name: Prepare artifacts [Windows]
-        shell: bash
-        if: matrix.os == 'windows-latest'
-        id: prep-artifacts-windows
-        run: |
-          release_dir="cpp-linter-cli-${{ steps.calc-version.outputs.RELEASE_VERSION }}"
-          artifact_path="cpp-linter-cli-${{ steps.calc-version.outputs.RELEASE_VERSION }}-${{ matrix.target }}.zip"
-          echo "ARTIFACT_PATH=$artifact_path" >> $GITHUB_OUTPUT
-          mkdir $release_dir
-          cp target/${{ matrix.target }}/release/cpp-linter-cli.exe $release_dir/
-          cp LICENSE $release_dir/
-          7z a -tzip $artifact_path $release_dir/
-      - name: Prepare artifacts [Unix]
-        shell: bash
-        id: prep-artifacts-unix
-        if: matrix.os != 'windows-latest'
-        run: |
-          release_dir="cpp-linter-cli-${{ steps.calc-version.outputs.RELEASE_VERSION }}"
-          artifact_path="cpp-linter-cli-${{ steps.calc-version.outputs.RELEASE_VERSION }}-${{ matrix.target }}.tar.gz"
-          echo "ARTIFACT_PATH=$artifact_path" >> $GITHUB_OUTPUT
-          mkdir $release_dir
-          cp target/${{ matrix.target }}/release/cpp-linter-cli $release_dir/
-          cp LICENSE $release_dir
-          tar -czvf $artifact_path $release_dir/
+      - name: Prepare artifacts
+        run: mv target/${{ matrix.target }}/release/cpp-linter${{ runner.os == 'Windows' && '.exe' || '' }} ./cpp-linter${{ runner.os == 'Windows' && '.exe' || '' }}
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         with:
-          name: ${{ steps.prep-artifacts-unix.outputs.ARTIFACT_PATH || steps.prep-artifacts-windows.outputs.ARTIFACT_PATH }}
-          path: ${{ steps.prep-artifacts-unix.outputs.ARTIFACT_PATH || steps.prep-artifacts-windows.outputs.ARTIFACT_PATH }}
+          name: cpp-linter-${{ matrix.target }}
+          path: |
+            cpp-linter-${{ matrix.target }}
+            cpp-linter-${{ matrix.target }}.exe
           if-no-files-found: error
 
   create-release:
-    if: startswith(github.ref, 'refs/tags')
+    if: startswith(github.ref, 'refs/tagsv')
     runs-on: ubuntu-latest
     needs: [create-assets]
     permissions:
@@ -156,38 +135,24 @@ jobs:
           persist-credentials: false
       - name: Install Rust
         run: rustup update stable --no-self-update
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+      - name: Increment version
+        run: python .github/workflows/replace_version_spec.py --new-version=${{ github.ref_name }}
       - run: cargo package
+      - name: Download built assets
+        uses: actions/download-artifact@v4
+        with:
+          pattern: cpp-linter-*
+          path: dist
       - name: Create a Github Release
-        if: ${{ startsWith(github.ref, 'refs/tags/v') }}
         env:
           GH_TOKEN: ${{ github.token }}
-        run: gh release create ${{ github.ref_name }} --generate-notes
+        run: |
+          files=$(ls dist/mdbook-alerts_*/*{tar.gz,zip})
+          gh release create ${{ github.ref_name }} --generate-notes $files
       - run: cargo publish
         working-directory: cpp-linter-lib
         env:
           CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
-
-  upload-assets:
-    needs: [create-release]
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        target:
-          - aarch64-unknown-linux-gnu
-          # skip this target due to cross-compiling OpenSSL for musl C lib
-          # - aarch64-unknown-linux-musl
-          - x86_64-unknown-linux-gnu
-          - x86_64-unknown-linux-musl
-          - aarch64-apple-darwin
-          - x86_64-apple-darwin
-          - x86_64-pc-windows-msvc
-    steps:
-      - name: Download build asset
-        uses: actions/download-artifact@v4
-        with:
-          name: cpp-linter-cli-${{ matrix.target }}
-          path: dist
-      - name: Upload release assets
-        env:
-          GH_TOKEN: ${{ github.token }}
-        run: gh release upload ${{ github.ref_name }} dist/cpp-linter-cli${{ contains(matrix.target, 'windows') || '.exe' }}%#%cpp-linter-cli_${{ matrix.target }} --clobber

.github/workflows/build-docs.yml

@@ -3,35 +3,20 @@ name: Docs
 on: [push, workflow_dispatch]
 
 jobs:
-  build:
-    permissions:
-      contents: write
+  build-sphinx:
+    uses: cpp-linter/.github/.github/workflows/sphinx.yml@main
+    with:
+      path-to-doc: cpp-linter-py/docs/_build/html
+      project-root: cpp-linter-py
+
+  build-rustdoc:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3.x
-
-      - name: Install docs dependencies
-        working-directory: cpp-linter-py
-        run: pip install -r docs/requirements.txt
-
-      - name: Build docs
-        working-directory: cpp-linter-py
-        run: sphinx-build docs docs/_build/html
-
-      - name: upload docs build as artifact
+      - run: rustup update --no-self-update
+      - run: cargo doc --no-deps --manifest-path cpp-linter-lib/Cargo.toml
+      - name: upload rustdoc build as artifact
         uses: actions/upload-artifact@v4
         with:
-          name: "cpp-linter-py-docs"
-          path: cpp-linter-py/docs/_build/html
-
-      - name: upload to github pages
-        # only publish doc changes from main branch
-        if: github.ref == 'refs/heads/main'
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: cpp-linter-py/docs/_build/html
+          path: target/doc
+          name: cpp-linter-lib_docs

.github/workflows/pre-commit-hooks.yml

@@ -2,16 +2,20 @@ name: Pre-commit
 
 on:
   push:
+    branches: [main]
   pull_request:
-    types: opened
+    branches: [main]
 
 jobs:
-  check-source-files:
+  pre-commit:
+    uses: cpp-linter/.github/.github/workflows/pre-commit.yml@main
+
+  cargo-tools:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: '3.x'
-      - run: python3 -m pip install pre-commit
-      - run: pre-commit run --all-files
+      - run: rustup update
+      - name: cargo clippy
+        run: cargo clippy
+      - name: cargo fmt
+        run: cargo fmt --check

.github/workflows/python-packaging.yml

@@ -8,6 +8,9 @@ on:
     tags:
       - '*'
   pull_request:
+    branches:
+      - main
+      - master
   workflow_dispatch:
 
 permissions:
@@ -30,7 +33,11 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: '3.x'
+
+      - name: Increment version
+        if: startsWith(github.ref, 'refs/tags/')
+        run: python .github/workflows/replace_version_spec.py --new-version=${{ github.ref_name }}
 
       - name: Calculate openssl-vendored
         shell: bash

.github/workflows/replace_version_spec.py

@@ -0,0 +1,30 @@
+import argparse
+from pathlib import Path
+import sys
+
+
+class Args(argparse.Namespace):
+    new_version: str = "2.0.0"
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-n", "--new-version", required=True)
+    args = parser.parse_args(namespace=Args())
+    cargo_path = Path("Cargo.toml")
+    if not cargo_path.exists():
+        print("workspace Cargo.toml not in working directory")
+        return 1
+    doc = cargo_path.read_text(encoding="utf-8")
+    version_pattern = 'version = "%s" # auto'
+    old_version = version_pattern % "2.0.0"
+    if old_version not in doc:
+        print("Could not find version in Cargo.toml:\n", doc)
+        return 1
+    doc = doc.replace(old_version, version_pattern % args.new_version)
+    cargo_path.write_text(doc, encoding="utf-8")
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

.pre-commit-config.yaml

@@ -21,20 +21,3 @@ repos:
         args: [ --fix ]
       # Run the python formatter.
       - id: ruff-format
-  - repo: local
-    # these hooks require a tools managed by the rustup installer
-    hooks:
-      # Run the rust formatter.
-      # Run the rust linter.
-      - id: cargo-clippy
-        name: cargo clippy
-        description: Lint all rust files with the clippy tool
-        entry: cargo clippy --allow-staged --allow-dirty --fix
-        language: rust
-        pass_filenames: false
-      - id: cargo-fmt
-        name: cargo fmt
-        description: Format all rust files with the rustfmt tool
-        entry: cargo fmt
-        language: rust
-        pass_filenames: false

Cargo.toml

@@ -1,11 +1,11 @@
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [workspace]
-members = ["cpp-linter-lib", "cpp-linter-cli", "cpp-linter-py"]
+members = ["cpp-linter-lib", "cpp-linter-py"]
 resolver = "2"
 
 [workspace.package]
-version = "2.0.0"
+version = "2.0.0" # auto
 authors = [
     "Brendan Doherty",
     "Peter Shen",

cpp-linter-cli/.gitignore

@@ -8,10 +8,10 @@ documentation.workspace = true
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-clap = { version = ">=4.4.2" }
-git2 = ">=0.18.1"
+clap = { version = "4.5.15" }
+git2 = "0.19.0"
 lenient_semver = "0.4.2"
-log = ">=0.4.20"
+log = "0.4.22"
 openssl = { version = "0.10", features = ["vendored"], optional = true }
 openssl-probe = { version = "0.1", optional = true }
 regex = "1.10.2"
@@ -27,3 +27,7 @@ tempfile = "3.9.0"
 
 [features]
 openssl-vendored = ["dep:openssl", "dep:openssl-probe"]
+
+[[bin]]
+name = "cpp-linter"
+path = "src/main.rs"

cpp-linter-cli/Cargo.toml

@@ -0,0 +1,8 @@
+# cpp-linter-lib
+
+This crate contains the the library used as a backend for the `cpp-linter` binary executable.
+
+Since the [cpp-linter python package](https://pypi.org/project/cpp-linter/) now uses this library
+as a binding, the native binary's `main()` method is also present in the library.
+
+See also the [CLI document hosted on github](https://cpp-linter.github.io/cpp_linter_rs/cli_args.html).