proxy.golang.org : github.com/makyo/ansigo

Package ansigo provides control over ANSI escape codes for terminal apps. There are a few entry points to the library, but most commonly, one will just use `Apply` or `MaybeApply`, which accept a spec string and a string to format. `Apply` returns an error if any bit of the spec string failed to match and bails as soon as a failure occurs, while `MaybeApply` simply returns the string with all successful formatting applied (after all, it's just text, it'll still be text at the end). The spec string is simply a list of formatting steps to take separated by +. For instance, one could have bold green text with `bold+green`. Additionally, colors can be specified as background rather than foreground colors by appending `:bg` so we could have the previous on a blue background with `bold+green+blue:bg`. ansigo supports all SGR codes from the ANSI specification. This includes attributes such as bold and underline, as well as three different color spaces: 3/4-bit[0] (`Colors8`), 8-bit (`Colors256`), and 24-bit true-color (`Colors24bit`). For the list of which attributes and colors are available, as well as to see which your terminal supports, `Attributes` and all three color spaces above, as implementers of `Collection`, implement a `Find` method which returns a `Formatter`, if one is found, and an error if one is not. For `Attributes` and `Colors8`, the search term is just a name ("bold", "green", etc), but `Colors256` and `Colors24bit`, you have more leeway. For the former, you can search by color name (though note that there are some duplicate names in there, which will lead to you getting the first match back), color ID[1], and the color's CSS-style hex code (e.g: "#ff0000"), rgb function (e.g: "rgb(255, 0, 0)"), and hsl function (e.g: "hsl(0,100%,50%)"). However, all of those are strictly specified. If you search `Colors256` for, say, "#123512", you won't find it, despite that being a valid hex code. For that, use `Colors24bit`, which will succeed for any valid CSS hex/rgb/hsl function that uses whole numbers. That's a lot of choices, though, so it's usually better to just use `(Maybe)Apply` :) For a list of attributes and colors, see https://ansigo.projects.makyo.io . [0]: Despite the name, `Colors8` contains 16 colors, the 8 original colors, and their "bright" variants: "green" + "brightgreen", etc. [1]: Which the author was personally quite fascinated with:

Registry - Source - Documentation - JSON
purl: pkg:golang/github.com/makyo/ansigo
License: MIT
Latest release: over 2 years ago
First release: about 6 years ago
Namespace: github.com/makyo
Dependent packages: 1
Dependent repositories: 1
Last synced: 19 days ago

• Readme
• Versions 2
• Dependent Packages 1
• Maintainers 0