UNPKG

feri

Version:

An easy to use build tool for web files.

github.com/nightmode/feri

nightmode/feri

109 lines (72 loc) • 3.07 kB
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
# Feri - Command Line If installed globally, you can run the command `feri` from any directory. If installed locally, you'll need to run `npx feri` from your project folder. Feri will clean, build, and display statistics by default. She will also assume your source folder is "./source" and your destination folder is "./dest" unless you specify otherwise. ## Navigation * [Usage](#usage) * [Options](#options) * [Source](#source) * [Destination](#destination) * [Examples](#examples) ## Usage ``` feri [options] [source] [destination] ``` Optional elements include options, source, and destination. ## Options Options come in three flavours: Common, Negating, and Special. ### Common Options ``` -c, --clean clean the destination directory -b, --build build source files to destination -w, --watch watch source to clean and build as needed -e, --extensions monitor destination directory for extensions -s, --stats display statistics ``` Feri will clean, build, and display statistics by default. If you like those behaviors you can simply type `feri` instead of `feri --clean --build --stats`. ### Negating Options ``` -nc, --noclean no clean -nb, --nobuild no build -nw, --nowatch no watch -ne, --noextensions no extensions -ns, --nostats no statistics ``` Negating options override their counterparts. For example, `feri --clean --noclean` would result in the destination folder not being cleaned. ### Special Options Special options can override other options, do multiple things at once, or are otherwise unique. ``` -a, --all clean, build, watch, extensions, stats -f, --forcebuild overwrite destination files without consideration -r, --republish remove all destination files and then build -i, --init create source, destination, and custom config file -d, --debug enable verbose console logging -v, --version version -h, --help help ``` Special options like `--all`, `--forcebuild`, and `--republish` will override common and negating options. ## Source Optional source directory to build files from. If not provided, Feri will look for a `source` folder in the directory you called her from. ## Destination Optional destination directory to build files to. If not provided, Feri will look for a `dest` folder in the directory you called her from. ## Examples Clean, build, and stats are enabled by default. ``` feri ``` Clean, do not build, and then watch. ``` feri --nobuild --watch ``` Republish from a specific source folder to a specific destination folder. ``` feri --republish /path/to/source /path/to/destination ``` Clean, build, watch, and host a [Feri Extension](https://github.com/nightmode/feri-extension#feri-extension) server for Chrome, Edge, and Firefox. ``` feri --extensions ``` ## License MIT © [Kai Nightmode](https://nightmode.fm/) The MIT license does NOT apply to the name `Feri` or any of the images in this repository. Those items are strictly copyrighted to Kai Nightmode.