Refactor some flags and code

Author: containerscrew

.pre-commit-config.yaml

@@ -13,6 +13,10 @@ repos:
     rev: v8.18.0
     hooks:
       - id: gitleaks
+  - repo: https://github.com/thlorenz/doctoc
+    rev: v2.2.0
+    hooks:
+      - id: doctoc
   - repo: https://github.com/pre-commit/pre-commit
     rev: v3.5.0
     hooks:

CHANGELOG.md

@@ -1,3 +1,14 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Changelog](#changelog)
+  - [[unreleased]](#unreleased)
+  - [[1.1.0] - 2024-08-23](#110---2024-08-23)
+  - [[1.0.0] - 2024-08-22](#100---2024-08-22)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Changelog
 
 All notable changes to this project will be documented in this file.

Makefile

@@ -27,3 +27,9 @@ uninstall: ## Uninstall binary
 
 build: ## Build binary
 	cargo build --release --locked
+
+cargo-fix: ## Run cargo fix
+	cargo fix --bin gitrack
+
+doctoc: ## Create table of contents with doctoc
+	doctoc .

README.md

@@ -1,8 +1,50 @@
 # gitrack
 
-I have a lot of personal/work repositories in my laptop. Sometimes you jump from change to change and forget to upload the commit. This tool looks for untracked changes in your local folders.
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [About](#about)
+- [Badges](#badges)
+- [Supported Platforms](#supported-platforms)
+- [Installation](#installation)
+  - [Install latest version](#install-latest-version)
+  - [Install specific release](#install-specific-release)
+  - [Using cargo](#using-cargo)
+- [Uninstall](#uninstall)
+- [Usage](#usage)
+  - [Help](#help)
+  - [Scan folders containing git repositories](#scan-folders-containing-git-repositories)
+  - [Scanning for untracked changes (summarized)](#scanning-for-untracked-changes-summarized)
+  - [Scanning for untracked changes (verbose)](#scanning-for-untracked-changes-verbose)
+  - [Diff files for untracked changes](#diff-files-for-untracked-changes)
+  - [Control number of workers/threads:](#control-number-of-workersthreads)
+  - [Exclude directories:](#exclude-directories)
+- [About threads](#about-threads)
+- [Dev](#dev)
+  - [pre-commit](#pre-commit)
+  - [Local container](#local-container)
+- [Examples](#examples)
+  - [Scan personal folder summarized](#scan-personal-folder-summarized)
+  - [Scan specific folder with details](#scan-specific-folder-with-details)
+  - [Diff files](#diff-files)
+- [TODO](#todo)
+- [License](#license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# About
+
+Scan git repositories in your file system. Find untracked changes, diff files, and more.
+
+Easy and simple. This tool was created just for fun and to practice Rust.
+
+Implemented features:
+
+* Scan for untracked changes in git repositories.
+* Scan `.git` folders in your file system (with multithreads).
+* Diff files for untracked changes.
 
-Easy and simple.
 
 # Badges
 
@@ -65,47 +107,65 @@ make uninstall
 
 # Usage
 
+## Help
+
 ```bash
 gitrack --help
-```
 
-> By default, it will look for untracked changes in your home folder.
+Scan git repositories in your file system
+
+Usage: gitrack [OPTIONS]
+
+Options:
+  -p, --path <PATH>               Folder path you want to scan for git untracked files [default: /home/dcr]
+  -w, --workers <WORKERS>         Number of threads to use for scanning repositories [default: 5]
+  -d, --diff                      Show differences between changed files
+  -e, --exclude-dir <EXCLUDE>...  Exclude directories to scan
+  -u, --check-untracked           Only show repositories with untracked files
+  -v, --verbose                   Print verbose output
+  -h, --help                      Print help
+  -V, --version                   Print version
+```
 
-Scanning for untracked changes, specific folder:
+## Scan folders containing git repositories
 
 ```bash
-gitrack -p /my/folder/path
+gitrack -p /home/elliot # home will be always the default values if -p is not provided
 ```
 
-Summarized output:
+## Scanning for untracked changes (summarized)
 
 ```bash
-gitrack -p /my/folder/path -s
-gitrack -s # remember without -p will scan your home folder
+gitrack -p /home/elliot -u
 ```
 
-Number of workers/threads:
+## Scanning for untracked changes (verbose)
 
 ```bash
-gitrack -p /home/elliot -w 3
+gitrack -p /home/elliot -u -v
 ```
 
-Diff file changes:
+## Diff files for untracked changes
 
 ```bash
-gitrack -p /home/elliot/gitrack -d # diff is not compatible with -s (summarized)
+gitrack -p /home/elliot -u -d # without -u, -d will not work
 ```
 
-Exclude directories:
+## Control number of workers/threads:
 
 ```bash
-gitrack -p /home/elliot -s -e "/home/elliot/.cache" -e "/home/elliot/.local"
+gitrack -p /home/elliot -u -w 6
 ```
 
-# Threads
+## Exclude directories:
 
-> The use of threads is not really necessary in this type of tools, unless you have a very large file/folder system. Adding threads does not mean always better performance. I have included them in order to practice their use. **Max 5 threads, default 3**
+```bash
+gitrack -p /home/elliot -e "/home/elliot/.cache" -e "/home/elliot/.local" -u -w 6
+```
+
+# About threads
 
+> The use of threads is not really necessary in this type of tools, unless you have a very large file/folder system. Adding threads does not mean always better performance. I have included them in order to practice their use.
 
 # Dev
 
@@ -123,25 +183,24 @@ cd gitrack/
 docker run -it --rm -w /app -h gitrack --name gitrack -v $PWD:/app docker.io/rust:1.80.1-slim-bullseye
 ```
 
-# Example
+# Examples
 
-Scan personal folder summarized:
+## Scan personal folder summarized
 
 ![example1](img/example1.png)
 
-Scan specific folder with details:
+## Scan specific folder with details
 
 ![example2](img/example2.png)
 
+## Diff files
+
 ![example3](img/example3.png)
 
 # TODO
 
 * Implement git commit scan for sensitive data using regex. Just for fun. Like gitleaks does.
 
-# Links
-
-* [Using cargo in CI](https://doc.rust-lang.org/cargo/guide/continuous-integration.html)
 
 # License
 

src/git_ops.rs

@@ -1,8 +1,7 @@
 use colored::*;
-use git2::{DiffOptions, Repository, Status, StatusOptions};
+use git2::{DiffOptions, Repository, StatusOptions};
 use std::io;
 use std::io::ErrorKind;
-use std::mem::needs_drop;
 use std::path::{Path, PathBuf};
 use std::sync::mpsc;
 use std::sync::mpsc::Sender;
@@ -15,9 +14,9 @@ fn is_excluded_dir(entry: &DirEntry, exclude_dirs: &[String]) -> bool {
 }
 
 // Send the path to the channel if it is a Git repository
-fn check_and_send_repo(path: PathBuf, tx: Sender<PathBuf>, verbose: bool) {
+fn check_and_send_repo(path: PathBuf, tx: Sender<PathBuf>) {
     if path.join(".git").exists() {
-        tx.send((path)).unwrap();
+        tx.send(path).unwrap();
     }
 }
 
@@ -26,7 +25,6 @@ pub fn find_git_repos(
     start_path: &Path,
     exclude_dirs: &[String],
     num_threads: usize,
-    verbose: bool,
 ) -> Vec<PathBuf> {
     let pool = ThreadPool::new(num_threads); // Create a thread pool with the specified number of threads
     let (tx, rx) = mpsc::channel(); // Create a channel to send results from threads to the main thread
@@ -37,7 +35,7 @@ pub fn find_git_repos(
         if path.is_dir() && !is_excluded_dir(&entry, exclude_dirs) {
             let tx = tx.clone(); // Clone the sender to be used in the thread
             pool.execute(move || {
-                check_and_send_repo(path, tx, verbose); // Check if the directory is a Git repository and send the path if it is
+                check_and_send_repo(path, tx); // Check if the directory is a Git repository and send the path if it is
             });
         }
     }
@@ -48,6 +46,7 @@ pub fn find_git_repos(
     rx.into_iter().collect()
 }
 
+// Check for untracked files in a Git repository
 pub fn check_untracked_files(repo_path: &Path) -> Result<Vec<String>, git2::Error> {
     let repo = Repository::open(repo_path)?;
     let mut status_options = StatusOptions::new();
@@ -57,14 +56,15 @@ pub fn check_untracked_files(repo_path: &Path) -> Result<Vec<String>, git2::Erro
     let mut untracked_files = Vec::new();
     for entry in statuses.iter() {
         let status = entry.status();
-        if status.contains(Status::WT_NEW) {
+        if status.is_index_new() || status.is_wt_new() || status.is_wt_modified() {
             let file_path = entry.path().unwrap_or("unknown file").to_string();
             untracked_files.push(file_path);
         }
     }
     Ok(untracked_files)
 }
 
+// Show the diff for a specific file in a Git repository
 pub fn show_diff(repo_path: &Path, file: &str) -> io::Result<String> {
     let repo = Repository::open(repo_path).expect("Error opening repository");
     let mut diff_options = DiffOptions::new();