Skip to content

chore: rename Complete to CompleteColor #579

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

Open
wants to merge 1 commit into
base: v2-exp
Choose a base branch
from
Open

chore: rename Complete to CompleteColor #579

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions color.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ func isDarkColor(c color.Color) bool {
return l < 0.5 //nolint:mnd
}

// CompleteFunc is a function that returns the appropriate color based on the
// CompleteColorFunc is a function that returns the appropriate color based on the
// given color profile.
//
// Example usage:
Expand All @@ -246,23 +246,23 @@ func isDarkColor(c color.Color) bool {
// )
// fmt.Println("Ooh, pretty color: ", color)
//
// For more info see [Complete].
type CompleteFunc func(ansi, ansi256, truecolor color.Color) color.Color
// For more info see [CompleteColor].
type CompleteColorFunc func(ansi, ansi256, truecolor color.Color) color.Color

// Complete returns a function that will return the appropriate color based on
// CompleteColor returns a function that will return the appropriate color based on
// the given color profile.
//
// Example usage:
//
// p := colorprofile.Detect(os.Stderr, os.Environ())
// complete := lipgloss.Complete(p)
// complete := lipgloss.CompleteColor(p)
// color := complete(
// lipgloss.Color(1), // ANSI
// lipgloss.Color(124), // ANSI256
// lipgloss.Color("#ff34ac"), // TrueColor
// )
// fmt.Println("Ooh, pretty color: ", color)
func Complete(p colorprofile.Profile) CompleteFunc {
func CompleteColor(p colorprofile.Profile) CompleteColorFunc {
return func(ansi, ansi256, truecolor color.Color) color.Color {
switch p { //nolint:exhaustive
case colorprofile.ANSI:
Expand Down
Loading