Added CLI. See CHANGELOG.md for more details

Author: theRookieCoder

CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog for Ferium
+
+This changelog is formatted based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+
+## [3.1.0] - 05.08.2021
+
+### Added
+
+- This changelog
+- Command line interface and corresponding code (under `cli.rs` and `cli.yaml`)
+- Help page and command, add mod command, list mods command
+- `Users` struct for Labrinth
+- JSON file write
+- `does_exist()` function for checking if a mod exists
+- Error codes (see changed)
+
+### Changed
+
+- Moved utilities to `util` folder
+- Made all panics into `println!`s and exits (with descriptive error codes)
+- Commented code better

Cargo.lock

@@ -1,12 +1,13 @@
 [package]
 name = "ferium"
-version = "3.0.0"
+version = "3.1.0"
 edition = "2018"
 authors = ["theRookieCoder"]
 
 [dependencies]
 reqwest = { version = "0.11", features = ["json", "blocking"] }
 serde = { version = "1", features = ["derive"] }
+clap = {version = "2", features = ["yaml"]}
 serde_json = "1"
 bytes = "1"
 shellexpand = "2"

Cargo.toml

@@ -1,11 +1,48 @@
 # Ferium
 
-Ferium is a package manager like program for Minecraft mods (that are on Modrinth). You can add mods by finding your mods on Modrinth, specifying their project IDs in the config file, and running the command. Ferium will download the latest version of each mod in the config. It replaces (i.e. overwrites) any older downloads.
+Ferium is an open source and easy to use package manager for Minecraft mods (that are on [Modrinth](https://modrinth.com)).
 
-## Feature TODO
+## Feature to do
 
-- [ ] Check that the version is compatible with a specified Minecraft version
-- [ ] Allow configuration through a CLI
-- [ ] Release the Labrinth library as a seperate Crate
+- [x] Allow configuration through a CLI
 - [ ] Add support for downloading from Github releases
+- [ ] Release the Labrinth library as a seperate Crate
+- [ ] Check that the version is compatible with a specified Minecraft version
 - [ ] Add support for downloading from CurseForge
+
+## Help page
+
+This section is the same as the one in `ferium help` + formatting.
+
+### Usage
+`ferium <command> [arguments]`
+    
+### Commands
+- `list`
+  - List all the mods configured with some of their metadata
+- `help`
+  - Show this help page
+- `upgrade`
+  - Download and install the latest version of the mods specified
+- `add MOD_ID`
+  - Add a mod to the config
+  - A mod's `MOD_ID` is specified as '`</>` PROJECT ID' in the right sidebar of the mod's Modrith page
+    
+### Examples
+```bash
+$ ferium upgrade        # Upgrades all the mods in your config
+$ ferium add AANobbMI   # Adds the Sodium mod to your config
+```
+
+### Error codes
+- `120`: I/O error
+- `122`: JSON error
+- `124`: Server/HTTP error
+- `126`: General error
+
+### Feedback
+You can [open an issue](https://github.com/theRookieCoder/ferium/issues/new).  
+If you know how to and are willing to fix it, then you can make a pull request.
+    
+### Contributing
+Think you can improve Ferium? Well head on to [Ferium's repository](https://github.com/theRookieCoder/ferium) and you can start working on Ferium!

LICENSE renamed to LICENSE.txt

@@ -1,28 +1,58 @@
+/*
+ * This file contains abstractions of some of the calls supported by the Labrinth API
+ */
+
 use super::structs::*;
 use bytes::Bytes;
 use reqwest::blocking::{get, Response};
+use reqwest::StatusCode;
+use std::process::exit;
 
 /// Return the contents of `version`'s JAR file as bytes
 pub fn download_version(version: &Version) -> Bytes {
     match request(&version.files[0].url, false).bytes() {
         Ok(contents) => contents,
-        Err(e) => panic!("No response from server. {}", e),
+        Err(e) => {
+            println!("No response from server. {}", e);
+            exit(124);
+        }
+    }
+}
+
+// Chcek if a mod exists. If it does, then the mod is returned, else None is returned
+pub fn does_exist(mod_id: &ID) -> Option<Mod> {
+    let response = request(&format!("/mod/{}", mod_id), true);
+    match response.status() {
+        StatusCode::OK => Some(match response.json() {
+            Ok(typed) => typed,
+            Err(e) => {
+                println!("JSON deserialisation failed due to {}", e);
+                exit(122);
+            }
+        }),
+        _ => Option::None,
     }
 }
 
 /// Returns the versions of `mod_id`'s mod sorted in chronologically descending order
 pub fn get_versions(mod_id: &str) -> Vec<Version> {
     match request(&format!("/mod/{}/version", mod_id), true).json() {
         Ok(typed) => typed,
-        Err(e) => panic!("JSON deserialisation failed due to {}", e),
+        Err(e) => {
+            println!("JSON deserialisation failed due to {}", e);
+            exit(122);
+        }
     }
 }
 
 /// Get a mod using the `mod_slug`, which can also be the mod ID
 pub fn get_mod(mod_slug: &str) -> Mod {
     match request(&format!("/mod/{}", mod_slug), true).json() {
         Ok(typed) => typed,
-        Err(e) => panic!("JSON deserialisation failed due to {}", e),
+        Err(e) => {
+            println!("JSON deserialisation failed due to {}", e);
+            exit(122);
+        }
     }
 }
 
@@ -40,9 +70,13 @@ fn request(url: &str, relative: bool) -> Response {
             if response.status().is_success() {
                 response
             } else {
-                panic!("HTTP request failed with error code {}", response.status());
+                println!("HTTP request failed with error code {}", response.status());
+                exit(124);
             }
         }
-        Err(e) => panic!("HTTP request failed due to {}", e),
+        Err(e) => {
+            println!("HTTP request failed due to {}", e);
+            exit(124);
+        }
     }
 }

README.md

@@ -1,3 +1,7 @@
+/*
+ * This file contains typed structs of the data structures used by the Labrinth API
+ */
+
 use serde::{Deserialize, Serialize};
 use std::collections::HashMap;
 use std::vec::Vec;
@@ -31,6 +35,19 @@ pub struct VersionFile {
     pub filename: String,
 }
 
+#[derive(Deserialize, Serialize, Debug)]
+pub struct User {
+    pub id: ID,
+    pub github_id: Option<u64>,
+    pub username: String,
+    pub name: String,
+    pub email: Option<String>,
+    pub avatar_url: Option<String>,
+    pub bio: String,
+    pub created: Datetime,
+    pub role: String,
+}
+
 #[derive(Deserialize, Serialize, Debug)]
 pub struct Mod {
     pub id: ID,