(v2) adaptive colors + writers #397
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This introduces a helper type `LightDark` that takes a boolean to determine which `Color(light, dark)` to choose from. The `adaptive` package is a helper package that uses the `lipgloss.LightDark` along with querying the terminal when the module is imported to choose the appropriate light-dark color. Example: ```go var ( light = "#0000ff" dark = "#ff0000" ) colorToUse := adaptive.Color(light, dark) // the terminal is queried before choosing the color fmt.Println(colorToUse) ```
Co-authored-by: Ayman Bagabas <[email protected]>
Co-authored-by: Ayman Bagabas <[email protected]>
Co-authored with @aymanbagabas
5 tasks
meowgorithm
force-pushed
the
v2-adaptive-standalone
branch
from
762e3ca to
6fa7bb6
Compare
1 task
Comment on lines
+56
to
+96
| // Fprint pritnts to the given writer, automatically downsampling colors when | ||
| // necessary. | ||
| // | ||
| // Example: | ||
| // | ||
| // str := NewStyle(). | ||
| // Foreground(lipgloss.Color("#6a00ff")). | ||
| // Render("guzzle") | ||
| // | ||
| // Fprint(os.Stderr, "I %s horchata pretty much all the time.\n", str) | ||
| func Fprint(w io.Writer, v ...interface{}) (int, error) { | ||
| return fmt.Fprint(colorprofile.NewWriter(w, os.Environ()), v...) //nolint:wrapcheck | ||
| } | ||
|
|
||
| // Fprint pritnts to the given writer, automatically downsampling colors when | ||
| // necessary, and ending with a trailing newline. | ||
| // | ||
| // Example: | ||
| // | ||
| // str := NewStyle(). | ||
| // Foreground(lipgloss.Color("#6a00ff")). | ||
| // Render("Sandwich time!") | ||
| // | ||
| // Fprintln(os.Stderr, str) | ||
| func Fprintln(w io.Writer, v ...interface{}) (int, error) { | ||
| return fmt.Fprintln(colorprofile.NewWriter(w, os.Environ()), v...) //nolint:wrapcheck | ||
| } | ||
|
|
||
| // Fprintf prints text to a writer, against the given format, automatically | ||
| // downsampling colors when necessary. | ||
| // | ||
| // Example: | ||
| // | ||
| // str := NewStyle(). | ||
| // Foreground(lipgloss.Color("#6a00ff")). | ||
| // Render("artichokes") | ||
| // | ||
| // Fprintf(os.Stderr, "I really love %s!\n", food) | ||
| func Fprintf(w io.Writer, format string, v ...interface{}) (int, error) { | ||
| return fmt.Fprintf(colorprofile.NewWriter(w, os.Environ()), format, v...) //nolint:wrapcheck | ||
| } |
There was a problem hiding this comment.
I would leave this out. Every call allocates a new writer which defeats the purpose of fmt.Fprint. Instead, people should create a writer for os.Stderr and use fmt.Fprint
w := colorprofile.NewWriter(os.Stderr, os.Environ())
fmt.Fprintf(w, "I really love %s!", lipgloss.NewStyle().Render("artichokes"))There was a problem hiding this comment.
I agree, but ideally we reduce the cognitive complexity a bit. Let's look at it again once this beast of a branch is merged into v2-exp.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains solutions for adaptive colors, background color detection, and colorprofile-based writers. It also updates all tests and examples for
v2.The big changes in here are:
Available writer utilties are:
Writer(writes to stdout)Print(v ...any)Println(...any)Printf(string, ...any)Fprint(io.Writer, ...any)Fprintf(io.Writer, string, ...any)Supersedes #392.
Supersedes #389.