Skip to content
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

Cows. Cows everywhere. #135

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Cows. Cows everywhere. #135

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ea43692
feature: Make usable without atty.
shanecelis Jun 8, 2023
b9c0b1e
refactor: Clean up conditional atty code.
shanecelis Jun 8, 2023
efd631d
feature: Use a static cow.
shanecelis Jun 8, 2023
2f2ddbc
feature: Cows. Cows everywhere!
shanecelis Jun 8, 2023
5efbafb
feature: Print the dynamic_colors.rs.
shanecelis Jun 8, 2023
60dfa95
bug: Handle conditional compile correctly.
shanecelis Jun 9, 2023
1ab549c
feature: Add Deref impl for ColoredStrings.
shanecelis Jun 24, 2023
44d12f8
doc: Add doc strings.
shanecelis Jun 25, 2023
0042683
refactor: Take advice from PR feedback.
shanecelis Jun 26, 2023
b368b88
revert: feature: Add Deref impl for ColoredStrings
shanecelis Jun 26, 2023
3fd220b
refactor: Changed "no-color" feature to "color"...
shanecelis Jun 26, 2023
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
4 changes: 3 additions & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ readme = "README.md"
keywords = ["color", "string", "term", "ansi_term", "term-painter"]

[features]
default = ["tty"]
tty = ["dep:atty"]
# with this feature, no color will ever be written
no-color = []

[dependencies]
atty = "0.2"
atty = { version = "0.2", optional = true }
lazy_static = "1"

[target.'cfg(windows)'.dependencies.winapi]
Expand Down
6 changes: 3 additions & 3 deletions examples/dynamic_colors.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ use colored::*;

fn main() {
// the easy way
"blue string yo".color("blue");
println!("{}", "blue string yo".color("blue"));

// this will default to white
"white string".color("zorglub");
println!("{}", "white string".color("zorglub"));

// the safer way via a Result
let color_res = "zorglub".parse(); // <- this returns a Result<Color, ()>
"red string".color(color_res.unwrap_or(Color::Red));
println!("{}", "red string".color(color_res.unwrap_or(Color::Red)));
}
11 changes: 9 additions & 2 deletions src/control.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,16 @@ impl ShouldColorize {
/// `CLICOLOR_FORCE` takes highest priority, followed by `NO_COLOR`,
/// followed by `CLICOLOR` combined with tty check.
pub fn from_env() -> Self {
#[allow(unused_mut)]
#[allow(unused_assignments)]
let mut tty = false;
#[cfg(feature = "tty")]
{
tty = atty::is(atty::Stream::Stdout);
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#[allow(unused_mut)]
#[allow(unused_assignments)]
let mut tty = false;
#[cfg(feature = "tty")]
{
tty = atty::is(atty::Stream::Stdout);
}
let tty = if cfg!(feature = "tty") {
atty::is(atty::Stream::Stdout)
} else {
false
};

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. I like this better than mine but it doesn't compile. This compiles:

        let tty = if cfg!(feature = "tty") {
            #[cfg(feature = "tty")]
            {
            atty::is(atty::Stream::Stdout)
            }
            #[cfg(not(feature = "tty"))]
            false
        } else {
            false
        };

But we can clean it up further to this:

        let tty = {
            #[cfg(feature = "tty")]
            {
                atty::is(atty::Stream::Stdout)
            }
            #[cfg(not(feature = "tty"))]
            false
        };

And sorry there are some commits that I didn't mean to put into this PR.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could also use

use std::io::{self, IsTerminal};
let tty = io::stdout().is_terminal();

that was very recently introduced in the Rust 1.70.0 std library.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could use that and drop the atty dependency.

ShouldColorize {
clicolor: ShouldColorize::normalize_env(env::var("CLICOLOR")).unwrap_or_else(|| true)
&& atty::is(atty::Stream::Stdout),
clicolor: ShouldColorize::normalize_env(env::var("CLICOLOR")).unwrap_or(true)
&& tty,
clicolor_force: ShouldColorize::resolve_clicolor_force(
env::var("NO_COLOR"),
env::var("CLICOLOR_FORCE"),
Expand Down
Loading