New config format allowing for less loading time

Author: theRookieCoder

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog for Ferium
 
+## [3.15.0] - 08.03.2022
+
+Switched from make to [just](https://github.com/casey/just)
+
+- Added back the verbose flag to the list command. The verbose version is the same as before, and the non-verbose version lists out all mod names only
+- Small edits to the add command to support the new config format
+- The list command now uses a more concise method to display lists of developers/categories (hence the new dependency `itertools`)
+- Many commands have been converted to work on one project at a time so there are less loops in functions and more in main.rs
+- The remove command has been significantly improved and is now much faster due to the new name storing format
+- The remove command now also requires argument provided names to be exactly the same
+- Simplified delete profile command
+- 
+
 ## [3.14.0] - 06.03.2022
 
 - All print statements in add and upgrade functions have been removed, this means

Cargo.lock

@@ -1,8 +1,8 @@
 [package]
 name = "ferium"
-version = "3.14.0"
+version = "3.15.0"
 edition = "2021"
-authors = ["theRookieCoder <[email protected]>", "Daniel Hauck (SolidTux)"]
+authors = ["Ilesh Thiada (theRookieCoder) <[email protected]>", "Daniel Hauck (SolidTux)"]
 description = "Ferium is a CLI program for managing Minecraft mods from Modrinth, CurseForge, and Github Releases"
 exclude = ["tests"] # Don't need tests for installing using crates.io
 repository = "https://github.com/theRookieCoder/ferium"
@@ -11,10 +11,10 @@ readme = "README.md"
 license = "MPL-2.0"
 keywords = [
 	"minecraft",
-	"cli",
 	"mod-manager",
 	"modrinth",
-	"curseforge"
+	"curseforge",
+	"github"
 ]
 
 [dependencies]
@@ -25,6 +25,7 @@ clap = { version = "3", features = ["derive"] }
 serde_json = "1"
 ansi_term = "0"
 dialoguer = "0"
+itertools = "0"
 thiserror = "1"
 ferinth = "2"
 libium = "1"

Cargo.toml

@@ -4,18 +4,23 @@
 [![license badge](https://img.shields.io/github/license/theRookieCoder/ferium?style=for-the-badge)](https://github.com/theRookieCoder/ferium/blob/main/LICENSE.txt)
 [![copyleft badge](https://img.shields.io/static/v1?label=&message=Copyleft&style=for-the-badge&labelColor=silver&color=silver&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAQAAAC0NkA6AAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QA/4ePzL8AAAAHdElNRQfjAxYBNgYPa+9oAAAEM0lEQVRYw6WYb0zVVRjHP9wQW7umA0xoKNSC+6bSNkzetKZbaVu19aLpfOGcbcw/S+uNbikuNwMsVyE3XVsro7VEXjS3ylmLxkRtC9crHGjCAv9AATK4CoZye8Hl/J7n/M7v8rvX57w55/lznt/583yf5/xyCEOlrKaSCp6ggCiQYJheLvMHv9HHA1MZ++kmmaZ1UUNZ9g6eo4X7aR3Mtvs0syJzB0U0MR3KgddOsiQTFxsZzdDBTLvFetd0OT5OHo1U+7j9tNJBN4MkgChFVLCS1Sz1aR7jHf5Lv4Yov1hfN8YRKgP1V9LIuGVxhmg6Fwv4XalPcJD8OTe3gA+YVHYXgt3kWato46nQp1jOWWs1eW7Fz5VaLbkZ3cdc6pX9UfeNkvd+a1aRtV3Fle+mLeGWEO/0mT/EWo7SxhBjjNDPKfbxtMPNVjHLKMVa+I0Q1lmG89nDTWdctPGqz80hIT+uAWRaGOqzeJEraQOw2YrzXNqNbJrlnqDFsCeJKZO3uDtnnN+wNq6cCSM74SGtd1wHlfrOkHAyyDPKrk5codIZ1n7DSlAoVF9iKjRq/cVCYZnPmJHsnWF1GcYRobiQf3yA3sr7VPM2cXp9br5Va2k0/EsAy4SixKh6a5LT6rQibGBAyaeV9SohWQabzeBvhUcTaoqPHHhdTKfSOaWk1wx/E8TN4CuhssW6pjnOCF/KiNrOxULWZPgNEbEJF4VKFT2mdbGLpNNJPzVqC9eKkTdbDK4ajy9ngVaPiHuU5AshWWe4VyIsMuwbWTi5Q7sYlYj+TdNbFBHpJZEV8vao8sOjMS8VRh64MkumrRhSh5UQ+T278s+jQdF/1PTGI4yaweNZuHiYF1RsyCiapdFcengyNajgZyP4RBhP8RpDAU42KcxqE30vNK7KYJQpploFY1NgnfmvApYiZxpskLAi6/PFVh454HBRyJ9K5yclvS5hJQggP7YA8vvZzJCi1+m3NKoUYnj8Eg31jSonDFuTTPEju9nIZuq55IP6FvUJ3iF0zjBqApLWOu6FTlp9FCgM90rX9/zpt1Z9z56QLkasatnLRfe8TT5pmHetQqI6RAoesB5A5aIy/s5jrxAl0VmrJHqFvrQuflCwCPM4Jy71s1L0tTA75IPzAyo5ea3D8eg5LORf2mWqnGaXz3Q+b3CcDm6nCtBfqeV5R+xsUyf1mC3eoBLp9qzAcocquN90qRxTW/Fhxk+Hw8o+HvQIOqPU2qkI7SLGeauAmhf8YrygVCepU0HmpkLqLaQ7nz43Ra3VJBknzqpA/SrivofpaduF64n9Kdt83OupJ/YA48ACiolRyRpHovuMd5kKs8PrA+JirjbsvlFBlE9DyP8qXnQ3+eNiblpOc+gfOCc0gGRGpeyzymq7dbLXSmch/q24qIQ1VBKjjMLUT7UheunmIq2qQgmg/wHquM6d9tIV7AAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAxOS0wMy0yMlQwMTo1NDowNiswMDowMOIizoUAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMTktMDMtMjJUMDE6NTQ6MDYrMDA6MDCTf3Y5AAAAAElFTkSuQmCC)](https://en.wikipedia.org/wiki/Copyleft)
 
-> Check out Ferium's sister projects [Ferinth](https://github.com/theRookieCoder/ferinth) and [Furse](https://github.com/theRookieCoder/furse), which are Rust libraries to use the Modrinth and CurseForge APIs respectively
+> Check out Ferium's sister projects [Ferinth](https://github.com/theRookieCoder/ferinth) and [Furse](https://github.com/theRookieCoder/furse), Rust libraries to use the Modrinth and CurseForge APIs
 
 Ferium is an easy to use CLI program for managing Minecraft mods from [Modrinth](https://modrinth.com/mods), [CurseForge](https://curseforge.com/minecraft/mc-mods), and [GitHub Releases](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases). Simply specify the mods you use through the CLI and in just one command, you can download all the mods and update existing ones.
 
 ## Feature Requests
 
-If you would like to make a feature request, check the [issues](https://github.com/theRookieCoder/ferium/issues) and the [project](https://github.com/theRookieCoder/ferium/projects/1) to see if the feature has already been added/planned. If not, [create a new issue](https://github.com/theRookieCoder/ferium/issues/new)
+If you would like to make a feature request, check the [issues](https://github.com/theRookieCoder/ferium/issues?q=is%3Aissue) to see if the feature has already been added/planned. If not, [create a new issue](https://github.com/theRookieCoder/ferium/issues/new).
 
 ## Building from Source or Working with Ferium
 
-Firstly you need the Rust toolchain (`cargo`, `rustup`, etc). You can install these from <https://rust-lang.org>.
+> Note; A lot of Ferium's backend is in a seperate project, [Libium](https://github.com/theRookieCoder/libium). You might want to make some edits there for things like the config
+
+Firstly you need the Rust toolchain (`cargo`, `rustup`, etc), you can install these from <https://rust-lang.org>. You'll also need the [Just](https://github.com/casey/just) command runner, its like `make` but better.
+
 If you want to build Ferium without cloning the repo, set the CurseForge API key then run `cargo install ferium`.
-To build the project and install it to your Cargo bin directory, clone the project then run `make install`. If you want to install for testing a developement version, use just `make` or `make install-dev`.
-If you want to obtain executables for a specific OS, you can run `make build-<OS>` and replace `<OS>` with `mac`, `win`, or `linux`. The produced binaries will be zipped and moved to `out/`.
-You can run the tests using `make test`. Don't use `cargo test` because that will interfere with your existing config, and the integration tests do not work when run in parallel. `make test` saves your config, forces tests to run sequentially, then restores your config (whether the tests failed or not).
+
+To build the project and install it to your Cargo binary directory, clone the project then run `just install`. If you want to install for testing a developement version, run `just` or `just install-dev`.
+If you want to obtain executables for a specific OS, you can run `just build-<OS>` and replace `<OS>` with `mac`, `win`, or `linux`. The produced binaries will be zipped and moved to `out/`.
+
+You can run integration tests using `just test`. Don't use `cargo test` because that will interfere with your existing config, and the integration tests do not work when run in parallel. `just test` saves your config, forces tests to run sequentially, then restores your config whether the tests failed or not. Yes this is a terrible way to design integration tests and I will be fixing this soon

README.md

@@ -1,48 +1,33 @@
-.SILENT: test
-.DEFAULT_GOAL := install-dev
+default: install-dev
 
-# This builds for macOS Intel and macOS Apple Silicon
+# Build for macOS Intel and macOS Apple Silicon
 build-mac:
-	make test
-# Remove previous builds
 	rm -f out/ferium-macos-x64.zip out/ferium-macos-arm.zip
-# Make builds output directory if it doesn't exist
 	mkdir -p out
-# Build for targets
 	cargo build --target=x86_64-apple-darwin --release
 	cargo build --target=aarch64-apple-darwin --release
-# Zip and move executables to out/
 	zip -r out/ferium-macos-x64.zip -j target/x86_64-apple-darwin/release/ferium
 	zip -r out/ferium-macos-arm.zip -j target/aarch64-apple-darwin/release/ferium
 
-# This builds for Windows MSVC
+# Build for Windows MSVC
 build-win:
-#	make test
-# Remove previous build if there is one
 	IF EXIST out\ferium-windows-msvc.zip DEL out\ferium-windows-msvc.zip
-# Make builds output directory if it doesn't exist
 	IF NOT EXIST out MKDIR out
-# Build for target
 	cargo build --target=x86_64-pc-windows-msvc --release
-# Zip and move executable to out/
 	PowerShell -Command Compress-Archive -Path "target\x86_64-pc-windows-msvc\release\ferium.exe" -DestinationPath "out\ferium-windows-msvc.zip"
 
-# This builds for GNU Linux and GNU Windows (e.g. cygwin)
+# Build for GNU Linux and GNU Windows (e.g. cygwin)
 build-linux:
-	make test
-# Remove previous builds
 	rm -f out/ferium-linux-gnu.zip out/ferium-windows-gnu.zip
-# Make builds output directory if it doesn't exist
 	mkdir -p out
-# Build for targets
 	cargo build --target=x86_64-pc-windows-gnu --release
 	cargo build --target=x86_64-unknown-linux-gnu --release
-# Zip and move executables to out/
 	zip -r out/ferium-linux-gnu.zip -j target/x86_64-unknown-linux-gnu/release/ferium
 	zip -r out/ferium-windows-gnu.zip -j target/x86_64-pc-windows-gnu/release/ferium.exe
 
+# Save config file and run integration tests
 test:
-	cargo clippy -- \
+	@cargo clippy -- \
 		-D clippy::all \
 		-D clippy::cargo \
 		-D clippy::complexity \
@@ -57,14 +42,15 @@ test:
 		-A clippy::enum-variant-names \
 		-A clippy::too-many-lines \
 		-A clippy::single-match-else
-	python3 tests/scripts/save_config.py
-# Don't parallelise the tests
-	-cargo test -- --test-threads=1
-	python3 tests/scripts/restore_config.py
+	@python3 tests/scripts/save_config.py
+	@-cargo test -- --test-threads=1
+	@python3 tests/scripts/restore_config.py
 
+# Install Ferium to cargo's binary folder
 install:
 	cargo install --force --path .
 
+# Install Ferium to cargo's binary folder but debug
 install-dev:
 	cargo install --debug --force --path .
 

makefile renamed to justfile

@@ -32,8 +32,12 @@ pub enum SubCommands {
 		#[clap(help("The project ID is specified as 'Project ID' in the 'About Project' sidebar of the mod's CurseForge page"))]
 		project_id: i32,
 	},
-	#[clap(about("List all the mods in the profile with some their metadata"))]
-	List,
+	#[clap(about("List all the mods in the profile, and with some their metadata if verbose"))]
+	List {
+		#[clap(long, short)]
+		#[clap(help("Show information about the mod"))]
+		verbose: bool,
+	},
 	#[clap(subcommand_required = true)]
 	#[clap(about("Create, configure, or remove the current profile"))]
 	Profile {

src/cli.rs

@@ -131,9 +131,25 @@ async fn actual_main() -> Result<()> {
 			let project = subcommands::add::curseforge(&curseforge, project_id, profile).await?;
 			println!("Added {}", project.name);
 		},
-		SubCommands::List => {
+		SubCommands::List { verbose } => {
 			check_empty_profile(profile)?;
-			subcommands::list::list(&curseforge, &modrinth, &github, profile).await?;
+			for mod_ in &profile.mods {
+				if verbose {
+					match mod_ {
+						config::structs::Mod::CurseForgeProject { project_id, .. } => {
+							subcommands::list::curseforge(&curseforge, *project_id).await
+						},
+						config::structs::Mod::ModrinthProject { project_id, .. } => {
+							subcommands::list::modrinth(&modrinth, project_id).await
+						},
+						config::structs::Mod::GitHubRepository { full_name, .. } => {
+							subcommands::list::github(&github, full_name).await
+						},
+					}?;
+				} else {
+					println!("{}", mod_.name());
+				}
+			}
 		},
 		SubCommands::Profile { subcommand } => match subcommand {
 			ProfileSubCommands::Configure {
@@ -160,8 +176,7 @@ async fn actual_main() -> Result<()> {
 		},
 		SubCommands::Remove { mod_names } => {
 			check_empty_profile(profile)?;
-			subcommands::remove::remove(&curseforge, &modrinth, &github, profile, mod_names)
-				.await?;
+			subcommands::remove::remove(profile, mod_names)?;
 		},
 		SubCommands::Switch { profile_name } => {
 			subcommands::switch::switch(&mut config, profile_name)?;
@@ -171,31 +186,39 @@ async fn actual_main() -> Result<()> {
 			// Empty the mods directory
 			let _ = remove_dir_all(&profile.output_dir).await;
 			create_dir_all(&profile.output_dir).await?;
-			for project_id in &profile.curse_projects {
-				if let Err(err) = subcommands::upgrade::curseforge(
-					&curseforge,
-					profile,
-					*project_id,
-					no_patch_check,
-				)
-				.await
-				{
-					println!("Could not download {} due to {}", project_id, err);
-				}
-			}
-			for project_id in &profile.modrinth_mods {
-				if let Err(err) =
-					subcommands::upgrade::modrinth(&modrinth, profile, project_id, no_patch_check)
-						.await
-				{
-					println!("Could not download {} due to {}", project_id, err);
-				}
-			}
-			for repo in &profile.github_repos {
-				if let Err(err) =
-					subcommands::upgrade::github(&github.repos(&repo.0, &repo.1), profile).await
-				{
-					println!("Could not download {}/{} due to {}", repo.0, repo.1, err);
+			for mod_ in &profile.mods {
+				use libium::config::structs::Mod;
+				if let (Err(err), name) = match mod_ {
+					Mod::CurseForgeProject { name, project_id } => (
+						subcommands::upgrade::curseforge(
+							&curseforge,
+							profile,
+							*project_id,
+							no_patch_check,
+						)
+						.await,
+						name,
+					),
+					Mod::ModrinthProject { name, project_id } => (
+						subcommands::upgrade::modrinth(
+							&modrinth,
+							profile,
+							project_id,
+							no_patch_check,
+						)
+						.await,
+						name,
+					),
+					Mod::GitHubRepository { name, full_name } => (
+						subcommands::upgrade::github(
+							&github.repos(&full_name.0, &full_name.1),
+							profile,
+						)
+						.await,
+						name,
+					),
+				} {
+					println!("Could not download {} due to {}", name, err);
 				}
 			}
 		},
@@ -209,10 +232,7 @@ async fn actual_main() -> Result<()> {
 
 /// Check if `profile` is empty, and if so return an error
 fn check_empty_profile(profile: &config::structs::Profile) -> Result<()> {
-	if profile.github_repos.is_empty()
-		&& profile.modrinth_mods.is_empty()
-		&& profile.curse_projects.is_empty()
-	{
+	if profile.mods.is_empty() {
 		Err(Error::EmptyConfigFile)
 	} else {
 		Ok(())