Skip to content

chore: add coverage badge and flag comparison #26

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

Merged
sighol merged 1 commit into from
Oct 4, 2025
Merged

chore: add coverage badge and flag comparison #26

Show file tree
Hide file tree
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
104 changes: 104 additions & 0 deletions PROGRESS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# tree-rs Feature Comparison with Original `tree` Command

---

## Supported options

| Flag | Supported |
|------|-----------|
| `-a`, `--all` | ✅ |
| `-d` | ✅ |
| `-l` | ❌ |
| `-f` | ❌ |
| `-x` | ❌ |
| `-L <level>`, `--level` | ✅ |
| `-R` | ❌ |
| `-P <pattern>` | ✅ |
| `-I <pattern>` | ✅ |
| `--gitignore` | ❌ |
| `--gitfile` | ❌ |
| `--ignore-case` | ❌ |
| `--matchdirs` | ❌ |
| `--metafirst` | ❌ |
| `--prune` | ❌ |
| `--info` | ❌ |
| `--infofile` | ❌ |
| `--noreport` | ❌ |
| `--charset` | ❌ |
| `--filelimit` | ❌ |
| `--timefmt` | ❌ |
| `-o <filename>` | ❌ |
| `-q` | ❌ |
| `-N` | ❌ |
| `-Q` | ❌ |
| `-p` | ❌ |
| `-u` | ❌ |
| `-g` | ❌ |
| `-s` | ❌ |
| `-h` | ❌ |
| `--si` | ❌ |
| `--du` | ❌ |
| `-D` | ❌ |
| `-F` | ❌ |
| `--inodes` | ❌ |
| `--device` | ❌ |
| `-v` | ❌ |
| `-t` | ❌ |
| `-c` | ❌ |
| `-U` | ❌ |
| `-r` | ❌ |
| `--dirsfirst` | ❌ |
| `--filesfirst` | ❌ |
| `--sort` | ❌ |
| `-i` | ❌ |
| `-A` | ❌ |
| `-S` | ❌ |
| `-n` | ✅ |
| `-C` | ✅ |
| `-X` | ❌ |
| `-J` | ❌ |
| `-H <baseHREF>` | ❌ |
| `-T <title>` | ❌ |
| `--nolinks` | ❌ |
| `--hintro` | ❌ |
| `--houtro` | ❌ |
| `--hyperlink` | ❌ |
| `--scheme` | ❌ |
| `--authority` | ❌ |
| `--fromfile` | ❌ |
| `--fromtabfile` | ❌ |
| `--fflinks` | ❌ |
| `--opt-toggle` | ❌ |
| `--help` | ✅ |
| `--version` | ✅ |
| `--` | ❌ |

---

## Environment Variables

| Variable | Supported |
|----------|-----------|
| `LS_COLORS` | ❌ |
| `TREE_COLORS` | ❌ |
| `CLICOLOR` | ❌ |
| `CLICOLOR_FORCE` | ❌ |
| `NO_COLOR` | ❌ |
| `LC_CTYPE` | ❌ |
| `LC_TIME` | ❌ |
| `TZ` | ❌ |

---

## Special Files

| Feature | Supported |
|---------|-----------|
| `.gitignore` | ❌ |
| `.info` files | ❌ |
| `/etc/DIR_COLORS` | ❌ |
| `~/.dircolors` | ❌ |

---

*Comparison based on tree v2.2.1 and tree-rs v0.6.4 (2025-10-04)*
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Crates.io](https://img.shields.io/crates/v/tree-rs.svg)](https://crates.io/crates/tree-rs)
[![Rust CI](https://github.com/sighol/tree-rs/actions/workflows/rust-ci.yaml/badge.svg)](https://github.com/sighol/tree-rs/actions/workflows/rust-ci.yaml)
[![Coverage](https://img.shields.io/badge/coverage-96%25-brightgreen)](https://github.com/sighol/tree-rs)

# Tree-rs

Expand Down Expand Up @@ -29,3 +30,7 @@ cargo install tree-rs
# or
cargo install --git https://github.com/sighol/tree-rs
```

## How close to actual `tree`?

See [progress](PROGRESS.md) for a detailed comparison with the original `tree` command.