Update color API (#619)

This is a breaking change because it removes and renames some methods.
It also makes the `rgb()` method public.

Author: spenserblack

Cargo.lock

@@ -3,14 +3,12 @@ members = ["gengo", "gengo-bin", "samples-test"]
 resolver = "2"
 
 [workspace.dependencies]
-chromaterm = "0.1.1"
 indexmap = "2"
-owo-colors = ">=3, <=4"
 serde_json = "1"
 
 [workspace.package]
 description = "Get the language distribution stats of your repository"
-version = "0.13.3"
+version = "0.14.0"
 edition = "2024"
 repository = "https://github.com/spenserblack/gengo"
 readme = "README.md"

Cargo.toml

@@ -18,12 +18,12 @@ name = "gengo"
 
 [features]
 default = ["color", "gengo/max-performance"]
-color = ["chromaterm", "gengo/chromaterm", "relative-luminance"]
+color = ["dep:chromaterm", "dep:relative-luminance"]
 
 [dependencies]
-chromaterm = { workspace = true, optional = true }
+chromaterm = { version = "0.1.1", optional = true }
 clap = { version = "4", features = ["derive", "wrap_help"] }
-gengo = { path = "../gengo", version = "0.13", default-features = false, features = [
+gengo = { path = "../gengo", version = "0.14", default-features = false, features = [
     "directory",
     "git",
 ] }

gengo-bin/Cargo.toml

@@ -136,7 +136,10 @@ impl CLI {
         for (language, size) in summary.iter() {
             let percentage = (*size * 100) as f64 / total;
             #[cfg(feature = "color")]
-            let color = language.chromaterm_color();
+            let color = {
+                let (r, g, b) = language.rgb();
+                chromaterm::colors::True::from_rgb(r, g, b)
+            };
             #[cfg(not(feature = "color"))]
             let color = ();
 
@@ -198,7 +201,10 @@ impl CLI {
 
         for (language, files) in files_per_language.into_iter() {
             #[cfg(feature = "color")]
-            let color = language.chromaterm_color();
+            let color = {
+                let (r, g, b) = language.rgb();
+                chromaterm::colors::True::from_rgb(r, g, b)
+            };
             #[cfg(not(feature = "color"))]
             let color = ();
 

gengo-bin/src/cli.rs

@@ -9,7 +9,7 @@ expression: json
     "generated": false,
     "language": {
       "category": "programming",
-      "color": "#F0DC4E",
+      "hex": "#F0DC4E",
       "name": "JavaScript",
       "nerd_font_glyph": ""
     },
@@ -22,7 +22,7 @@ expression: json
     "generated": true,
     "language": {
       "category": "prose",
-      "color": "#000000",
+      "hex": "#000000",
       "name": "Plain Text",
       "nerd_font_glyph": null
     },
@@ -35,7 +35,7 @@ expression: json
     "generated": false,
     "language": {
       "category": "markup",
-      "color": "#E96228",
+      "hex": "#E96228",
       "name": "HTML",
       "nerd_font_glyph": ""
     },
@@ -48,7 +48,7 @@ expression: json
     "generated": false,
     "language": {
       "category": "programming",
-      "color": "#F0DC4E",
+      "hex": "#F0DC4E",
       "name": "JavaScript",
       "nerd_font_glyph": ""
     },
@@ -61,7 +61,7 @@ expression: json
     "generated": false,
     "language": {
       "category": "programming",
-      "color": "#2F74C0",
+      "hex": "#2F74C0",
       "name": "TypeScript",
       "nerd_font_glyph": ""
     },

gengo-bin/tests/snapshots/test_cli__json_output_on_javascript_repo.snap

@@ -26,7 +26,6 @@ max-performance = ["dep:gix", "gix/max-performance"]
 max-performance-safe = ["dep:gix", "gix/max-performance-safe"]
 
 [dependencies]
-chromaterm = { workspace = true, optional = true }
 gix = { version = ">= 0.56, <= 0.72", optional = true, default-features = false, features = [
     "attributes",
     "index",
@@ -36,7 +35,6 @@ gix = { version = ">= 0.56, <= 0.72", optional = true, default-features = false,
 glob = "0.3"
 ignore = { version = "0.4", optional = true }
 indexmap = { workspace = true, features = ["rayon", "serde"] }
-owo-colors = { workspace = true, optional = true }
 rayon = "1"
 regex = "1"
 serde = { version = "1", features = ["derive"] }

gengo/Cargo.toml

@@ -308,8 +308,8 @@ fn main() -> Result<(), Box<dyn Error>> {
     );
     let color_hex_mixin = quote! {
         impl Language {
-            /// Gets the color associated with the language.
-            pub const fn color(&self) -> &'static str {
+            /// Gets the hex code associated with the language.
+            pub const fn hex(&self) -> &'static str {
                 match self {
                     #(#color_hex_mappings ,)*
                 }
@@ -335,7 +335,7 @@ fn main() -> Result<(), Box<dyn Error>> {
     let color_rgb_mixin = quote! {
         impl Language {
             /// Gets the RGB color associated with the language.
-            const fn color_rgb(&self) -> (u8, u8, u8) {
+            pub const fn rgb(&self) -> (u8, u8, u8) {
                 match self {
                     #(#color_rgb_mappings ,)*
                 }

gengo/build.rs

@@ -198,7 +198,7 @@ impl Language {
         Serialize {
             name: self.name(),
             category: self.category(),
-            color: self.color(),
+            hex: self.hex(),
             nerd_font_glyph: self.nerd_font_glyph(),
         }
     }
@@ -228,24 +228,6 @@ impl serde::Serialize for Language {
     }
 }
 
-#[cfg(feature = "chromaterm")]
-impl Language {
-    /// Converts the color to RGB true color.
-    pub const fn chromaterm_color(&self) -> chromaterm::colors::True {
-        let (r, g, b) = self.color_rgb();
-        chromaterm::colors::True::from_rgb(r, g, b)
-    }
-}
-
-#[cfg(feature = "owo-colors")]
-impl Language {
-    /// Converts the color to RGB.
-    pub const fn owo_color(&self) -> owo_colors::Rgb {
-        let (r, g, b) = self.color_rgb();
-        owo_colors::Rgb(r, g, b)
-    }
-}
-
 /// A category for a language.
 #[non_exhaustive]
 #[derive(Clone, Debug, serde::Deserialize, Eq, Hash, PartialEq, serde::Serialize)]
@@ -270,7 +252,7 @@ pub enum Category {
 struct Serialize {
     name: &'static str,
     category: Category,
-    color: &'static str,
+    hex: &'static str,
     nerd_font_glyph: Option<&'static str>,
 }
 

gengo/src/language/mod.rs

@@ -10,4 +10,4 @@ license.workspace = true
 keywords.workspace = true
 
 [dependencies]
-gengo = { path = "../gengo", version = "0.13", default-features = false }
+gengo = { path = "../gengo", version = "0.14", default-features = false }