Merge branch '1.0-2025'

Author: bash

.github/workflows/ci.yml

@@ -95,4 +95,3 @@ jobs:
         tool: just
     - run: just test-package xterm-color
     - run: just test-package terminal-colorsaurus
-    - run: just test-package termtheme

Cargo.lock

@@ -3,10 +3,7 @@ members = ["crates/*"]
 resolver = "2"
 
 [workspace.package]
-version = "0.4.8"
-
-[workspace.dependencies]
-terminal-colorsaurus = { path = "crates/terminal-colorsaurus", version = "0.4.7" }
+version = "1.0.0"
 
 [workspace.lints.rust]
 missing_debug_implementations = "warn"

Cargo.toml

@@ -1,4 +1,16 @@
 # Changelog
+## 1.0.0
+### Breaking
+* Renamed color scheme to theme mode.
+* Marked `Color` as `#[non_exhaustive]` to allow extension.
+* Future-proofed `Error::UnsupportedTerminal` by introducing an empty struct.
+* Changed the return type of `perceived_lightness` to be a float.
+* Removed the `Default` impl from `ColorScheme` (now theme mode).
+* Raised the minimum supported rust version (MSRV) to 1.74.0.
+
+### Features
+* All structs implement `Hash` now.
+
 ## 0.4.8
 * 🐛 Fixed an error on windows where the query would not
   succeed when the standard input was redirected.

changelog.md

@@ -8,4 +8,4 @@ publish = false
 clap = { version = "4.4", features = ["derive"] }
 anstyle = "1.0.8"
 indicatif = "0.17.7"
-terminal-colorsaurus.workspace = true
+terminal-colorsaurus.path = "../terminal-colorsaurus"

crates/benchmark/Cargo.toml

