as-tree

Print a list of paths as a tree of paths.

For example, given:

dir1/foo.txt
dir1/bar.txt
dir2/qux.txt

it will print:

.
├── dir1
│   ├── foo.txt
│   └── bar.txt
└── dir2
    └── qux.txt

This tool is particularly useful when used with

find

fd

tree

find

fd

Inspired by this feature request.

Install

There are pre-built binary releases in the Releases tab.

This project is written in Rust and builds under both Bazel and Cargo.

To install from source using Cargo:

cargo install -f --git https://github.com/jez/as-tree

To install from source using Bazel:

git clone https://github.com/jez/as-tree
cd as-tree
make install

Usage

❯ as-tree --help
Print a list of paths as a tree of paths.

Usage:
  as-tree [options] []
Arguments:
          The file to read from. When omitted, reads from stdin.
Options:
  --color (always|auto|never)
                    Whether to colorize the output [default: auto]
  -h, --help        Print this help message
Example:
  find . -name '*.txt' | as-tree

Example

This tool is particularly useful with tools like

fd

tree

❯ fd --exclude test | as-tree
.
├── LICENSE.md
├── Makefile
├── README.md
├── WORKSPACE
├── bazel
├── main
│   ├── BUILD
│   └── main.cc
├── third_party
│   ├── BUILD
│   ├── externals.bzl
│   └── spdlog.BUILD
└── tools
    ├── BUILD
    ├── clang.bzl
    └── scripts
        ├── build_compilation_db.sh
        └── generate_compdb_targets.sh

Developing

Running the tests requires Bazel. The

./bazel

# Run the tests:
./bazel test --test_output=errors //test

To add a test, create two files:

- test/fixtures/foo.txt
- test/fixtures/foo.txt.exp

The first file is the input to feed to as-tree, and the second is the
expected output of as-tree on that input
Update all the tests:
./bazel test //test:update
When you add a new dependency, you'll need to add it with Bazel too:
cargo install cargo-raze # (one time setup)
cd third_party/cargo
cargo raze

TODO(jez)

• rustfmt / buildifier / shellcheck in CI
• [ ] Only use box drawing characters if the locale supports it
  • See

    man locale

    ,

    LC_CTYPE=C tree

• [ ] Add a

  -0

  flag to support files with newlines in their name
  • Seriously why is this allowed?