Full refactor

Author: containerscrew

.github/workflows/build.yml

@@ -0,0 +1,32 @@
+name: Build 🛠️
+
+on:
+  pull_request:
+  push:
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    name: Build the binary
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install latest nightly
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+          components: rustfmt, clippy
+
+      - name: Run cargo check
+        uses: actions-rs/cargo@v1
+        with:
+          command: check
+
+      - name: Run cargo test
+        uses: actions-rs/cargo@v1
+        with:
+          command: build --release

.github/workflows/release.yml

@@ -0,0 +1,85 @@
+name: Build 📦
+
+permissions:
+  contents: write
+  pull-requests: write
+
+env:
+  BIN_NAME: "gitrack"
+
+on:
+  push:
+#    tags:
+#      - 'v*.*.*'
+
+jobs:
+  release:
+    name: Release - ${{ matrix.platform.release_for }}
+    strategy:
+      matrix:
+        platform:
+          - release_for: linux-arm64
+            os: ubuntu-latest
+            target: aarch64-unknown-linux-gnu
+            bin: ${{ env.BIN_NAME }}
+            command: build
+
+          - release_for: linux-amd64
+            os: ubuntu-latest
+            target: x86_64-unknown-linux-musl
+            bin: ${{ env.BIN_NAME }}
+            command: build
+
+          - release_for: darwin-amd64
+            os: macOS-latest
+            target: x86_64-apple-darwin
+            bin: ${{ env.BIN_NAME }}
+            command: build
+
+          - release_for: darwin-arm64
+            os: macOS-latest
+            target: aarch64-apple-darwin
+            bin: ${{ env.BIN_NAME }}
+            command: build
+
+    runs-on: ${{ matrix.platform.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup MUSL
+        if: matrix.platform.os == 'ubuntu-latest'
+        run: |
+          sudo apt-get -qq install musl-tools
+
+      - name: Build binary
+        uses: houseabsolute/actions-rust-cross@v0
+        with:
+          command: ${{ matrix.platform.command }}
+          target: ${{ matrix.platform.target }}
+          args: "--release"
+          strip: true
+
+      - name: Set container tag
+        id: set_tag
+        run: |
+          # Extract the tag name from the full reference
+          IMAGE_TAG=$(echo "${{ github.ref }}" | sed 's|.*/||')
+          echo "IMAGE_TAG=$IMAGE_TAG" >> "$GITHUB_ENV"
+
+      - name: Package zip
+        run: |
+          make package ARCH=${{ matrix.platform.release_for }} TARGET=${{ matrix.platform.target }} TAG=${{ env.IMAGE_TAG }}
+
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          files: |
+            CHANGELOG.md
+            LICENSE
+        env:
+          token: ${{ secrets.RELEASE_TOKEN }}
+          generate_release_notes: true
+          append_body: true
+          draft: true #for testing

.github/workflows/test.yml

@@ -0,0 +1,37 @@
+name: Test 🛠️
+
+on:
+  pull_request:
+  push:
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install latest nightly
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+          components: rustfmt, clippy
+
+      - name: Run cargo check
+        uses: actions-rs/cargo@v1
+        with:
+          command: check
+
+      - name: Run cargo test
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+
+      - name: Check fmt
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt --check

.gitignore

@@ -15,4 +15,4 @@ Cargo.lock
 
 # Jetbrains
 *.iml
-.idea/
+.idea/

.pre-commit-config.yaml

@@ -6,7 +6,6 @@ repos:
       -  id: check-case-conflict
       -  id: check-merge-conflict
       -  id: check-symlinks
-      -  id: check-yaml
       -  id: end-of-file-fixer
       -  id: mixed-line-ending
       -  id: trailing-whitespace
@@ -21,6 +20,6 @@ repos:
   - repo: https://github.com/doublify/pre-commit-rust
     rev: v1.0
     hooks:
-      # - id: fmt
-      #   args: ['--verbose', '--']
-      - id: cargo-check
+      - id: fmt
+      # args: ['--verbose', '--']
+      - id: cargo-check

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "gitrack"
-version = "0.1.0"
+version = "1.0.0"
 edition = "2021"
 authors = ["containerscrew [email protected]"]
 repository = "https://github.com/containerscrew/gitrack"
@@ -10,4 +10,4 @@ clap = { version = "4.5.11", features = ["derive"] }
 colored = "2.1.0"
 git2 = "0.19.0"
 walkdir = "2.5.0"
-home = "0.5.9"
+home = "0.5.9"

Makefile

@@ -0,0 +1,23 @@
+SHELL:=/bin/sh
+.PHONY: all
+
+BINARY_NAME = gitrack
+
+
+help: ## this help
+	@awk 'BEGIN {FS = ":.*?## ";  printf "Usage:\n  make \033[36m<target> \033[0m\n\nTargets:\n"} /^[a-zA-Z0-9_-]+:.*?## / {gsub("\\\\n",sprintf("\n%22c",""), $$2);printf "  \033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+
+pre-commit: ## Run pre-commit
+	pre-commit run -a
+
+package: ## Package binary with zip
+	zip -j ${BINARY_NAME}-$(ARCH)-$(TAG).zip target/$(TARGET)/release/${BINARY_NAME}
+
+generate-changelog: ## Generate changelog using git cliff
+	git cliff --output CHANGELOG.md
+
+build: ## Build binary
+	cargo build --release
+
+install: ## Install binary
+	cargo install --path .

README.md

@@ -13,7 +13,7 @@ Open a terminal and run:
 ```shell
 git clone https://github.com/containerscrew/gitrack
 cd gitrack
-cargo install --path .
+make install
 ```
 
 # Usage
@@ -51,7 +51,8 @@ Scan specific folder with details:
 
 * Implement git commit scan for sensitive data using regex. Just for fun. Like gitleaks does.
 * Compile the binary for linux/darwin arm64/amd64.
+* Support diff files.
 
 # License
 
-[License](./LICENSE)
+[License](./LICENSE)

cliff.toml

@@ -25,4 +25,4 @@ conventional_commits = false
 filter_unconventional = false
 split_commits = false
 tag_pattern = "^v[0-9]+\\.[0-9]+\\.[0-9]+$"
-sort_commits = "oldest"
+sort_commits = "oldest"

src/cli.rs

@@ -1,5 +1,5 @@
-use clap::{Parser};
 use crate::utils::default_home_dir;
+use clap::Parser;
 
 #[derive(Parser, Debug)]
 #[clap(
@@ -24,7 +24,7 @@ pub struct Args {
         short = 's',
         long = "summary",
         help = "Show only repositories without listing untracked files",
-        required = false,
+        required = false
     )]
     pub summary: bool,
-}
+}

