Skip to content

Commit

Permalink
📝 - Add or update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
rolandpeelen committed May 25, 2024
1 parent 4a97a8f commit f864793
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ This project should be considered in beta status. We run it in production at [Wa
Find this output by running `yarn rewatch --help`.

```
Rewatch is an alternative build system for the Rescript Compiler bsb (which uses Ninja internally). It strives to deliver consistent and faster builds in monorepo setups with multiple packages, where the default build system fails to pick up changed interfaces across multiple packages
Usage: rewatch [OPTIONS] [COMMAND] [FOLDER]
Arguments:
Expand Down Expand Up @@ -69,10 +71,13 @@ Options:
[possible values: true, false]
--compiler-args <COMPILER_ARGS>
This prints the compiler arguments. It expects the path to a rescript.json file. This also requires --bsc-path and --rescript-version to be present
--rescript-version <RESCRIPT_VERSION>
To be used in conjunction with compiler_args
--bsc-path <BSC_PATH>
A custom path to bsc
-h, --help
Print help (see a summary with '-h')
Expand Down
4 changes: 4 additions & 0 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,16 @@ struct Args {
#[arg(short, long)]
create_sourcedirs: Option<bool>,

/// This prints the compiler arguments. It expects the path to a rescript.json file.
/// This also requires --bsc-path and --rescript-version to be present
#[arg(long)]
compiler_args: Option<String>,

/// To be used in conjunction with compiler_args
#[arg(long)]
rescript_version: Option<String>,

/// A custom path to bsc
#[arg(long)]
bsc_path: Option<String>,
}
Expand Down

0 comments on commit f864793

Please sign in to comment.