Skip to content

235 truecolor define color #252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Oct 20, 2020
Merged

235 truecolor define color #252

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
56dd1c1
#235 true color using define_colors macro from define_language
atluft Oct 8, 2020
bee2bf7
#235 true colors using color define macro
atluft Oct 9, 2020
074e238
#235 define colors from define languages invocation
atluft Oct 16, 2020
c0735e1
#235 improving colorterm test by separating into a function
atluft Oct 16, 2020
410b849
#235 fix
atluft Oct 16, 2020
fca7e74
#235 adds tests for equal array size and basic colors
atluft Oct 17, 2020
e667b23
#235 moves use into test module for build
atluft Oct 17, 2020
e8fdd42
move is_true_color_terminal() in cli.rs
o2sh Oct 17, 2020
36a9e9c
#235 accepted all review suggestions
atluft Oct 18, 2020
1d73e42
Update src/onefetch/language.rs
atluft Oct 19, 2020
c465eeb
Merge branch 'master' into 235-truecolor-define-color
atluft Oct 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ Adding support for a new Language requires adding a new entry in the `define_lan

**Example**:

`{ CSharp, "csharp.ascii", "C#", vec![Color::Blue, Color::Magenta], "c#" }`
` { CSharp, "csharp.ascii", "C#", define_colors!( [Color::Blue, Color::Magenta] ), "c#" }, `

The first item `CSharp` corresponds to the name of the language as defined in tokei. The second item `csharp.ascii` is the name of the file containing the ascii logo, this file has to be placed in the _./resources_ folder (more info below). The third item `C#` is the display name. Then we have the colors `vec![Color::Blue, Color::Magenta]` used to customize the look of the ascii logo when displayed to the screen. The last item `c#` is required only if the Enum name `CSharp` doesn't match the display name `C#`.
The first item `CSharp` corresponds to the name of the language as defined in tokei. The second item `csharp.ascii` is the name of the file containing the ascii logo, this file has to be placed in the _./resources_ folder (more info below). The third item `C#` is the display name. Then we have the colors used to customize the look of the ascii logo when displayed to the screen. The last item `c#` is required only if the Enum name `CSharp` doesn't match the display name `C#`.

#### Ascii logo

