felt 0.2.0

Defines command aliases and executes them.
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

# felt - Defines aliases and executes them.

felt is a simple command runner, written in Rust.

## Install

Install [Rust](https://www.rust-lang.org/learn/get-started) first. Then you can use `cargo` command to install `felt`.

`cargo` command is bundled with Rust.

```
cargo install felt
```

## Supported OS

|Family               |Supported|Note|
|:--------------------|:-------:|:---|
|Windows              | 🚧      |    |
|macOS(Intel)         | ✅      |    |
|macOS(Apple Silicon) | ✅      |    |
|Linux                | ✅      |    |

## Usage

Put a `.feltrc.toml` file in your home directory, which means `~/.feltrc.toml` file.

```toml
[felt]
root = true
node_modules = true

[command]
hello = "echo Hello! I\\'m Felt!"
nid = "npm install --save-dev"
```

You have defined `hello` command above. Let's execute it

```sh
felt hello
```

You will get output `Hello! I'm Felt!`.

You can also execute them with args.

```sh
felt nid esbuild react react-dom
```

## Execute node_modules

`felt` can execute command in `./node_modules/.bin/` directly. If you want this feature, set `node_modules` in `.feltrc.toml` to `true`.

```sh
# You may have some Node.js binaries.
npm install esbuild

# This execute ./node_modules/.bin/esbuild
felt esbuild index.js --minify --oufile build/index.js
```

**Notice:** Currently, `felt` searches `node_modules` in just current execution directory. Even if other related directory has `node_modules`, `felt` cannot find it.

## .feltrc.toml

`.feltrc.toml` is config file for `felt`. It may be put in home directory.

```toml
[felt]
# If root is true, felt doesn't see parent directory's .fetlrc.toml
# If this file is in home, you should set root to true.
# You can omit this line when it is false.
root = true

# If node_modules is true, felt can run binaries in ./node_modules/.bin/
# If false, disable the feature.
# If omit this line, its value is inherit from parent, or false when no parents set any value.
node_modules = true

[command]
# You can define yor command aliases!

# felt redis-up
redis-up = "docker run -it --rm -p 6379:6379 redis"

# felt countfiles
countfiles = "ls -l | wc -l"
```

## List all your commands

```
felt --list
```

or

```
felt -l
```

## Local .feltrc.toml

`felt` uses `.feltrc.toml` in below order.

1. current directory
1. parent directory
1. parent of parent...(recursively)

If current directory is out of home(e.g. `/tmp/`), append `~/.feltrc.toml` to last of above list.

If `felt` found `root = true` file. `felt` stops traverse there.

For example, home `.feltrc.toml` is:

```toml
[felt]
root = true
node_modules = false

[command]
hello = "echo Hello"
hello2 = "echo Hi"
```

And `~/myproject/.feltrc.toml` is:

```toml
[felt]
node_modules = true

[command]
hello = "echo Helloooooooooooooooo"
```

You can:

```sh
cd ~/myproject
felt hello
felt hello2
```