Skip to content

Commit 3826b54

Browse files
author
Roland Peelen
committed
🎨 - Update readme with clap output
1 parent 5af8be2 commit 3826b54

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,51 @@ This project should be considered in beta status. We run it in production at [Wa
3434

3535
Where `.` is the folder where the 'root' `bsconfig.json` lives. If you encounter a 'stale build error', either directly, or after a while, a `clean` may be needed to clean up some old compiler assets.
3636

37+
## Full Options
38+
39+
Find this output by running `yarn rewatch --help`.
40+
41+
```
42+
Usage: rewatch [OPTIONS] [COMMAND] [FOLDER]
43+
44+
Arguments:
45+
[COMMAND]
46+
Possible values:
47+
- build: Build using Rewatch
48+
- watch: Build, then start a watcher
49+
- clean: Clean the build artifacts
50+
51+
[FOLDER]
52+
The relative path to where the main bsconfig.json resides. IE - the root of your project
53+
54+
Options:
55+
-f, --filter <FILTER>
56+
Filter allows for a regex to be supplied which will filter the files to be compiled. For instance, to filter out test files for compilation while doing feature work
57+
58+
-a, --after-build <AFTER_BUILD>
59+
This allows one to pass an additional command to the watcher, which allows it to run when finished. For instance, to play a sound when done compiling, or to run a test suite. NOTE - You may need to add '--color=always' to your subcommand in case you want to output colour as well
60+
61+
-n, --no-timing <NO_TIMING>
62+
[possible values: true, false]
63+
64+
-c, --create-sourcedirs <CREATE_SOURCEDIRS>
65+
This creates a source_dirs.json file at the root of the monorepo, which is needed when you want to use Reanalyze
66+
67+
[possible values: true, false]
68+
69+
--compiler-args <COMPILER_ARGS>
70+
71+
72+
--rescript-version <RESCRIPT_VERSION>
73+
74+
75+
-h, --help
76+
Print help (see a summary with '-h')
77+
78+
-V, --version
79+
Print version
80+
```
81+
3782
# Contributing
3883

3984
Pre-requisites:

0 commit comments

Comments
 (0)