Expand Down Expand Up @@ -90,6 +90,16 @@ Remarks:
- You can use `{N}` to color the ascii which will utilize the vec! of colors defined in `define_language!`
- Make sure to trim any unnecessary trailing whitespaces
- See example here [Ascii Art From Image File Using Python Image Library](https://github.com/o2sh/onefetch/wiki/ASCII-Art-From-Image-Using-Python-Image-Library)
- You must always provide an array of basic colors
- Optionally, you may provide true colors in a second array of colors separated from the first array by a colon
- One last approach allows you to define colors using the Colors structure itself
- Make sure if you use true colors that the number of true colors matches the number of basic colors
- For example, the following are equivalent:
```
{ CSharp, "csharp.ascii", "C#", define_colors!( [Color::Blue, Color::Magenta] ), "c#" },
{ CSharp, "csharp.ascii", "C#", define_colors!( [Color::Blue, Color::Magenta] : [Color::TrueColor{ r:0, g:255, b:255 }, Color::TrueColor{ r:255, g:0, b:255 } ] ), "c#" },
{ CSharp, "csharp.ascii", "C#", define_colors!( Colors { basic_colors: vec![Color::Blue, Color::Magenta] , true_colors: Some(vec![Color::TrueColor{ r:0, g:255, b:255 }, Color::TrueColor{ r:255, g:0, b:255 } ] ) } ), "c#" },
```

### Project-specific notes

Expand Down
44 changes: 22 additions & 22 deletions resources/swift.ascii
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
{0} :
{0} ::
{0} :::
{0} : ::::
{0} : : ::::
{0} : :: :::::
{0} :: ::: :::::
{0} ::: ::: ::::::
{0} ::: ::: :::::::
{0} :::: :::: :::::::
{0} ::::::::::: ::::::::
{0} ::::::::::: :::::::::
{0} ::::::::::::::::::::::
{0} :::::::::::::::::::::
{0} :::::::::::::::::::
{0}: :::::::::::::::::
{0} :: ::::::::::::::
{0} :::: ::::::::::::::::
{0} ::::::::::::::::::::::::::::::::::
{0} :::::::::::::::::::::::::::::::::
{0} :::::::::::::::::::::::::::::::
{0} :::::::::::::::::::::: :::::
{0} .::::::::::::::. ::
{0}
{1} :::
{1} : ::::
{2} : : ::::
{2} : :: :::::
{3} :: ::: :::::
{3} ::: ::: ::::::
{4} ::: ::: :::::::
{4} :::: :::: :::::::
{5} ::::::::::: ::::::::
{5} ::::::::::: :::::::::
{5} ::::::::::::::::::::::
{6} :::::::::::::::::::::
{6} :::::::::::::::::::
{6}: :::::::::::::::::
{7} :: ::::::::::::::
{7} :::: ::::::::::::::::
{7} ::::::::::::::::::::::::::::::::::
{8} :::::::::::::::::::::::::::::::::
{8} :::::::::::::::::::::::::::::::
{8} :::::::::::::::::::::: :::::
{9} .::::::::::::::. ::
{9}
9 changes: 9 additions & 0 deletions src/onefetch/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ pub struct Cli {
pub number_of_authors: usize,
pub excluded: Vec<String>,
pub print_languages: bool,
pub true_color: bool,
}

impl Cli {
Expand Down Expand Up @@ -149,6 +150,7 @@ impl Cli {
let no_merges = matches.is_present("no-merge-commits");
let no_color_blocks = matches.is_present("no-color-blocks");
let print_languages = matches.is_present("languages");
let true_color = is_truecolor_terminal();

let fields_to_hide: Vec<String> = if let Some(values) = matches.values_of("disable-fields")
{
Expand Down Expand Up @@ -213,6 +215,7 @@ impl Cli {
number_of_authors,
excluded,
print_languages,
true_color,
})
}

Expand All @@ -226,3 +229,9 @@ impl Cli {
Ok(())
}
}

fn is_truecolor_terminal() -> bool {
env::var("COLORTERM")
.map(|colorterm| colorterm == "truecolor" || colorterm == "24bit")
.unwrap_or(false)
}
2 changes: 1 addition & 1 deletion src/onefetch/info.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -738,7 +738,7 @@ impl Info {
&self.config.ascii_language
};

let colors = language.get_colors();
let colors = language.get_colors(self.config.true_color);

let colors: Vec<Color> = colors
.iter()
Expand Down
218 changes: 156 additions & 62 deletions src/onefetch/language.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,21 @@ use {
colored::Color,
regex::Regex,
std::collections::HashMap,
std::env,
strum::{EnumIter, EnumString, IntoStaticStr},
};

pub struct Colors {
basic_colors: Vec<Color>,
true_colors: Option<Vec<Color>>,
}

macro_rules! define_colors {
( [ $($color:expr),+ ] ) => { Colors { basic_colors: vec![$($color),+], true_colors: None } };
( [ $($bc:expr),+ ] : [ $($tc:expr),+ ] ) => { Colors { basic_colors: vec![$($bc),+], true_colors: Some(vec![$($tc),+]) } };
( $color:expr ) => { $color };
}

macro_rules! define_languages {
($( { $name:ident, $ascii:literal, $display:literal, $colors:expr $(, $serialize:literal )? } ),* ,) => {

Expand Down Expand Up @@ -45,12 +57,14 @@ macro_rules! define_languages {
}
}

pub fn get_colors(&self) -> Vec<Color> {
match *self {
$(
Language::$name => $colors,
)*
Language::Unknown => vec![Color::White],
pub fn get_colors(&self, true_color: bool) -> Vec<Color> {
let colors = match *self {
$( Language::$name => $colors, )*
Language::Unknown => define_colors!( [Color::White] ),
};
match colors.true_colors {
Some( true_colors ) if true_color => true_colors,
_ => colors.basic_colors,
}
}
}
Expand All @@ -59,6 +73,62 @@ macro_rules! define_languages {
vec![ $( tokei::LanguageType::$name ,)* ]
}

#[cfg(test)]
mod true_colors {

use std::fmt;
use super::*;
use paste::paste;

impl fmt::Display for Colors {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let mut output = String::new();
output += "Colors {\n";
output += " basic_colors: vec![\n";
for (color_index, bc) in self.basic_colors.iter().enumerate() {
output += &format!( " Color::{:?}, // {}\n", bc, color_index );
}
output += " ], \n";
if let Some(tcs) = &self.true_colors {
output += " true_colors: vec![\n";
for (color_index,tc) in tcs.iter().enumerate() {
output += &format!( " Color::{:?}, // {}\n", tc, color_index );
}
} else {
output += " true_colors: None\n";
};
output += " ], \n";
output += "}\n";
write!( f, "{}", output )
}
}

$(
paste! {
#[test]
#[ignore]
fn [<$name:lower _basic_color_test>] () {
let colors = $colors;
for (color_index, bc) in colors.basic_colors.iter().enumerate() {
let color_str = &format!( "Color::{:?}", bc );
if let Color::TrueColor { .. } = bc {
panic!( "TrueColor found in basic_colors for {} at index {} found {}", stringify!( $name ), color_index, color_str );
}
}
}

#[test]
fn [<$name:lower _color_vector_length_test>] () {
let colors = $colors;
let bc_count = colors.basic_colors.len();
if let Some(tcs) = &colors.true_colors {
assert_eq!( bc_count, tcs.len(), " left (basic) color length do not match right (true) color length.\n{}", colors );
}
}
}
)*
}

#[cfg(test)]
mod ascii_size {
use lazy_static::lazy_static;
Expand Down Expand Up @@ -101,62 +171,86 @@ macro_rules! define_languages {
}

define_languages! {
{ Assembly, "assembly.ascii", "Assembly", vec![Color::Cyan] },
{ C, "c.ascii", "C", vec![Color::Cyan, Color::Blue] },
{ Clojure, "clojure.ascii", "Clojure", vec![Color::Cyan, Color::Green] },
{ CMake, "cmake.ascii", "CMake", vec![Color::Blue, Color::Green, Color::Red, Color::Black] },
{ CoffeeScript, "coffeescript.ascii", "CoffeeScript", vec![Color::Red] },
{ Cpp, "cpp.ascii", "C++", vec![Color::Cyan, Color::Blue], "c++" },
{ Crystal, "crystal.ascii", "Crystal", vec![Color::White, Color::Black] },
{ CSharp, "csharp.ascii", "C#", vec![Color::Blue, Color::Magenta], "c#" },
{ Css, "css.ascii", "CSS", vec![Color::Blue, Color::White] },
{ D, "d.ascii", "D", vec![Color::Red] },
{ Dart, "dart.ascii", "Dart", vec![Color::Cyan, Color::Blue] },
{ Dockerfile, "dockerfile.ascii", "Dockerfile", vec![Color::Cyan, Color::White, Color::Cyan] },
{ Elisp, "emacslisp.ascii", "EmacsLisp", vec![Color::Magenta, Color::White], "emacslisp" },
{ Elixir, "elixir.ascii", "Elixir", vec![Color::Magenta] },
{ Elm, "elm.ascii", "Elm", vec![Color::Blue, Color::Green, Color::Yellow, Color::Cyan] },
{ Erlang, "erlang.ascii", "Erlang", vec![Color::Red] },
{ Fish, "fish.ascii", "Fish", vec![Color::Red, Color::Yellow] },
{ Forth, "forth.ascii", "Forth", vec![Color::Red] },
{ FortranModern, "f90.ascii", "Fortran", vec![Color::White, Color::Green, Color::Cyan, Color::Yellow, Color::Red], "fortran" },
{ FSharp, "fsharp.ascii", "F#", vec![Color::Cyan, Color::Cyan], "f#" },
{ Go, "go.ascii", "Go", vec![Color::White] },
{ Groovy, "groovy.ascii", "Groovy", vec![Color::Cyan, Color::White] },
{ Haskell, "haskell.ascii", "Haskell", vec![Color::Cyan, Color::Magenta, Color::Blue] },
{ Html, "html.ascii", "HTML", vec![Color::Red, Color::White] },
{ Idris, "idris.ascii", "Idris", vec![Color::Red] },
{ Java, "java.ascii", "Java", vec![Color::Cyan, Color::Red] },
{ JavaScript, "javascript.ascii", "JavaScript", vec![Color::Yellow] },
{ Julia, "julia.ascii", "Julia", vec![Color::White, Color::Blue, Color::Green, Color::Red, Color::Magenta] },
{ Jupyter, "jupyter.ascii", "Jupyter-Notebooks", vec![Color::White, Color::Yellow, Color::White], "jupyter-notebooks" },
{ Kotlin, "kotlin.ascii", "Kotlin", vec![Color::Blue, Color::Yellow, Color::Magenta] },
{ Lisp, "lisp.ascii", "Lisp", vec![Color::White] },
{ Lua, "lua.ascii", "Lua", vec![Color::Blue, Color::White] },
{ Markdown, "markdown.ascii", "Markdown", vec![Color::White, Color::Red] },
{ Nim, "nim.ascii", "Nim", vec![Color::Yellow, Color::White] },
{ Nix, "nix.ascii", "Nix", vec![Color::Cyan, Color::Blue] },
{ ObjectiveC, "objectivec.ascii", "Objective-C", vec![Color::Cyan, Color::Blue], "objective-c" },
{ OCaml, "ocaml.ascii", "OCaml", vec![Color::Yellow] },
{ Org, "org.ascii", "Org", vec![Color::Green, Color::Red, Color::White] },
{ Perl, "perl.ascii", "Perl", vec![Color::Cyan] },
{ Php, "php.ascii", "Php", vec![Color::Magenta, Color::Blue, Color::Cyan, Color::White] },
{ Prolog, "prolog.ascii", "Prolog", vec![Color::White] },
{ PureScript, "purescript.ascii", "PureScript", vec![Color::White] },
{ Python, "python.ascii", "Python", vec![Color::Blue, Color::Yellow] },
{ R, "r.ascii", "R", vec![Color::White, Color::Blue] },
{ Racket, "racket.ascii", "Racket", vec![Color::Red, Color::White, Color::Blue] },
{ Ruby, "ruby.ascii", "Ruby", vec![Color::Magenta] },
{ Rust, "rust.ascii", "Rust", vec![Color::Red, Color::White] },
{ Scala, "scala.ascii", "Scala", vec![Color::Blue] },
{ Sh, "shell.ascii", "Shell", vec![Color::Green], "shell" },
{ Swift, "swift.ascii", "Swift", vec![Color::Red] },
{ Tcl, "tcl.ascii", "Tcl", vec![Color::Blue, Color::White, Color::Cyan] },
{ Tex, "tex.ascii", "Tex", vec![Color::White, Color::Black] },
{ TypeScript, "typescript.ascii", "TypeScript", vec![Color::Cyan] },
{ Vue, "vue.ascii", "Vue", vec![Color::Green, Color::Blue] },
{ Xml, "xml.ascii", "XML", vec![Color::Yellow, Color::White, Color::Green] },
{ Zig, "zig.ascii", "Zig", vec![Color::Yellow] },
{ Assembly, "assembly.ascii", "Assembly", define_colors!( [Color::Cyan] ) },
{ C, "c.ascii", "C", define_colors!( [Color::Cyan, Color::Blue] ) },
{ Clojure, "clojure.ascii", "Clojure", define_colors!( [Color::Cyan, Color::Green] ) },
{ CMake, "cmake.ascii", "CMake", define_colors!( [Color::Blue, Color::Green, Color::Red, Color::Black] ) },
{ CoffeeScript, "coffeescript.ascii", "CoffeeScript", define_colors!( [Color::Red] ) },
{ Cpp, "cpp.ascii", "C++", define_colors!( [Color::Cyan, Color::Blue] ), "c++" },
{ Crystal, "crystal.ascii", "Crystal", define_colors!( [Color::White, Color::Black] ) },
{ CSharp, "csharp.ascii", "C#", define_colors!( [Color::Blue, Color::Magenta] ), "c#" },
{ Css, "css.ascii", "CSS", define_colors!( [Color::Blue, Color::White] ) },
{ D, "d.ascii", "D", define_colors!( [Color::Red] ) },
{ Dart, "dart.ascii", "Dart", define_colors!( [Color::Cyan, Color::Blue] ) },
{ Dockerfile, "dockerfile.ascii", "Dockerfile", define_colors!( [Color::Cyan, Color::White, Color::Cyan] ) },
{ Elisp, "emacslisp.ascii", "EmacsLisp", define_colors!( [Color::Magenta, Color::White] ), "emacslisp" },
{ Elixir, "elixir.ascii", "Elixir", define_colors!( [Color::Magenta] ) },
{ Elm, "elm.ascii", "Elm", define_colors!( [Color::Blue, Color::Green, Color::Yellow, Color::Cyan] ) },
{ Erlang, "erlang.ascii", "Erlang", define_colors!( [Color::Red] ) },
{ Fish, "fish.ascii", "Fish", define_colors!( [Color::Red, Color::Yellow] ) },
{ Forth, "forth.ascii", "Forth", define_colors!( [Color::Red] ) },
{ FortranModern, "f90.ascii", "Fortran", define_colors!( [Color::White, Color::Green, Color::Cyan, Color::Yellow, Color::Red] ), "fortran" },
{ FSharp, "fsharp.ascii", "F#", define_colors!( [Color::Cyan, Color::Cyan] ), "f#" },
{ Go, "go.ascii", "Go", define_colors!( [Color::White] ) },
{ Groovy, "groovy.ascii", "Groovy", define_colors!( [Color::Cyan, Color::White] ) },
{ Haskell, "haskell.ascii", "Haskell", define_colors!( [Color::Cyan, Color::Magenta, Color::Blue] ) },
{ Html, "html.ascii", "HTML", define_colors!( [Color::Red, Color::White] ) },
{ Idris, "idris.ascii", "Idris", define_colors!( [Color::Red] ) },
{ Java, "java.ascii", "Java", define_colors!( [Color::Cyan, Color::Red] ) },
{ JavaScript, "javascript.ascii", "JavaScript", define_colors!( [Color::Yellow] ) },
{ Julia, "julia.ascii", "Julia", define_colors!( [Color::White, Color::Blue, Color::Green, Color::Red, Color::Magenta] ) },
{ Jupyter, "jupyter.ascii", "Jupyter-Notebooks", define_colors!( [Color::White, Color::Yellow, Color::White] ), "jupyter-notebooks" },
{ Kotlin, "kotlin.ascii", "Kotlin", define_colors!( [Color::Blue, Color::Yellow, Color::Magenta] ) },
{ Lisp, "lisp.ascii", "Lisp", define_colors!( [Color::White] ) },
{ Lua, "lua.ascii", "Lua", define_colors!( [Color::Blue, Color::White] ) },
{ Markdown, "markdown.ascii", "Markdown", define_colors!( [Color::White, Color::Red] ) },
{ Nim, "nim.ascii", "Nim", define_colors!( [Color::Yellow, Color::White] ) },
{ Nix, "nix.ascii", "Nix", define_colors!( [Color::Cyan, Color::Blue] ) },
{ ObjectiveC, "objectivec.ascii", "Objective-C", define_colors!( [Color::Cyan, Color::Blue] ), "objective-c" },
{ OCaml, "ocaml.ascii", "OCaml", define_colors!( [Color::Yellow] ) },
{ Org, "org.ascii", "Org", define_colors!( [Color::Green, Color::Red, Color::White] ) },
{ Perl, "perl.ascii", "Perl", define_colors!( [Color::Cyan] ) },
{ Php, "php.ascii", "Php", define_colors!( [Color::Magenta, Color::Blue, Color::Cyan, Color::White] ) },
{ Prolog, "prolog.ascii", "Prolog", define_colors!( [Color::White] ) },
{ PureScript, "purescript.ascii", "PureScript", define_colors!( [Color::White] ) },
{ Python, "python.ascii", "Python", define_colors!( [Color::Blue, Color::Yellow] ) },
{ R, "r.ascii", "R", define_colors!( [Color::White, Color::Blue] ) },
{ Racket, "racket.ascii", "Racket", define_colors!( [Color::Red, Color::White, Color::Blue] ) },
{ Ruby, "ruby.ascii", "Ruby", define_colors!( [Color::Magenta] ) },
{ Rust, "rust.ascii", "Rust", define_colors!( [Color::Red, Color::White] ) },
{ Scala, "scala.ascii", "Scala", define_colors!( [Color::Blue] ) },
{ Sh, "shell.ascii", "Shell", define_colors!( [Color::Green] ), "shell" },
{
Swift, "swift.ascii", "Swift", define_colors!( [
Color::Red,
Color::Red,
Color::Red,
Color::Red,
Color::Red,
Color::Red,
Color::Red,
Color::Red,
Color::Red,
Color::Red
] : [
Color::TrueColor{ r:248, g:129, b:052 },
Color::TrueColor{ r:249, g:119, b:050 },
Color::TrueColor{ r:249, g:109, b:048 },
Color::TrueColor{ r:250, g:099, b:046 },
Color::TrueColor{ r:250, g:089, b:044 },
Color::TrueColor{ r:251, g:080, b:042 },
Color::TrueColor{ r:251, g:070, b:040 },
Color::TrueColor{ r:252, g:060, b:038 },
Color::TrueColor{ r:252, g:050, b:036 },
Color::TrueColor{ r:253, g:040, b:034 }
] )
},
{ Tcl, "tcl.ascii", "Tcl", define_colors!( [Color::Blue, Color::White, Color::Cyan] ) },
{ Tex, "tex.ascii", "Tex", define_colors!( [Color::White, Color::Black] ) },
{ TypeScript, "typescript.ascii", "TypeScript", define_colors!( [Color::Cyan] ) },
{ Vue, "vue.ascii", "Vue", define_colors!( [Color::Green, Color::Blue] ) },
{ Xml, "xml.ascii", "XML", define_colors!( [Color::Yellow, Color::White, Color::Green] ) },
{ Zig, "zig.ascii", "Zig", define_colors!( [Color::Yellow] ) },
}

impl Language {
Expand Down