You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: rewatch/README.md
+40-24Lines changed: 40 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -43,62 +43,78 @@ Find this output by running `yarn rewatch --help`.
43
43
```
44
44
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
45
45
46
-
Usage: rewatch [OPTIONS] [COMMAND] [FOLDER]
46
+
Usage: rewatch [OPTIONS] [FOLDER]
47
+
rewatch <COMMAND>
48
+
49
+
Commands:
50
+
build Build using Rewatch
51
+
watch Build, then start a watcher
52
+
clean Clean the build artifacts
53
+
format Alias to `legacy format`
54
+
dump Alias to `legacy dump`
55
+
compiler-args This prints the compiler arguments. It expects the path to a rescript file (.res or .resi)
56
+
legacy Use the legacy build system
57
+
help Print this message or the help of the given subcommand(s)
47
58
48
59
Arguments:
49
-
[COMMAND]
50
-
Possible values:
51
-
- build: Build using Rewatch
52
-
- watch: Build, then start a watcher
53
-
- clean: Clean the build artifacts
54
-
55
60
[FOLDER]
56
61
The relative path to where the main rescript.json resides. IE - the root of your project
62
+
63
+
[default: .]
57
64
58
65
Options:
59
-
-f, --filter <FILTER>
60
-
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
61
-
62
-
-a, --after-build <AFTER_BUILD>
63
-
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
64
-
65
-
-n, --no-timing [<NO_TIMING>]
66
-
[default: false]
67
-
[possible values: true, false]
68
-
69
66
-v, --verbose...
70
67
Increase logging verbosity
71
68
72
69
-q, --quiet...
73
70
Decrease logging verbosity
74
71
72
+
-f, --filter <FILTER>
73
+
Filter files by regex
74
+
75
+
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.
76
+
77
+
-a, --after-build <AFTER_BUILD>
78
+
Action after build
79
+
80
+
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 color as well
81
+
75
82
-c, --create-sourcedirs [<CREATE_SOURCEDIRS>]
83
+
Create source_dirs.json
84
+
76
85
This creates a source_dirs.json file at the root of the monorepo, which is needed when you want to use Reanalyze
77
86
78
87
[default: false]
79
88
[possible values: true, false]
80
89
81
-
--compiler-args <COMPILER_ARGS>
82
-
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
83
-
84
90
--dev [<DEV>]
91
+
Build development dependencies
92
+
85
93
This is the flag to also compile development dependencies It's important to know that we currently do not discern between project src, and dependencies. So enabling this flag will enable building _all_ development dependencies of _all_ packages
0 commit comments