[#52] Adds a generate command for a default .tools.toml file

README.md

@@ -109,13 +109,16 @@ the following command (Unix-only):
 ```shell
 curl https://raw.githubusercontent.com/chshersh/tool-sync/main/example-tool-sync-config.toml > ~/.tool.toml
 ```
+A default config can be also be generated by running `tool --config=path/to/config generate`.
+This will generate an example file at `path/to/config`.
 
 The above example config lists some tools natively supported by `tool-sync` and
 therefore they don't require extra configuration.
 
 To specify a tool not supported by `tool-sync`, add a TOML table entry and list
 all the required fields like in the example below:
 
+
 ```toml
 [tokei]
 owner    = "XAMPPRocky"  # GitHub username

src/config.rs

@@ -1,3 +1,4 @@
 pub mod cli;
 pub mod schema;
+pub mod template;
 pub mod toml;

src/config/cli.rs

@@ -17,4 +17,7 @@ pub struct Cli {
 pub enum Command {
     /// Sync all tools specified in configuration file
     Sync,
+
+    /// Generate a default .tools.toml file and prints it to std out
+    DefaultConfig,
 }

src/config/template.rs

@@ -0,0 +1,38 @@
+/// This file only holds the template that is used to generate a default .tools.toml.
+
+pub const CONFIG_TEMPLATE: &str = r##"# # tool-sync default configuration file
+# https://github.com/chshersh/tool-sync
+# This file was automatically generated by tool-sync
+#####################################################
+#
+#
+# store_directory = "$HOME/.local/bin"
+#
+# tool-sync provides native support for some of the tools without the need to configure them
+# Uncomment the tools you want to have them
+#
+# [bat]
+# [difftastic]
+# [fd]
+# [ripgrep]
+#
+# To add configuration for other tools these are the config options:
+# [ripgrep]
+#        owner     = "BurntSushi"
+#        repo      = "ripgrep"
+#        exe_name  = "rg"
+#
+#        # Uncomment to download a specific version or tag.
+#        # Without this tag latest will be used
+#        # tag       = "13.0.0"
+#
+#
+# Asset name to download on linux OSes
+# asset_name.linux = "x86_64-unknown-linux-musl"
+#
+# uncomment if you want to install on macOS as well
+# asset_name.macos = "apple-darwin"
+#
+# uncomment if you want to install on Windows as well
+# asset_name.windows = "x86_64-pc-windows-msvc"
+"##;

src/lib.rs

@@ -7,26 +7,30 @@ use clap::Parser;
 use std::path::PathBuf;
 
 use crate::config::cli::{Cli, Command};
+use crate::config::template;
 use crate::config::toml;
 use crate::sync::sync;
 
 const DEFAULT_CONFIG_PATH: &str = ".tool.toml";
 
 pub fn run() {
     let cli = Cli::parse();
-    let config_path = resolve_config_path(cli.config);
+    let config_path = resolve_config_path(cli.config.clone());
 
-    match toml::parse_file(&config_path) {
-        Err(e) => {
-            err::abort_with(&format!(
-                "Error parsing configuration at path {}: {}",
-                config_path.display(),
-                e.display()
-            ));
-        }
-        Ok(tool) => match cli.command {
-            Command::Sync => sync(tool),
+    match cli.command {
+        Command::Sync => match toml::parse_file(&config_path) {
+            Err(e) => {
+                err::abort_with(&format!(
+                    "Error parsing configuration at path {}: {}",
+                    config_path.display(),
+                    e.display()
+                ));
+            }
+            Ok(tool) => {
+                sync(tool);
+            }
         },
+        Command::DefaultConfig => generate_config(),
     }
 }
 
@@ -46,3 +50,7 @@ fn resolve_config_path(config_path: Option<PathBuf>) -> PathBuf {
         },
     }
 }
+
+fn generate_config() {
+    println!("{}", template::CONFIG_TEMPLATE);
+}