fancy-tree 0.1.5

A `tree` alternative with git support, code language detection, and nerd fonts.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

# fancy-tree

[![Crates.io Version](https://img.shields.io/crates/v/fancy-tree)](https://crates.io/crates/fancy-tree)
[![CI](https://github.com/spenserblack/fancy-tree/actions/workflows/ci.yml/badge.svg)](https://github.com/spenserblack/fancy-tree/actions/workflows/ci.yml)

A `tree` alternative with git support, code language detection, and nerd fonts.

## Installation

View [`INSTALL.md`](./INSTALL.md)

## Features

### Nerd Font icons with language detection

[Nerd Fonts](https://www.nerdfonts.com/) are used for file icons. Each file is analyzed to determine the appropriate icon and color.

### Git Integration

- Git status is displayed
- Git ignored files' filenames are dimmed

### Highly Configurable

- Customize icons, colors, and behavior through Lua configuration files.

## Configuration

*You can edit a config file by calling `fancy-tree --edit-config [CONFIG]`.*

The configuration files are Lua modules, which makes them runnable scripts and allow for
complex behavior if wanted. This tool provides a small API under the `fancytree` global
table. Check out [`lua/meta`](./lua/meta/) to see the available utilities.

### `config.lua`

See the [default file][default-main-config] for an example.

This configures general settings.

### `icons.lua`

See the [default file][default-icon-config] for an example.

This provides a function that takes a filename, file attributes, and the default icon,
 and returns text to use for the icon. Return `nil` to disable the icon.

#### Example

```lua
return function(filename, attributes, default)
  if fancytree.glob_matches("*.config.{js,ts}", filename) then
    return ""
  end
  return default
end
```

### `colors.lua`

See the [default file][default-color-config] for an example.

This provides a function to decide the color for a file's icon, and also functions to
set the colors for git statuses.

[default-main-config]: ./src/config/main/config.lua
[default-color-config]: ./src/config/colors/colors.lua
[default-icon-config]: ./src/config/icons/icons.lua