Improve developer experience: clippy, formatting, error handling (#11)

Author: sjquant

.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt, clippy
+
+      - uses: Swatinem/rust-cache@v2
+
+      - name: cargo fmt --check
+        run: cargo fmt --check
+
+      - name: cargo clippy
+        run: cargo clippy --tests -- -D warnings
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: dtolnay/rust-toolchain@stable
+
+      - uses: Swatinem/rust-cache@v2
+
+      - name: cargo test
+        run: cargo test

.github/workflows/release.yml

@@ -10,30 +10,30 @@ concurrency:
 
 jobs:
   build-release:
-    name: build-release ${{ matrix.os }} ${{ matrix.rust }} ${{ matrix.target }}
+    name: build-release ${{ matrix.build }}
     runs-on: ${{ matrix.os }}
-    timeout-minutes: 5
+    timeout-minutes: 30
     strategy:
       matrix:
         include:
           - build: linux
-            os: ubuntu-20.04
+            os: ubuntu-22.04
             rust: stable
             target: x86_64-unknown-linux-musl
           - build: macos
             os: macos-latest
             rust: stable
-            target: x86_64-apple-darwin
+            target: x86_64-apple-darwin  # cross-compiled on the arm64 runner
           - build: macos-arm64
             os: macos-latest
             rust: stable
-            target: aarch64-apple-darwin
+            target: aarch64-apple-darwin  # native on the arm64 runner
     env:
       RUST_BACKTRACE: full
       TARGET_DIR: ./target
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Determine version changes
         id: version_check
@@ -56,18 +56,16 @@ jobs:
           fi
 
       - name: Install packages (Ubuntu)
-        if: steps.version_check.outputs.version_changed == 'true' && matrix.os == 'ubuntu-20.04'
+        if: steps.version_check.outputs.version_changed == 'true' && matrix.os == 'ubuntu-22.04'
         run: |
           sudo apt-get update
           sudo apt-get install -y musl-tools
 
       - name: Install Rust
         if: steps.version_check.outputs.version_changed == 'true'
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@master
         with:
           toolchain: ${{ matrix.rust }}
-          profile: minimal
-          override: true
 
       - name: Build and Package
         if: steps.version_check.outputs.version_changed == 'true'

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+  - repo: local
+    hooks:
+      - id: cargo-fmt
+        name: cargo fmt
+        entry: cargo fmt --
+        language: system
+        types: [rust]
+        pass_filenames: false
+
+      - id: cargo-clippy
+        name: cargo clippy
+        entry: cargo clippy --tests -- -D warnings
+        language: system
+        types: [rust]
+        pass_filenames: false
+

.rustfmt.toml

@@ -0,0 +1,3 @@
+edition = "2021"
+max_width = 100
+use_small_heuristics = "Default"

Cargo.toml

@@ -2,15 +2,18 @@
 name = "flopha"
 version = "0.1.1"
 edition = "2021"
-rust-version = "1.60.0"
+rust-version = "1.74.0"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-git2 = "0.14"
-clap = { version = "3.1.18", features = ["derive"] }
-openssl = { version = "0.10", features = ["vendored"] }  # to fix build error
+git2 = { version = "0.19", features = ["vendored-libgit2"] }
+clap = { version = "4", features = ["derive"] }
+openssl = { version = "0.10", features = ["vendored"] }  # statically linked for portable binaries (musl, macOS)
 regex = "1.5"
+thiserror = "1"
+log = "0.4"
+env_logger = "0.11"
 
 [dev-dependencies]
 url = "2.0"

src/cli.rs

@@ -5,9 +5,18 @@ use crate::versioning::Increment;
 #[derive(Parser)]
 #[clap(author, version, about, long_about = None)]
 pub struct Cli {
-    #[clap(short = 'v', long = "version", action)]
+    #[clap(short = 'V', long = "version", action)]
     pub version: bool,
 
+    #[clap(
+        short = 'v',
+        long,
+        action,
+        global = true,
+        help = "Enable verbose output"
+    )]
+    pub verbose: bool,
+
     #[clap(subcommand)]
     pub command: Option<Commands>,
 }
@@ -36,13 +45,6 @@ pub struct NextVersionArgs {
         short = 'i'
     )]
     pub increment: Increment,
-    #[clap(
-        help = "Enable verbose output for detailed information",
-        long,
-        short = 'v',
-        action
-    )]
-    pub verbose: bool,
     #[clap(
         help = "Specify a custom pattern for version matching and generation. \
                 Use {major}, {minor}, and {patch} as placeholders. \
@@ -75,13 +77,6 @@ pub struct LastVersionArgs {
         short = 'p'
     )]
     pub pattern: Option<String>,
-    #[clap(
-        help = "Enable verbose output for detailed information",
-        long,
-        short = 'v',
-        action
-    )]
-    pub verbose: bool,
     #[clap(
         help = "Specify the source for versioning: tag (default) or branch",
         long,

src/error.rs

@@ -0,0 +1,21 @@
+use thiserror::Error;
+
+#[derive(Debug, Error)]
+pub enum FlophaError {
+    #[error("git error: {0}")]
+    Git(#[from] git2::Error),
+    #[error("failed to open repository at '{path}'")]
+    RepoNotFound {
+        path: String,
+        #[source]
+        source: git2::Error,
+    },
+    #[error("remote '{name}' not found")]
+    RemoteNotFound {
+        name: String,
+        #[source]
+        source: git2::Error,
+    },
+    #[error("version component '{{{0}}}' not present in pattern")]
+    MissingVersionComponent(String),
+}