Merge pull request #29 from Aloso/dev

Update docs, support percent value input
Aloso · Nov 4, 2020 · bbdee76 · bbdee76
2 parents 6023301 + 1ead35f
commit bbdee76
Show file tree

Hide file tree

Showing 13 changed files with 29 additions and 171 deletions.
diff --git a/Color spaces.md b/Color spaces.md
diff --git a/README.md b/README.md
@@ -61,19 +61,21 @@ If `colo` is used outside of a terminal, it outputs the color as text. The forma
 
 ### Supported color spaces
 
-| Name        | Description                        | Range of values |
-|-------------|------------------------------------|-----------------|
-| `rgb`       | red, green, blue                   | 0 to 255        |
-| `cmy`       | cyan, magenta, yellow              | 0 to 1          |
-| `cmyk`      | cyan, magenta, yellow, key         | 0 to 1          |
-| `hsv`       | hue, saturation, value             | hue: 0 to 360, saturation: 0 to 1, value: 0 to 1     |
-| `hsl`       | hue, saturation, light             | hue: 0 to 360, saturation: 0 to 1, light: 0 to 1     |
-| `lch`       | luminance, chroma, hue             | luminance: 0 to 100, chroma: 0 to 100, hue: 0 to 360 |
-| `luv`       | CIELUV color (luminance, u, v)     | luminance: 0 to 100, u: -134 to 220, v: -140 to 122  |
-| `lab`       | CIELAB color (lightness, a, b)     | lightness: 0 to 100, a: ??, b: ??                    |
-| `hunterlab` | Hunter Lab color (lightness, a, b) | lightness: 0 to 100, a: ??, b: ??                    |
-| `xyz`       | CIE 1931 XYZ color                 | ??              |
-| `yxy`       | CIE YXY color                      | ??              |
+Read in more detail about these color spaces [here](https://aloso.github.io/colo/color_spaces#srgb-rgb).
+
+| Name        | Description                     | Range of values     |
+|-------------|---------------------------------|---------------------|
+| `rgb`       | red, green, blue                | 0 to 255            |
+| `cmy`       | cyan, magenta, yellow           | 0 to 1              |
+| `cmyk`      | cyan, magenta, yellow, key      | 0 to 1              |
+| `hsl`       | hue, saturation, light          | hue: 0 to 360, saturation: 0 to 1, light: 0 to 1     |
+| `hsv`       | hue, saturation, value          | hue: 0 to 360, saturation: 0 to 1, value: 0 to 1     |
+| `lab`       | CIELAB (lightness, a, b)        | lightness: 0 to 100 |
+| `lch`       | CIELCh (luminance, chroma, hue) | luminance: 0 to 100, chroma: 0 to 100, hue: 0 to 360 |
+| `luv`       | CIELUV (luminance, u, v)        | luminance: 0 to 100, u: -134 to 220, v: -140 to 122  |
+| `hunterlab` | Hunter Lab (lightness, a, b)    | lightness: 0 to 100 |
+| `xyz`       | CIE XYZ (x, lightness, z)       | lightness: 0 to 100 |
+| `yxy`       | CIE Yxy (lightness, x, y)       | lightness: 0 to 100 |
 
 ### Specifying hexadecimal colors
 
@@ -129,8 +131,6 @@ Also, to pass continuous integration, the code must
   * compile on the latest stable Rust version
   * all tests must succeed
 
-Note: I'm currently refactoring the code base, so this is a bad time for large pull requests. I should be finished with this in a week at the latest.
-
 You can also look in the issue tracker for issues with the label [help wanted](https://github.com/Aloso/colo/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
 
 That's it! If you have any questions, feel free to create an issue.
diff --git a/docs/colors/black.png b/docs/colors/black.png
diff --git a/docs/colors/blue.png b/docs/colors/blue.png
diff --git a/docs/colors/cyan.png b/docs/colors/cyan.png
diff --git a/docs/colors/green.png b/docs/colors/green.png
diff --git a/docs/colors/magenta.png b/docs/colors/magenta.png
diff --git a/docs/colors/red.png b/docs/colors/red.png
diff --git a/docs/colors/white.png b/docs/colors/white.png
diff --git a/docs/colors/yellow.png b/docs/colors/yellow.png
diff --git a/src/cli/mod.rs b/src/cli/mod.rs
@@ -39,43 +39,14 @@ const COLOR_FORMATS: &[&str] = &[
     "hex",
 ];
 
-macro_rules! color_help_message {
-    () => {
-        "\
+const COLOR_HELP_MESSAGE: &str = "\
 The input colors. Multiple colors can be specified. Supported formats:
 
-* HTML color name (e.g. 'rebeccapurple')
-* Hexadecimal RGB color (e.g. '07F', '0077FF')
-* Color components (e.g. '127, 0, 255', 'hsl(30, 1, .5)').
-  If no color space is specified, it defaults to 'rgb'.
-  Commas and parentheses are optional."
-    };
-}
-
-macro_rules! color_space_help {
-    () => {
-        "\
-Supported color spaces
-======================
-name      arguments                   values
--------------------------------------------------------------------
-rgb       red, green, blue            0-255    0-255    0-255
-cmy       cyan, magenta, yellow       0-1      0-1      0-1
-cmyk      cyan, magenta, yellow, key  0-1      0-1      0-1     0-1
-hsv       hue, saturation, value      0-360    0-1      0-1
-hsl       hue, saturation, light      0-360    0-1      0-1
-lch       luminance, chroma, hue      0-100    0-100    0-360
-luv       luminance, u, v (CIELUV)    0-100 –134-220 –140-122
-lab       lightness, a, b (CIELAB)    0-100     ?        ?
-hunterlab lightness, a, b (CIELAB)    0-100     ?        ?
-xyz       x,y,z (CIE 1931 XYZ color)   ?        ?        ?
-yxy       y1,x,y2 (CIE YXY color)      ?        ?        ?"
-    };
-}
-
-const COLOR_HELP_LONG_MESSAGE: &str = concat!(color_help_message!(), "\n\n", color_space_help!());
-
-const COLOR_HELP_MESSAGE: &str = color_help_message!();
+* HTML color name, e.g. 'rebeccapurple'
+* Hexadecimal RGB color, e.g. '07F', '0077FF'
+* Color components, e.g. 'hsl(30, 100%, 50%)'
+  Commas and parentheses are optional.
+  For supported color spaces, see <https://aloso.github.io/colo/color_spaces>";
 
 /// Returns the command line arguments parsed by clap.
 ///

diff --git a/src/cli/show.rs b/src/cli/show.rs
@@ -16,7 +16,6 @@ pub fn command<'a, 'b>() -> App<'a, 'b> {
                 .takes_value(true)
                 .required(false)
                 .help(super::COLOR_HELP_MESSAGE)
-                .long_help(super::COLOR_HELP_LONG_MESSAGE)
                 .multiple(true)
                 .use_delimiter(false),
             Arg::with_name("OUTPUT_FORMAT")

diff --git a/src/color/parse.rs b/src/color/parse.rs
@@ -78,8 +78,14 @@ pub fn parse(mut input: &str) -> Result<Vec<(Color, ColorFormat)>, ParseError> {
                 let (n, input_ii) = parse_number(input_i)?.ok_or_else(|| MissingFloat {
                     got: input_i.into(),
                 })?;
-                *num = n;
-                input_i = input_ii;
+                input_i = input_ii.trim_start();
+
+                if input_i.starts_with('%') {
+                    input_i = &input_i[1..];
+                    *num = n / 100.0;
+                } else {
+                    *num = n;
+                }
             }
 
             let nums = &nums[0..expected];