Skip to content

Commit

Permalink
🎨 - Update readme with clap output
Browse files Browse the repository at this point in the history
  • Loading branch information
rolandpeelen committed May 6, 2024
1 parent 5af8be2 commit 3826b54
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,51 @@ This project should be considered in beta status. We run it in production at [Wa

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.

## Full Options

Find this output by running `yarn rewatch --help`.

```
Usage: rewatch [OPTIONS] [COMMAND] [FOLDER]
Arguments:
[COMMAND]
Possible values:
- build: Build using Rewatch
- watch: Build, then start a watcher
- clean: Clean the build artifacts
[FOLDER]
The relative path to where the main bsconfig.json resides. IE - the root of your project
Options:
-f, --filter <FILTER>
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
-a, --after-build <AFTER_BUILD>
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
-n, --no-timing <NO_TIMING>
[possible values: true, false]
-c, --create-sourcedirs <CREATE_SOURCEDIRS>
This creates a source_dirs.json file at the root of the monorepo, which is needed when you want to use Reanalyze
[possible values: true, false]
--compiler-args <COMPILER_ARGS>
--rescript-version <RESCRIPT_VERSION>
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
```

# Contributing

Pre-requisites:
Expand Down

0 comments on commit 3826b54

Please sign in to comment.