refactor: make interface more user friendly

Author: alexpasmantier

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
-name = "rust-devicons"
-version = "0.2.3"
+name = "devicons"
+version = "0.3.3"
 edition = "2021"
 authors = ["Alexandre Pasmantier <alex.pasmant@gmail.com>"]
 license = "Unlicense"

Cargo.toml

@@ -16,11 +16,8 @@ A dead-simple and efficient Rust library inspired by [vim-devicons](https://gith
 
 ## Installation
 
-Add this to your `Cargo.toml`:
-
-```toml
-[dependencies]
-devicons = "0.1.0"
+```sh
+cargo add devicons
 ```
 
 _**NOTE**: you'll need to use a [NerdFont](https://www.nerdfonts.com/) to properly display the icons._
@@ -31,15 +28,17 @@ Here’s a simple example of how to use `devicons` to retrieve a file icon with
 
 ```rust
 use std::path::Path;
-use your_library::{File, Theme, icon_for_file};
+use devicons::{File, Theme, icon_for_file};
 
 fn main() {
+    // getting the icon from a path
     let path = Path::new("example.txt");
-    let file = File::new(path);
+    let icon = icon_for_file(path, Some(Theme::Dark));
 
-    let icon = icon_for_file(&file, Some(Theme::Dark));
+    // getting the icon from a str
+    let icon = icon_for_file("example.txt", Some(Theme::Dark));
 
-    println!("File: {}", file.name);
+    println!("File: {}", path.to_string_lossy());
     println!("Icon: {}", icon.icon);
     println!("Color: {}", icon.color);
 }

README.md

@@ -1,16 +1,15 @@
-use devicons::{icon_for_file, File, Theme};
+use devicons::{icon_for_file, Theme};
 use std::path::Path;
 
 fn main() {
     // Create a new file instance for "example.txt"
     let path = Path::new("example.txt");
-    let file = File::new(path);
 
     // Get the icon for this file with the dark theme
-    let icon = icon_for_file(&file, Some(Theme::Dark));
+    let icon = icon_for_file(path, Some(Theme::Dark));
 
     // Print its corresponding icon
-    println!("Filename: {}", file.name);
+    println!("Filename: {}", path.to_string_lossy());
     println!("Icon: {}", icon.icon);
     println!("Color: {}", icon.color);
 }

examples/dark_theme.rs

@@ -1,16 +1,15 @@
-use devicons::{icon_for_file, File};
+use devicons::icon_for_file;
 use std::path::Path;
 
 fn main() {
     // Create a new file instance for a directory "my_folder/"
     let path = Path::new("my_folder/");
-    let file = File::new(path);
 
     // Get the icon for this directory with the default theme
-    let icon = icon_for_file(&file, None);
+    let icon = icon_for_file(path, None);
 
     // Print its corresponding icon
-    println!("Filename: {}", file.name);
+    println!("Filename: {}", path.to_string_lossy());
     println!("Icon: {}", icon.icon);
     println!("Color: {}", icon.color);
 }

examples/default.rs

@@ -1,16 +1,15 @@
-use devicons::{icon_for_file, File, Theme};
+use devicons::{icon_for_file, Theme};
 use std::path::Path;
 
 fn main() {
     // Create a new file instance for a directory "my_folder/"
     let path = Path::new("my_folder/");
-    let file = File::new(path);
 
     // Get the icon for this directory with the light theme
-    let icon = icon_for_file(&file, Some(Theme::Light));
+    let icon = icon_for_file(path, Some(Theme::Light));
 
     // Print its corresponding icon
-    println!("Filename: {}", file.name);
+    println!("Filename: {}", path.to_string_lossy());
     println!("Icon: {}", icon.icon);
     println!("Color: {}", icon.color);
 }

examples/light_theme.rs

@@ -13,8 +13,11 @@ pub struct File<'a> {
 }
 
 impl File<'_> {
-    pub fn new<'a>(path: &'a Path) -> File<'a> {
-        let path = path;
+    pub fn new<'a, P>(path: P) -> File<'a>
+    where
+        P: Into<&'a Path>,
+    {
+        let path: &Path = path.into();
         let name = path.file_name().unwrap().to_str().unwrap();
         let ext = Self::ext(path);
 
@@ -35,6 +38,19 @@ impl File<'_> {
     }
 }
 
+impl<'a> From<&'a Path> for File<'a> {
+    fn from(path: &'a Path) -> File<'a> {
+        File::new(path)
+    }
+}
+
+impl<'a> From<&'a str> for File<'a> {
+    fn from(path: &'a str) -> File<'a> {
+        let path = Path::new(path); // Convert &str to &Path
+        File::new(path)
+    }
+}
+
 pub enum Theme {
     Light,
     Dark,
@@ -68,11 +84,15 @@ const DEFAULT_DIR_ICON: FileIcon = FileIcon {
     color: "#7e8e91",
 };
 
-pub fn icon_for_file(file: &File<'_>, theme: Option<Theme>) -> FileIcon {
+pub fn icon_for_file<'a, F>(file: F, theme: Option<Theme>) -> FileIcon
+where
+    F: Into<File<'a>>,
+{
+    let file = file.into();
     match theme {
-        Some(Theme::Light) => light_icon_for_file(file),
-        Some(Theme::Dark) => dark_icon_for_file(file),
-        None => dark_icon_for_file(file),
+        Some(Theme::Light) => light_icon_for_file(&file),
+        Some(Theme::Dark) => dark_icon_for_file(&file),
+        None => dark_icon_for_file(&file),
     }
 }
 
@@ -162,9 +182,8 @@ mod tests {
     #[test]
     fn test_icon_for_file_with_light_theme() {
         let path = Path::new("file.txt");
-        let file = File::new(path);
 
-        let icon = icon_for_file(&file, Some(Theme::Light));
+        let icon = icon_for_file(path, Some(Theme::Light));
         assert_eq!(icon.icon, '󰈙');
         assert_eq!(icon.color, "#447028");
     }
@@ -174,7 +193,7 @@ mod tests {
         let path = Path::new("file.txt");
         let file = File::new(path);
 
-        let icon = icon_for_file(&file, Some(Theme::Dark));
+        let icon = icon_for_file(file, Some(Theme::Dark));
         assert_eq!(icon.icon, '󰈙');
         assert_eq!(icon.color, "#89e051");
     }
@@ -184,7 +203,7 @@ mod tests {
         let path = Path::new("some_directory/");
         let file = File::new(path);
 
-        let icon = icon_for_file(&file, Some(Theme::Dark));
+        let icon = icon_for_file(file, Some(Theme::Dark));
         assert_eq!(icon.icon, '\u{f115}'); // Default directory icon
         assert_eq!(icon.color, "#7e8e91");
     }
@@ -194,7 +213,7 @@ mod tests {
         let path = Path::new("file.txt");
         let file = File::new(path);
 
-        let icon = icon_for_file(&file, None); // Should default to Dark theme
+        let icon = icon_for_file(file, None); // Should default to Dark theme
         assert_eq!(icon.icon, '󰈙');
         assert_eq!(icon.color, "#89e051");
     }