Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sharkdp/lscolors
A Rust library and tool to colorize paths using LS_COLORS
https://github.com/sharkdp/lscolors
ansi-colors command-line filesystem hacktoberfest ls-colors rust shell terminal
Last synced: about 7 hours ago
JSON representation
A Rust library and tool to colorize paths using LS_COLORS
- Host: GitHub
- URL: https://github.com/sharkdp/lscolors
- Owner: sharkdp
- License: apache-2.0
- Created: 2018-12-09T10:50:01.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-10T00:59:09.000Z (9 months ago)
- Last Synced: 2024-04-15T00:15:11.477Z (8 months ago)
- Topics: ansi-colors, command-line, filesystem, hacktoberfest, ls-colors, rust, shell, terminal
- Language: Rust
- Homepage:
- Size: 122 KB
- Stars: 253
- Watchers: 11
- Forks: 17
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome-rust-tools - lscolors
README
# lscolors
[](https://github.com/sharkdp/lscolors/actions/workflows/CICD.yml)
[](https://crates.io/crates/lscolors)
[](https://docs.rs/lscolors)
A cross-platform library for colorizing paths according to the `LS_COLORS` environment variable (like `ls`).
## Usage
```rust
use lscolors::{LsColors, Style};
let lscolors = LsColors::from_env().unwrap_or_default();
let path = "some/folder/test.tar.gz";
let style = lscolors.style_for_path(path);
// If you want to use `ansi_term`:
let ansi_style = style.map(Style::to_ansi_term_style)
.unwrap_or_default();
println!("{}", ansi_style.paint(path));
// If you want to use `nu-ansi-term` (fork of ansi_term) or `gnu_legacy`:
let nu_ansi_style = style.map(Style::to_nu_ansi_term_style)
.unwrap_or_default();
println!("{}", nu_ansi_style.paint(path));
// If you want to use `crossterm`:
let crossterm_style = style.map(Style::to_crossterm_style)
.unwrap_or_default();
println!("{}", crossterm_style.apply(path));
```
## Command-line application
This crate also comes with a small command-line program `lscolors` that
can be used to colorize the output of other commands:
```bash
> find . -maxdepth 2 | lscolors
> rg foo -l | lscolors
```
You can install it by running `cargo install lscolors` or by downloading one
of the prebuilt binaries from the [release page](https://github.com/sharkdp/lscolors/releases).
If you want to build the application from source, you can run
```rs
cargo build --release --features=nu-ansi-term --locked
```
## Features
```rust
// Cargo.toml
[dependencies]
// use ansi-term coloring
lscolors = { version = "v0.14.0", features = ["ansi_term"] }
// use crossterm coloring
lscolors = { version = "v0.14.0", features = ["crossterm"] }
// use nu-ansi-term coloring
lscolors = { version = "v0.14.0", features = ["nu-ansi-term"] }
// use nu-ansi-term coloring in gnu legacy mode with double digit styles
lscolors = { version = "v0.14.0", features = ["gnu_legacy"] }
```
## License
Licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
## References
Information about the `LS_COLORS` environment variable is sparse. Here is a short list of useful references:
* [`LS_COLORS` implementation in the GNU coreutils version of `ls`](https://github.com/coreutils/coreutils/blob/17983b2cb3bccbb4fa69691178caddd99269bda9/src/ls.c#L2507-L2647) (the reference implementation)
* [`LS_COLORS` implementation in `bfs`](https://github.com/tavianator/bfs/blob/2.6/src/color.c#L556) by [**@tavianator**](https://github.com/tavianator)
* [The `DIR_COLORS(5)` man page](https://linux.die.net/man/5/dir_colors)