Fix #65, one add command for all source

Fix #74, support for shell auto completions
Fix #102
Improve command help messages

Author: theRookieCoder

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog for Ferium
 
+## `v4.1.0`
+### 31.05.2022
+
+- [#65](https://github.com/gorilla-devs/ferium/issues/65) Adding mods and modpacks is now done with one command
+- Fixed [#102](https://github.com/gorilla-devs/ferium/issues/102)
+- [#74](https://github.com/gorilla-devs/ferium/issues/74) Added `complete` command to generate shell auto completions
+- Improved command help messages
+
 ## `v4.0.3`
 ### 30.05.2022
 

Cargo.lock

@@ -1,32 +1,38 @@
 [package]
 name = "ferium"
-version = "4.0.3"
+version = "4.1.0"
 edition = "2021"
-authors = ["Ilesh Thiada (theRookieCoder) <[email protected]>", "薛詠謙 (KyleUltimate)", "Daniel Hauck (SolidTux)"]
+authors = [
+    "Ilesh Thiada (theRookieCoder) <[email protected]>",
+    "薛詠謙 (KyleUltimate)",
+    "Daniel Hauck (SolidTux)",
+]
 description = "Fast CLI program for managing Minecraft mods and modpacks from Modrinth, CurseForge, and Github Releases"
 exclude = ["tests"] # Don't need tests for installing using crates.io
 repository = "https://github.com/gorilla-devs/ferium"
 categories = ["command-line-utilities"]
 readme = "README.md"
 license = "MPL-2.0"
-keywords = [
-    "minecraft",
-    "mod-manager",
-    "modrinth",
-    "curseforge",
-    "github"
-]
+keywords = ["minecraft", "mod-manager", "modrinth", "curseforge", "github"]
 
 [features]
 default = ["gtk"]
 gtk = ["libium/gtk"]
 xdg = ["libium/xdg"]
 
 [dependencies]
-tokio = { version = "1.18.2", default-features = false, features = ["rt-multi-thread", "macros"] }
-reqwest = { version = "0.11.10", default-features = false, features = ["rustls-tls"] }
-octocrab = { version = "0.16.0", default-features = false, features = ["rustls"] }
+tokio = { version = "1.18.2", default-features = false, features = [
+    "rt-multi-thread",
+    "macros",
+] }
+reqwest = { version = "0.11.10", default-features = false, features = [
+    "rustls-tls",
+] }
+octocrab = { version = "0.16.0", default-features = false, features = [
+    "rustls",
+] }
 clap = { version = "3.1.18", features = ["derive"] }
+clap_complete = "3.1.4"
 lazy_static = "1.4.0"
 serde_json = "1.0.81"
 dialoguer = "0.10.1"

Cargo.toml

@@ -75,46 +75,46 @@ Remember to use an add-on like [cargo-update](https://crates.io/crates/cargo-upd
 When you first start up Ferium, you will have to either
 
 - Create a new profile by running `ferium profile create` and entering the details for your profile
-- Add a modpack by running `ferium modpack add-curseforge <project-id>` or `ferium modpack add-modrinth <project-id>`
+- Add a modpack by running `ferium modpack add <project_id>`
 
 ### Adding Mods
 
 - Modrinth Mods
-  - `ferium add-modrinth project_id`
+  - `ferium add project_id`
   - Where `project_id` is the slug or project id of the mod
     - For example, [Sodium](https://modrinth.com/mod/sodium) has the slug `sodium` and a project id `AANobbMI`
     - You can find the slug in the website url (`modrinth.com/mod/<slug>`), and the project id at the bottom of the left sidebar under 'Technical information'
-  - So to add [Sodium](https://modrinth.com/mod/sodium), you should run `ferium add-modrinth sodium` or `ferium add-modrinth AANobbMI`
+  - So to add [Sodium](https://modrinth.com/mod/sodium), you should run `ferium add sodium` or `ferium add AANobbMI`
 - CurseForge Mods
-  - `ferium add-curseforge project_id`
+  - `ferium add project_id`
   - Where `project_id` is the project id of the mod
     - For example, [Terralith](https://www.curseforge.com/minecraft/mc-mods/terralith) has a project id `513688`
     - You can find the project id at the top of the right sidebar under 'About Project'
-  - So to add [Terralith](https://www.curseforge.com/minecraft/mc-mods/terralith), you should run `ferium add-curseforge 513688`
+  - So to add [Terralith](https://www.curseforge.com/minecraft/mc-mods/terralith), you should run `ferium add 513688`
 - GitHub 'Mods'
-  - `ferium add-github owner/name`
+  - `ferium add owner/name`
   - Where `owner` is the username of the owner of the repository and `name` is the name of the repository (both case-insensitive)
     - For example [Sodium's repository](https://github.com/CaffeineMC/sodium-fabric) has the id `CaffeineMC/sodium-fabric`
     - You can find these at the top left part of the repository's page as a big 'owner / name'
-  - So to add [Sodium](https://github.com/CaffeineMC/sodium-fabric), you should run `ferium add-github CaffeineMC/sodium-fabric` (again, case-insensitive)
+  - So to add [Sodium](https://github.com/CaffeineMC/sodium-fabric), you should run `ferium add CaffeineMC/sodium-fabric` (again, case-insensitive)
   - Note: The GitHub repository has to release JAR files in their Releases for Ferium to download, or else it will refuse to be added
 - External mods
   - If you want to use files that are not downloadable by Ferium, place them in the `user` folder in the output directory. Files here will be copied to the output directory when upgrading
 
 ### Adding Modpacks
 
 - Modrinth Modpacks
-  - `ferium modpack add-modrinth project_id`
+  - `ferium modpack add project_id`
   - Where `project_id` is the slug or project id of the modpack
     - For example, [Better Minecraft](https://modrinth.com/modpack/better-minecraft) has the slug `better-minecraft` and a project id `shFhR8Vx`
     - You can find the slug in the website url (`modrinth.com/modpack/<slug>`), and the project id at the bottom of the left sidebar under 'Technical information'
-  - So to add [Better Minecraft](https://modrinth.com/modpack/better-minecraft), you should run `ferium modpack add-modrinth better-minecraft` or `ferium add-modrinth shFhR8Vx`
+  - So to add [Better Minecraft](https://modrinth.com/modpack/better-minecraft), you should run `ferium modpack add better-minecraft` or `ferium modpack add shFhR8Vx`
 - CurseForge Mods
-  - `ferium modpack add-curseforge project_id`
+  - `ferium modpack add project_id`
   - Where `project_id` is the project id of the modpack
     - For example, [RLCraft](https://www.curseforge.com/minecraft/modpacks/rlcraft) has a project id `285109`
     - You can find the project id at the top of the right sidebar under 'About Project'
-  - So to add [RLCraft](https://www.curseforge.com/minecraft/modpacks/rlcraft), you should run `ferium modpack add-curseforge 285109`
+  - So to add [RLCraft](https://www.curseforge.com/minecraft/modpacks/rlcraft), you should run `ferium modpack add 285109`
 
 ### Upgrading Mods
 
@@ -151,7 +151,7 @@ You can also provide the names of the mods to remove as arguments. Mod names wit
 
 If some mod is compatible with your profile but Ferium does not download it, [create an issue]((https://github.com/theRookieCoder/ferium/issues/new)) if you think it's a bug. You can disable the game version or mod loader checks by using the `--dont-check-game-version` and/or `--dont-check-mod-loader` flags when adding the mod, or manually setting `check_game_version` or `check_mod_loader` to false for the specific mod in the config.
 
-For example, [Just Enough Items](https://www.curseforge.com/minecraft/mc-mods/jei) does not specify the mod loader for older minecraft versions such as `1.12.2`. In this case, you would add JEI by running `ferium add-curseforge 238222 --dont-check-mod-loader` so that the mod loader check is disabled.
+For example, [Just Enough Items](https://www.curseforge.com/minecraft/mc-mods/jei) does not specify the mod loader for older minecraft versions such as `1.12.2`. In this case, you would add JEI by running `ferium add 238222 --dont-check-mod-loader` so that the mod loader check is disabled.
 You can also manually disable the mod loader (and/or game version) check(s) in the config like so
 ```json
 {

README.md

@@ -1,4 +1,5 @@
 use clap::{Parser, Subcommand, ValueHint};
+use clap_complete::Shell;
 use std::path::PathBuf;
 
 #[derive(Parser)]
@@ -12,7 +13,7 @@ pub struct Ferium {
     #[clap(help("The limit for additional threads spawned by the Tokio runtime"))]
     pub threads: Option<usize>,
     #[clap(long)]
-    #[clap(help("A GitHub personal access token for increasing the rate limit"))]
+    #[clap(help("A GitHub personal access token for increasing the GitHub API rate limit"))]
     pub github_token: Option<String>,
     #[clap(long)]
     #[clap(help(
@@ -24,44 +25,27 @@ pub struct Ferium {
 
 #[derive(Subcommand)]
 pub enum SubCommands {
-    #[clap(about("Add a Modrinth mod to the profile"))]
-    AddModrinth {
-        #[clap(help("The project ID is specified at the bottom of the left sidebar under 'Technical information'\nYou can also use the project slug for this"))]
-        project_id: String,
-        #[clap(long)]
-        #[clap(help("Whether the game version should be checked for this mod"))]
+    #[clap(about("Add a mod to the profile"))]
+    Add {
+        #[clap(help("The identifier of the mod/project/repository
+The Modrinth project ID is specified at the bottom of the left sidebar under 'Technical information'. You can also use the project slug in the URL
+The CurseForge mod ID is specified at the top of the right sidebar under 'About Project'
+The GitHub identifier is the repository's full name, e.g. `gorilla-devs/ferium`"))]
+        identifier: String,
+        #[clap(long)]
+        #[clap(help("The game version will not be checked for this mod"))]
         dont_check_game_version: bool,
         #[clap(long)]
-        #[clap(help("Whether the mod loader should be checked for this mod"))]
+        #[clap(help("The mod loader will not be checked for this mod"))]
         dont_check_mod_loader: bool,
         #[clap(long)]
-        #[clap(help("Do not add any of the mod's dependencies"))]
+        #[clap(help("The mod's dependencies will not be added"))]
         dont_add_dependencies: bool,
     },
-    #[clap(about("Add a GitHub repository to the profile"))]
-    AddGithub {
-        #[clap(help("The full name of the repository, e.g. `theRookieCoder/ferium`"))]
-        name: String,
-        #[clap(long)]
-        #[clap(help("Whether the game version should be checked for this mod"))]
-        dont_check_game_version: bool,
-        #[clap(long)]
-        #[clap(help("Whether the mod loader should be checked for this mod"))]
-        dont_check_mod_loader: bool,
-    },
-    #[clap(about("Add a CurseForge mod to the profile"))]
-    AddCurseforge {
-        #[clap(help("The project ID is specified at the right sidebar under 'About Project'"))]
-        project_id: i32,
-        #[clap(long)]
-        #[clap(help("Whether the game version should be checked for this mod"))]
-        dont_check_game_version: bool,
-        #[clap(long)]
-        #[clap(help("Whether the mod loader should be checked for this mod"))]
-        dont_check_mod_loader: bool,
-        #[clap(long)]
-        #[clap(help("Do not add any of the mod's dependencies"))]
-        dont_add_dependencies: bool,
+    #[clap(about("Generate shell auto completions to stdout for the specified shell"))]
+    Complete {
+        #[clap(help("The shell to generate auto completions for"))]
+        shell: Shell,
     },
     #[clap(about("List all the mods in the profile, and with some their metadata if verbose"))]
     List {
@@ -81,10 +65,13 @@ pub enum SubCommands {
         #[clap(subcommand)]
         subcommand: ProfileSubCommands,
     },
-    #[clap(about("Remove a mod or repository from the profile\nOptionally, provide a list of names of the mods to remove"))]
+    #[clap(about(
+        "Remove a mod or repository from the profile
+Optionally, provide a list of names of the mods to remove"
+    ))]
     Remove {
         #[clap(name("mod-name"))]
-        #[clap(help("A case-insensitive list of names of a mods to remove\nIf one or more of the mod names provided does not exist, the program will error out without changing anything in the config"))]
+        #[clap(help("A case-insensitive list of names of a mods to remove"))]
         mod_names: Vec<String>,
     },
     #[clap(about("Sort all your mods in alphabetical order"))]
@@ -96,7 +83,8 @@ pub enum SubCommands {
 #[derive(Subcommand)]
 pub enum ProfileSubCommands {
     #[clap(about(
-        "Configure the current profile's Minecraft version, mod loader, and output directory\nOptionally, provide setting(s) to change as option(s)"
+        "Configure the current profile's Minecraft version, mod loader, and output directory
+Optionally, provide setting(s) to change as option(s)"
     ))]
     Configure {
         #[clap(long)]
@@ -114,11 +102,18 @@ pub enum ProfileSubCommands {
         #[clap(help("The directory to output mods to"))]
         output_dir: Option<PathBuf>,
     },
-    #[clap(about("Create a new profile\nOptionally, provide ALL the options to create the profile without the UI"))]
+    #[clap(about(
+        "Create a new profile
+Optionally provide all the options, to create the profile without the UI
+Use the import flag to import mods from another profile"
+    ))]
     Create {
         #[clap(long)]
         #[allow(clippy::option_option)]
-        #[clap(help("Copy over the mods from an existing profile\nOptionally, provide the name of the profile to import mods from"))]
+        #[clap(help(
+            "Copy over the mods from an existing profile
+Optionally, provide the name of the profile to import mods from"
+        ))]
         import: Option<Option<String>>,
         #[clap(long)]
         #[clap(help("The Minecraft version to check compatibility for"))]
@@ -135,15 +130,21 @@ pub enum ProfileSubCommands {
         #[clap(help("The directory to output mods to"))]
         output_dir: Option<PathBuf>,
     },
-    #[clap(about("Delete a profile\nOptionally, provide the name of the profile to delete\nAfter deletion, the first profile will be selected"))]
+    #[clap(about(
+        "Delete a profile
+Optionally, provide the name of the profile to delete"
+    ))]
     Delete {
         #[clap(long)]
         #[clap(help("The name of the profile to delete"))]
         profile_name: Option<String>,
     },
     #[clap(about("List all the profiles with their data"))]
     List,
-    #[clap(about("Switch between different profiles\nOptionally, provide the name of the profile to switch to"))]
+    #[clap(about(
+        "Switch between different profiles
+Optionally, provide the name of the profile to switch to"
+    ))]
     Switch {
         #[clap(long)]
         #[clap(help("The name of the profile to switch to"))]
@@ -153,51 +154,54 @@ pub enum ProfileSubCommands {
 
 #[derive(Subcommand)]
 pub enum ModpackSubCommands {
-    #[clap(about("Add a Modrinth modpack to the config"))]
-    AddModrinth {
-        #[clap(help("The project ID is specified at the bottom of the left sidebar under 'Technical information'\nYou can also use the project slug for this"))]
-        project_id: String,
+    #[clap(about("Add a modpack to the config"))]
+    Add {
+        #[clap(help("The identifier of the modpack/project
+The Modrinth project ID is specified at the bottom of the left sidebar under 'Technical information'. You can also use the project slug for this
+The CurseForge mod ID is specified at the top of the right sidebar under 'About Project'"))]
+        identifier: String,
         #[clap(long)]
         #[clap(value_hint(ValueHint::DirPath))]
         #[clap(help("The Minecraft instance directory to install the modpack to"))]
         output_dir: Option<PathBuf>,
         #[clap(long)]
-        #[clap(help("Whether to install the modpack's overrides to the output directory.\nThis will override existing files"))]
-        install_overrides: Option<bool>,
-    },
-    #[clap(about("Add a CurseForge modpack to the config"))]
-    AddCurseforge {
-        #[clap(help("The project ID is specified at the right sidebar under 'About Project'"))]
-        project_id: i32,
-        #[clap(long)]
-        #[clap(value_hint(ValueHint::DirPath))]
-        #[clap(help("The Minecraft instance directory to install the modpack to"))]
-        output_dir: Option<PathBuf>,
-        #[clap(long)]
-        #[clap(help("Whether to install the modpack's overrides to the output directory.\nThis may overwrite existing files"))]
+        #[clap(help(
+            "Whether to install the modpack's overrides to the output directory
+This will override existing files"
+        ))]
         install_overrides: Option<bool>,
     },
     #[clap(about(
-        "Configure the current modpack's output directory\nOptionally, provide the output directory as an option"
+        "Configure the current modpack's output directory
+Optionally, provide the output directory as an option"
     ))]
     Configure {
         #[clap(long)]
         #[clap(value_hint(ValueHint::DirPath))]
         #[clap(help("The Minecraft instance directory to install the modpack to"))]
         output_dir: Option<PathBuf>,
         #[clap(long)]
-        #[clap(help("Whether to install the modpack's overrides to the output directory.\nThis may overwrite existing files"))]
+        #[clap(help(
+            "Whether to install the modpack's overrides to the output directory
+This may overwrite existing files"
+        ))]
         install_overrides: Option<bool>,
     },
-    #[clap(about("Delete a modpack\nOptionally, provide the name of the modpack to delete"))]
+    #[clap(about(
+        "Delete a modpack
+Optionally, provide the name of the modpack to delete"
+    ))]
     Delete {
         #[clap(long)]
         #[clap(help("The name of the modpack to delete"))]
         modpack_name: Option<String>,
     },
     #[clap(about("List all the modpacks"))]
     List,
-    #[clap(about("Switch between different modpacks\nOptionally, provide the name of the modpack to switch to"))]
+    #[clap(about(
+        "Switch between different modpacks
+Optionally, provide the name of the modpack to switch to"
+    ))]
     Switch {
         #[clap(long)]
         #[clap(help("The name of the modpack to switch to"))]