Add utility to help format the code (#247)

Signed-off-by: Aisuko <[email protected]>

Readme.md

@@ -106,6 +106,15 @@ If you want to revert back to the original name, just clear the name and click r
 
 ### How can I help/contribute?
 If you are a coder, you are very welcome! You can fork this repo and then create a pull request.
+
+To check formats and errors of code before run the code:
+
+```shell
+cargo fmt
+
+cargo check
+```
+
 To run BoilR just write:
 
 ```shell

src/config.rs

@@ -52,39 +52,39 @@ pub fn get_boilr_links_path() -> PathBuf {
     get_config_folder().join("links")
 }
 
-
 #[cfg(test)]
-mod tests{
+mod tests {
     use std::path::PathBuf;
 
     use super::get_config_folder;
 
     #[test]
-
     #[cfg(target_family = "unix")]
-    fn check_return_xdg_config_path(){
-
+    fn check_return_xdg_config_path() {
         // Parameters for set environment 'XDG_CONFIG_HOME'
-        std::env::set_var("XDG_CONFIG_HOME", std::env::var("HOME").unwrap()+"/.config/boilr");
+        std::env::set_var(
+            "XDG_CONFIG_HOME",
+            std::env::var("HOME").unwrap() + "/.config/boilr",
+        );
 
-        let xdg_config_home=std::env::var("XDG_CONFIG_HOME").unwrap();
-        let config_path=get_config_folder();
-        let test_path=PathBuf::from(xdg_config_home);
+        let xdg_config_home = std::env::var("XDG_CONFIG_HOME").unwrap();
+        let config_path = get_config_folder();
+        let test_path = PathBuf::from(xdg_config_home);
 
-        assert_eq!(config_path,test_path);
+        assert_eq!(config_path, test_path);
     }
 
-
     #[test]
-
     #[cfg(target_family = "unix")]
-    fn check_return_config_path(){
+    fn check_return_config_path() {
+        std::env::set_var(
+            "XDG_CONFIG_HOME",
+            std::env::var("HOME").unwrap() + "/.config/boilr",
+        );
 
-        std::env::set_var("XDG_CONFIG_HOME", std::env::var("HOME").unwrap()+"/.config/boilr");
-
-        let config_path=get_config_folder();
-        let current_path=std::env::var("HOME").unwrap()+"/.config/boilr";
+        let config_path = get_config_folder();
+        let current_path = std::env::var("HOME").unwrap() + "/.config/boilr";
 
-        assert_eq!(config_path,PathBuf::from(current_path));
+        assert_eq!(config_path, PathBuf::from(current_path));
     }
-}
+}

src/main.rs

@@ -9,7 +9,7 @@ mod ui;
 
 use color_eyre::eyre::Result;
 
-fn main() -> Result<()>{
+fn main() -> Result<()> {
     color_eyre::install()?;
     ensure_config_folder();
     migration::migrate_config();

src/migration.rs

@@ -1,6 +1,6 @@
 use std::path::Path;
 
-use crate::{settings::save_settings, platforms::get_platforms};
+use crate::{platforms::get_platforms, settings::save_settings};
 
 pub fn migrate_config() {
     let version = &crate::settings::Settings::new()

src/platforms/amazon/amazon_platform.rs

@@ -3,17 +3,20 @@ use sqlite::State;
 use std::path::{Path, PathBuf};
 use steam_shortcuts_util::{shortcut::ShortcutOwned, Shortcut};
 
-use crate::platforms::{to_shortcuts_simple, ShortcutToImport, FromSettingsString, load_settings, GamesPlatform};
+use crate::platforms::{
+    load_settings, to_shortcuts_simple, FromSettingsString, GamesPlatform, ShortcutToImport,
+};
 
 #[derive(Clone)]
 pub struct AmazonPlatform {
     pub settings: AmazonSettings,
 }
 
-
-impl FromSettingsString for AmazonPlatform{
-    fn from_settings_string<S:AsRef<str>>(s:S) -> Self {        
-        AmazonPlatform { settings: load_settings(s) }
+impl FromSettingsString for AmazonPlatform {
+    fn from_settings_string<S: AsRef<str>>(s: S) -> Self {
+        AmazonPlatform {
+            settings: load_settings(s),
+        }
     }
 }
 
@@ -51,26 +54,24 @@ fn get_launcher_path() -> eyre::Result<PathBuf> {
     }
 }
 
-impl GamesPlatform for AmazonPlatform{
+impl GamesPlatform for AmazonPlatform {
     fn name(&self) -> &str {
         "Amazon"
     }
-
 
     fn enabled(&self) -> bool {
         self.settings.enabled
     }
 
     fn get_shortcut_info(&self) -> eyre::Result<Vec<ShortcutToImport>> {
         to_shortcuts_simple(self.get_amazon_games())
-
     }
 
     fn render_ui(&mut self, ui: &mut egui::Ui) {
         ui.heading("Amazon");
         ui.checkbox(&mut self.settings.enabled, "Import from Amazon");
     }
-    
+
     fn get_settings_serilizable(&self) -> String {
         toml::to_string(&self.settings).unwrap_or_default()
     }
@@ -80,9 +81,7 @@ impl GamesPlatform for AmazonPlatform{
     }
 }
 
-
 impl AmazonPlatform {
-
     fn get_amazon_games(&self) -> eyre::Result<Vec<AmazonGame>> {
         let sqllite_path = get_sqlite_path()?;
         let launcher_path = get_launcher_path()?;
@@ -141,14 +140,17 @@ pub struct AmazonSettings {
     pub launcher_location: Option<String>,
 }
 
-impl Default for AmazonSettings{
+impl Default for AmazonSettings {
     fn default() -> Self {
         #[cfg(target_family = "unix")]
         let enabled = false;
 
         #[cfg(not(target_family = "unix"))]
         let enabled = true;
 
-        Self { enabled, launcher_location: Default::default() }
+        Self {
+            enabled,
+            launcher_location: Default::default(),
+        }
     }
-}
+}

src/platforms/amazon/mod.rs

@@ -1,4 +1,4 @@
 mod amazon_platform;
 
+pub use amazon_platform::AmazonGame;
 pub use amazon_platform::AmazonPlatform;
-pub use amazon_platform::AmazonGame;

src/platforms/bottles/platform.rs

@@ -5,16 +5,20 @@ use serde::{Deserialize, Serialize};
 
 use steam_shortcuts_util::{shortcut::ShortcutOwned, Shortcut};
 
-use crate::platforms::{to_shortcuts_simple, ShortcutToImport, FromSettingsString, load_settings, GamesPlatform};
+use crate::platforms::{
+    load_settings, to_shortcuts_simple, FromSettingsString, GamesPlatform, ShortcutToImport,
+};
 
 #[derive(Debug, Deserialize, Serialize, Clone)]
 pub struct BottlesPlatform {
     pub settings: BottlesSettings,
 }
 
-impl FromSettingsString for BottlesPlatform{
+impl FromSettingsString for BottlesPlatform {
     fn from_settings_string<S: AsRef<str>>(s: S) -> Self {
-        BottlesPlatform { settings: load_settings(s) }
+        BottlesPlatform {
+            settings: load_settings(s),
+        }
     }
 }
 
@@ -29,7 +33,7 @@ pub struct BottlesSettings {
     pub enabled: bool,
 }
 
-impl Default for BottlesSettings{
+impl Default for BottlesSettings {
     fn default() -> Self {
         #[cfg(target_family = "unix")]
         let enabled = true;
@@ -124,8 +128,7 @@ impl BottlesPlatform {
     }
 }
 
-
-impl GamesPlatform for BottlesPlatform{
+impl GamesPlatform for BottlesPlatform {
     fn name(&self) -> &str {
         "Bottles"
     }
@@ -142,12 +145,12 @@ impl GamesPlatform for BottlesPlatform{
         ui.heading("Bottles");
         ui.checkbox(&mut self.settings.enabled, "Import from Bottles");
     }
-    
+
     fn get_settings_serilizable(&self) -> String {
         toml::to_string(&self.settings).unwrap_or_default()
     }
 
     fn code_name(&self) -> &str {
         "bottles"
     }
-}
+}

src/platforms/egs/epic_platform.rs

@@ -1,5 +1,5 @@
 use crate::platforms::{
-    load_settings, to_shortcuts, FromSettingsString, NeedsPorton, ShortcutToImport, GamesPlatform,
+    load_settings, to_shortcuts, FromSettingsString, GamesPlatform, NeedsPorton, ShortcutToImport,
 };
 
 use super::{get_egs_manifests, settings::EpicGamesLauncherSettings, ManifestItem};
@@ -32,7 +32,7 @@ impl NeedsPorton<EpicPlatform> for ManifestItem {
     }
 }
 
-impl GamesPlatform for EpicPlatform{
+impl GamesPlatform for EpicPlatform {
     fn name(&self) -> &str {
         "Epic"
     }
@@ -52,8 +52,8 @@ impl GamesPlatform for EpicPlatform{
     fn render_ui(&mut self, ui: &mut egui::Ui) {
         self.render_epic_settings(ui)
     }
-    
+
     fn get_settings_serilizable(&self) -> String {
         toml::to_string(&self.settings).unwrap_or_default()
     }
-}
+}

src/platforms/egs/get_manifests.rs

@@ -42,7 +42,7 @@ pub(crate) fn get_egs_manifests(
                             }
                         }
                     }
-                    let mut manifests :Vec<ManifestItem> = all_manifests                        
+                    let mut manifests: Vec<ManifestItem> = all_manifests
                         .filter(is_game_installed)
                         .filter(is_game_launchable)
                         .collect();
@@ -71,7 +71,6 @@ pub(crate) fn get_egs_manifests(
     }
 }
 
-
 fn is_game_installed(manifest: &ManifestItem) -> bool {
     Path::new(manifest.manifest_location.as_str()).exists()
 }

src/platforms/egs/manifest_item.rs

@@ -124,7 +124,6 @@ fn launcher_shortcut(manifest: ManifestItem) -> ShortcutOwned {
     .to_owned()
 }
 
-
 impl From<ManifestItem> for ShortcutOwned {
     fn from(manifest: ManifestItem) -> Self {
         let mut owned_shortcut = if manifest.needs_launcher() {
@@ -163,8 +162,8 @@ impl ManifestItem {
             self.catalog_namespace, self.catalog_item_id, self.app_name
         )
     }
-    
-    pub fn dedupe_key(&self)-> String {
+
+    pub fn dedupe_key(&self) -> String {
         format!(
             "{}-{}-{}",
             self.install_location, self.launch_executable, self.is_managed

src/platforms/egs/mod.rs

@@ -1,12 +1,11 @@
 mod epic_platform;
+mod epic_ui;
 mod get_manifests;
 mod manifest_item;
 mod paths;
 mod settings;
-mod epic_ui;
 
 pub use epic_platform::*;
 use get_manifests::get_egs_manifests;
 pub(crate) use manifest_item::*;
 use paths::*;
-

src/platforms/flatpak/platform.rs

@@ -1,6 +1,8 @@
 use serde::{Deserialize, Serialize};
 
-use crate::platforms::{NeedsPorton, to_shortcuts, ShortcutToImport, GamesPlatform, FromSettingsString, load_settings};
+use crate::platforms::{
+    load_settings, to_shortcuts, FromSettingsString, GamesPlatform, NeedsPorton, ShortcutToImport,
+};
 
 use super::FlatpakSettings;
 use steam_shortcuts_util::{shortcut::ShortcutOwned, Shortcut};
@@ -23,7 +25,7 @@ impl From<FlatpakApp> for ShortcutOwned {
     }
 }
 
-impl NeedsPorton<FlatpakPlatform> for FlatpakApp{
+impl NeedsPorton<FlatpakPlatform> for FlatpakApp {
     fn needs_proton(&self, _platform: &FlatpakPlatform) -> bool {
         false
     }
@@ -34,7 +36,6 @@ impl NeedsPorton<FlatpakPlatform> for FlatpakApp{
 }
 
 impl FlatpakPlatform {
-
     fn get_flatpak_apps(&self) -> eyre::Result<Vec<FlatpakApp>> {
         use std::process::Command;
         let mut command = Command::new("flatpak");
@@ -60,20 +61,18 @@ impl FlatpakPlatform {
     }
 }
 
-
-impl FromSettingsString for FlatpakPlatform{
+impl FromSettingsString for FlatpakPlatform {
     fn from_settings_string<S: AsRef<str>>(s: S) -> Self {
         FlatpakPlatform {
             settings: load_settings(s),
         }
     }
-} 
+}
 
-impl GamesPlatform for FlatpakPlatform{
+impl GamesPlatform for FlatpakPlatform {
     fn name(&self) -> &str {
         "Flatpak"
     }
-
 
     fn enabled(&self) -> bool {
         self.settings.enabled
@@ -87,12 +86,12 @@ impl GamesPlatform for FlatpakPlatform{
         ui.heading("Flatpak");
         ui.checkbox(&mut self.settings.enabled, "Import from Flatpak");
     }
-    
+
     fn get_settings_serilizable(&self) -> String {
         toml::to_string(&self.settings).unwrap_or_default()
     }
 
     fn code_name(&self) -> &str {
         "flatpak"
     }
-}
+}