src/git_ops.rs

@@ -1,5 +1,5 @@
-use std::path::{Path, PathBuf};
 use git2::{Repository, StatusOptions};
+use std::path::{Path, PathBuf};
 use walkdir::WalkDir;
 
 pub fn find_git_repos(start_path: &Path) -> Vec<PathBuf> {
@@ -28,4 +28,4 @@ pub fn check_untracked_files(repo_path: &Path) -> Result<Vec<String>, git2::Erro
         }
     }
     Ok(untracked_files)
-}
+}

src/main.rs

@@ -1,11 +1,14 @@
+use crate::git_ops::{check_untracked_files, find_git_repos};
 use clap::Parser;
 use cli::Args;
 use colored::*;
-use std::path::{Path, PathBuf};
-use crate::git_ops::{check_untracked_files, find_git_repos};
+use std::path::Path;
+use std::sync::mpsc;
+use std::thread;
 
 mod cli;
 mod git_ops;
+mod test;
 mod utils;
 
 // Macro print orange
@@ -23,43 +26,54 @@ macro_rules! println_light_orange {
 }
 
 fn main() {
-    // Init the CLI using clap
+    // Initialize the CLI arguments
     let args = Args::parse();
 
     println!("{}", "----->  Starting gitrack  <-----".green());
 
-    // Find .git repos in the given path
+    // Find .git repos in the specified path
     let start_path = Path::new(&args.path);
     let git_repos = find_git_repos(start_path);
 
-    let mut results = Vec::new();
+    // Create a channel to send the results back to the main thread
+    let (tx, rx) = mpsc::channel();
 
-    // For every repo, check for untracked files
-    for repo_path in &git_repos {
-        match check_untracked_files(&repo_path) {
-            Ok(untracked_files) => {
-                if !untracked_files.is_empty() {
-                    results.push((repo_path.clone(), untracked_files));
+    // Spawn a thread for each repo to check for untracked files
+    for repo_path in git_repos {
+        let tx = tx.clone();
+        thread::spawn(move || {
+            match check_untracked_files(&repo_path) {
+                Ok(untracked_files) => {
+                    if !untracked_files.is_empty() {
+                        // Send the results back to the main thread
+                        tx.send((repo_path.clone(), untracked_files)).unwrap();
+                    }
                 }
+                Err(e) => eprintln!("{}: {}", "Error checking repository".red(), e),
             }
-            Err(e) => eprintln!("{}: {}", "Error checking repository".red(), e),
-        }
+        });
     }
 
-    // Print the results, if any
-    match results.is_empty() {
-        true => println_orange!("-----> No git repos found in {}", start_path.display()),
-        false => print_results(results, args.summary),
-    }
-}
+    // Close the sending side of the channel
+    drop(tx);
 
-fn print_results(results: Vec<(PathBuf, Vec<String>)>, summary: bool) {
-    for (repo_path, untracked_files) in results {
+    // Print the results as they arrive
+    let mut has_results = false;
+    while let Ok((repo_path, untracked_files)) = rx.recv() {
+        has_results = true;
         println_orange!("Untracked files in: {}", repo_path.display());
-        if !summary {
+        if !args.summary {
             for file in untracked_files {
                 println_light_orange!("  - {}", file);
             }
         }
     }
-}
+
+    // Print a message if no results were found
+    if !has_results {
+        println_orange!(
+            "-----> There are no changes to git in {}",
+            start_path.display()
+        );
+    }
+}