v0.0.2

Author: gold24park

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "gitig"
-version = "0.0.1"
+version = "0.0.2"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Cargo.toml

@@ -1,16 +1,56 @@
+<div>
+    <img src="images/gitig.png">
+</div>
+
 # gitig
 
+<img src="https://img.shields.io/github/v/release/gold24park/gitig">
+
+Creates a `.gitignore` file for the configured project!
+
+It is provided based on the `.gitignore` template available at [https://github.com/github/gitignore](https://github.com/github/gitignore)
+
+## Installation
+
+```
+brew install gitig
+```
+
+## Quick Start
+
+```
+# Creates .gitignore for Android Project
+gitig android
+```
+
+```
+# Creates .gitignore for NodeJs Project to ~/my-node-js-project
+gitig node ~/my-node-js-project
+```
+
+```
+# Show available project list
+gitig --list
 ```
-gitig [<options>] [project] [path]
 
+```
+# Show available projects starts with "no"
+gitig --list no
+```
+
+## Usage
+
+```
 USAGE:
-    gitig <project> [path]
+    gitig [FLAGS] [ARGS]
 
 FLAGS:
-    -h, --help       Prints help information
-    -V, --version    Prints version information
+-h, --help Prints help information
+-l, --list
+ -V, --version Prints version information
 
 ARGS:
-    <project>    gitignore를 생성할 project
-    <path>       지정한 경로에 .gitignore 생성 [default: .]
+<project> The project for which to create a .gitignore [default: ]
+<path> The path to create the .gitignore [default: .]
+
 ```

README.md

@@ -5,14 +5,19 @@ use structopt::StructOpt;
 #[derive(Debug, StructOpt)]
 #[structopt(
     name = "gitig",
-    about = "Creates a gitignore for the configured project.",
+    about = "Creates a gitignore boilerplate for the configured project.",
     author = "gold24park"
 )]
 pub struct CmdArgs {
     /// The project for which to create a .gitignore.
+    #[structopt(default_value = "")]
     pub project: String,
 
     /// The path to create the .gitignore.
     #[structopt(parse(from_os_str), default_value = ".")]
     pub path: PathBuf,
+
+    //// List available projects
+    #[structopt(short, long)]
+    pub list: bool,
 }

src/cli.rs

@@ -42,7 +42,7 @@ pub struct FlattenGitTree {
 #[derive(Debug, Deserialize)]
 pub struct Element {
     #[serde(skip)]
-    project: String,
+    pub project: String,
     path: String,
     sha: String,
 }
@@ -85,6 +85,10 @@ impl ProjectMatcher for Element {
 }
 
 impl FlattenGitTree {
+    pub fn iter(&self) -> core::slice::Iter<'_, Element> {
+        self.elements.iter()
+    }
+
     pub fn init(client: &impl HttpClient) -> Option<FlattenGitTree> {
         let url = "https://api.github.com/repos/github/gitignore/git/trees/main?recursive=0";
         let body = client.get(url).ok()?;

src/git.rs

@@ -18,39 +18,51 @@ fn main() -> anyhow::Result<()> {
 
     let git_tree = FlattenGitTree::init(&client).ok_or(anyhow!("Failed to init project list."))?;
 
-    match git_tree.get(&args.project) {
-        Some(element) => {
-            let content = element
-                .download(&client)
-                .ok_or(anyhow!("Failed to download gitignore."))?;
+    if args.list {
+        git_tree
+            .iter()
+            .filter(|e| {
+                e.project
+                    .to_lowercase()
+                    .starts_with(&args.project.to_lowercase())
+            })
+            .for_each(|e| println!("- {}", e.project))
+    } else {
+        match git_tree.get(&args.project) {
+            Some(element) => {
+                let content = element
+                    .download(&client)
+                    .ok_or(anyhow!("Failed to download gitignore."))?;
 
-            let file_path = args.path.as_path().join(".gitignore");
+                let file_path = args.path.as_path().join(".gitignore");
 
-            if file_path.exists() {
-                // ask user to overwrite
-                println!("File already exists. Overwrite? [y/n]");
+                if file_path.exists() {
+                    // ask user to overwrite
+                    println!("File already exists. Overwrite? [y/n]");
 
-                let mut input = String::new();
-                io::stdin().read_line(&mut input)?;
+                    let mut input = String::new();
+                    io::stdin().read_line(&mut input)?;
 
-                if input.to_lowercase().trim() != "y" {
-                    return Ok(());
+                    if input.to_lowercase().trim() != "y" {
+                        return Ok(());
+                    }
                 }
-            }
 
-            fs::write(file_path, content).map_err(|e| anyhow!("Failed to write file: {}", e))?;
+                fs::write(file_path, content)
+                    .map_err(|e| anyhow!("Failed to write file: {}", e))?;
 
-            println!("Successfully created .gitignore for {}", args.project);
-        }
-        None => {
-            let suggest_keywords = git_tree.suggest_keywords(&args.project);
-            println!(
-                "No project found for \"{}\". Did you mean one of these?",
-                args.project
-            );
-
-            for keyword in suggest_keywords {
-                println!("- {}", keyword);
+                println!("Successfully created .gitignore for {}", args.project);
+            }
+            None => {
+                let suggest_keywords = git_tree.suggest_keywords(&args.project);
+                println!(
+                    "No project found for \"{}\". Did you mean one of these?",
+                    args.project
+                );
+
+                for keyword in suggest_keywords {
+                    println!("- {}", keyword);
+                }
             }
         }
     }