@@ -42,7 +42,7 @@ fn main() -> Result<()> {
 
     let supported = match color_palette(QueryOptions::default()) {
         Ok(_) => true,
-        Err(Error::UnsupportedTerminal) => false,
+        Err(Error::UnsupportedTerminal(_)) => false,
         Err(e) => return Err(e),
     };
 
@@ -54,7 +54,7 @@ fn main() -> Result<()> {
 fn bench() -> Result<Duration> {
     let start = Instant::now();
     match black_box(color_palette(QueryOptions::default())) {
-        Ok(_) | Err(Error::UnsupportedTerminal) => Ok(start.elapsed()),
+        Ok(_) | Err(Error::UnsupportedTerminal(_)) => Ok(start.elapsed()),
         Err(err) => Err(err),
     }
 }

crates/benchmark/src/main.rs

@@ -11,4 +11,4 @@ crate-type = ["cdylib"]
 
 [dependencies]
 pyo3 = "0.25.0"
-terminal-colorsaurus.workspace = true
+terminal-colorsaurus.path = "../terminal-colorsaurus"

crates/pycolorsaurus/Cargo.toml

@@ -1,7 +1,3 @@
-// Useless conversion is in code generated by PYO3
-// FIXME(msrv): Use `#[allow(..., reason = "...")]`
-#![allow(clippy::useless_conversion)]
-
 use pyo3::{
     create_exception,
     exceptions::{PyException, PyIndexError, PyValueError},
@@ -18,12 +14,12 @@ use terminal_colorsaurus as imp;
 /// This package helps answer the question "Is this terminal dark or light?".
 #[pymodule]
 fn colorsaurus(py: Python, m: &Bound<'_, PyModule>) -> PyResult<()> {
-    m.add_function(wrap_pyfunction!(color_scheme, m)?)?;
+    m.add_function(wrap_pyfunction!(theme_mode, m)?)?;
     m.add_function(wrap_pyfunction!(foreground_color, m)?)?;
     m.add_function(wrap_pyfunction!(background_color, m)?)?;
     m.add_function(wrap_pyfunction!(color_palette, m)?)?;
     m.add("ColorsaurusError", py.get_type::<ColorsaurusError>())?;
-    m.add("ColorScheme", py.get_type::<ColorScheme>())?;
+    m.add("ColorScheme", py.get_type::<ThemeMode>())?;
     m.add("ColorPalette", py.get_type::<ColorPalette>())?;
     m.add("Color", py.get_type::<Color>())?;
     Ok(())
@@ -34,9 +30,9 @@ create_exception!(colorsaurus, ColorsaurusError, PyException);
 /// Detects if the terminal is dark or light.
 #[pyfunction]
 #[pyo3(signature = (*, timeout=None))]
-fn color_scheme(timeout: Option<Timeout>) -> PyResult<ColorScheme> {
-    imp::color_scheme(query_options(timeout))
-        .map(ColorScheme::from)
+fn theme_mode(timeout: Option<Timeout>) -> PyResult<ThemeMode> {
+    imp::theme_mode(query_options(timeout))
+        .map(ThemeMode::from)
         .map_err(to_py_error)
 }
 
@@ -92,7 +88,7 @@ impl<'py> FromPyObject<'py> for Timeout {
     }
 }
 
-/// The color scheme of the terminal.
+/// The terminal's theme mode (i.e. dark or light).
 /// This can be retrieved by calling the color_scheme function.
 #[pyclass(
     eq,
@@ -103,18 +99,18 @@ impl<'py> FromPyObject<'py> for Timeout {
     rename_all = "SCREAMING_SNAKE_CASE"
 )]
 #[derive(PartialEq, Eq, Hash)]
-enum ColorScheme {
+enum ThemeMode {
     /// The terminal uses a dark background with light text.
     Dark,
     /// The terminal uses a light background with dark text.
     Light,
 }
 
-impl From<imp::ColorScheme> for ColorScheme {
-    fn from(value: imp::ColorScheme) -> Self {
+impl From<imp::ThemeMode> for ThemeMode {
+    fn from(value: imp::ThemeMode) -> Self {
         match value {
-            imp::ColorScheme::Dark => Self::Dark,
-            imp::ColorScheme::Light => Self::Light,
+            imp::ThemeMode::Dark => Self::Dark,
+            imp::ThemeMode::Light => Self::Light,
         }
     }
 }
@@ -138,8 +134,8 @@ impl ColorPalette {
     }
 
     #[getter]
-    fn color_scheme(&self) -> ColorScheme {
-        self.0.color_scheme().into()
+    fn theme_mode(&self) -> ThemeMode {
+        self.0.theme_mode().into()
     }
 
     #[pyo3(name = "__repr__")]
@@ -168,11 +164,11 @@ impl Color {
 
     #[new]
     fn new(red: u8, green: u8, blue: u8) -> Self {
-        Self(imp::Color {
-            r: scale_to_u16(red),
-            g: scale_to_u16(green),
-            b: scale_to_u16(blue),
-        })
+        Self(imp::Color::rgb(
+            scale_to_u16(red),
+            scale_to_u16(green),
+            scale_to_u16(blue),
+        ))
     }
 
     #[getter]
@@ -190,10 +186,7 @@ impl Color {
         self.0.scale_to_8bit().2
     }
 
-    /// The perceived lightness of the color
-    /// as a value between 0 (black) and 100 (white)
-    /// where 50 is the perceptual "middle grey".
-    fn perceived_lightness(&self) -> u8 {
+    fn perceived_lightness(&self) -> f32 {
         self.0.perceived_lightness()
     }
 

crates/pycolorsaurus/src/lib.rs

@@ -8,7 +8,7 @@ keywords = ["terminal", "light", "dark", "color-scheme", "cli"]
 license = "MIT OR Apache-2.0"
 version.workspace = true
 edition = "2021"
-rust-version = "1.70.0" # Search for `FIXME(msrv)` when bumping.
+rust-version = "1.74.0" # Search for `FIXME(msrv)` when bumping.
 exclude = [".github", ".gitignore", "*.sh", "benchmark/**/*", "doc/issues.md", "deny.toml"]
 
 [dependencies]