ftb 0.1.0

A fast CLI tool to format and align Markdown tables
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

# ftb

![CI](https://github.com/acamino/ftb/actions/workflows/ci.yml/badge.svg)

A simple CLI tool to format and align Markdown tables.

This is a Rust port of the JavaScript formatter from [markdowntable.com](http://markdowntable.com/).

## Installation

### From crates.io

```bash
cargo install ftb
```

This installs the `ftb` binary.

### From source

```bash
git clone https://github.com/acamino/ftb
cd ftb
cargo install --path .
```

## Usage

Pipe a Markdown table through `ftb` to align its columns:

```bash
pbpaste | ftb
```

Or use with files:

```bash
cat table.md | ftb
ftb table.md
ftb table.md > formatted.md
```

Try it with the demo file:

```bash
ftb examples/demo.md
```

## Examples

### Basic Table

Input:
```
| h1 | h2 | h3 |
|-|-|-|
| data1 | data2 | data3 |
```

Output:
```
| h1    | h2    | h3    |
|-------|-------|-------|
| data1 | data2 | data3 |
```

### Irregular Table

Input:
```
h1 | h2 | h3
-|-|-
data-1 | data-2 | data-3
```

Output:
```
| h1     | h2     | h3     |
|--------|--------|--------|
| data-1 | data-2 | data-3 |
```

### Complex Table with Missing Cells

Input:
```
| Header 1 | Header 2 | Header 3 |
|----|---|-|
| data1a | Data is longer than header | 1 |
| d1b | add a cell|
|lorem|ipsum|3|
```

Output:
```
| Header 1 | Header 2                   | Header 3 |
|----------|----------------------------|----------|
| data1a   | Data is longer than header | 1        |
| d1b      | add a cell                 |          |
| lorem    | ipsum                      | 3        |
```

## Features

- Aligns columns based on content width
- Handles missing cells by adding empty columns
- Removes leading/trailing empty columns
- Works with irregular table formats
- Fast and lightweight

## Development

### Running Tests

```bash
cargo test
```

### Building

```bash
cargo build --release
```

The binary will be available at `target/release/ftb`.

### Local Development Setup

For ergonomic local testing, choose one of these options:

**Option 1: Install locally**
```bash
cargo install --path .
# Now use: ftb
```

**Option 2: Symlink to /usr/local/bin**
```bash
ln -s $(pwd)/target/release/ftb /usr/local/bin/ftb
# Now use: ftb anywhere
```

## License

MIT

## Credits

Port of the Markdown table formatter from [markdowntable.com](http://markdowntable.com/).