README.md changes

Author: mbrav

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.3] - 2023-04-03
+
+### Added
+
+- Added better README.md
+
 ## [0.0.2] - 2023-04-01
 
 ### Fixed
@@ -26,5 +32,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - 'None
 
+[0.0.3]: https://github.com/mbrav/git_raider/compare/0.0.2...0.0.3
 [0.0.2]: https://github.com/mbrav/git_raider/compare/0.0.1...0.0.2
 [0.0.1]: https://github.com/mbrav/git_raider/releases/tag/0.0.1

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "git_raider"
-version = "0.0.2"
+version = "0.0.3"
 descripion = "Mass git repository search, replace and commit tool"
 authors = ["mbrav <mbrav@protonmail.com>"]
 edition = "2021"

README.md

@@ -2,12 +2,26 @@
 [![License](https://img.shields.io/badge/License-BSD_3--Clause-yellow.svg)](https://opensource.org/licenses/BSD-3-Clause)
 [![tokei](https://tokei.rs/b1/github/mbrav/git_raider?category=lines)](https://tokei.rs/b1/github/mbrav/git_raider)
 
-
 # git_raider
 
 Mass git repository search, replace and commit tool written in Rust
 
-*Description to be added soon*
+This cli tool is designed to **recursively** run through a directory (`-p`/`--path` flag) and find the following:
+
+* Folders that contain a *.git* folder (and hence are git repositories);
+* A branch name regex pattern specified with the `-b`/`--branch` flag which checks out a branch that was matched by the regex. A warning will be outputted if more than one branch was matched;
+* A file name regex pattern specified with the `-f`/`--file` flag. This will match all files that match the regex pattern;
+* A regex pattern specified with the `-l`/`--line` flag that will match *a whole* line in a file that was matched by `-f`/`--file`;
+* A regex pattern specified with the `-s`/`--select` flag that can match just *a part* of a line selected with `-l`/`--line`;
+* A regex pattern specified with the `-r`/`--replace` flag that will replace content selected with `-s`/`--select` flag;
+* A commit message specified with the `-m`/`--message`. If this flag is not passed, no commit will be made.
+
+### TODO
+
+For base functionality to be completed, the following must still be finished:
+
+* Create new commit with specified message;
+* Make `dry-run` much better;
 
 ## Run
 

src/main.rs

@@ -43,11 +43,11 @@ fn main() {
 
         // Stage matches
         raider.stage();
-    }
 
-    // Commit changes with message
-    if let Some(commit_message) = conf.commit_message {
-        raider.commit(commit_message.as_str());
+        // Commit changes with message
+        if let Some(commit_message) = conf.commit_message {
+            raider.commit(commit_message.as_str());
+        }
     }
 
     // Print results for found directories, Pages and matches

src/raider.rs

@@ -90,28 +90,26 @@ impl RepoRaider {
         }
     }
 
-    /// Recursively matches for filenames with a specific name and outputs a result vector
+    /// Recursively matches for filenames with a specific name and generates a result vector
     pub fn match_files(&mut self, pattern: &str) {
         for dir in &mut self.dirs {
             let f: Vec<structs::Page> =
                 func::find_files(dir.path.to_str().expect("Error unwrapping Path"), pattern)
                     .iter()
-                    .map(|x| {
-                        structs::Page {
-                            path: x.clone(),
-                            matches: Vec::new(),
-                            relative_path: x
-                                .strip_prefix(&self.path)
-                                .expect("Error prefixing Path")
-                                .to_path_buf(), // dir: Rc::new(dir.clone()),
-                        }
+                    .map(|x| structs::Page {
+                        path: x.clone(),
+                        matches: Vec::new(),
+                        relative_path: x
+                            .strip_prefix(&self.path)
+                            .expect("Error prefixing Path")
+                            .to_path_buf(),
                     })
                     .collect();
             dir.pages.extend(f);
         }
     }
 
-    /// Recursively searches for a all lines matching a pattern in a file
+    /// Recursively searches for all lines matching a pattern in a file
     /// and saves them as a Match
     pub fn match_lines(&mut self, pattern: &str) {
         let re = Regex::new(pattern).expect("Error compiling regex");