Rewatch cli refactor by Bushuo · Pull Request #7551 · rescript-lang/rescript

Bushuo · 2025-06-15T19:24:44Z

Upstream the changes of rescript-lang/rewatch#162 and adjusted the PR description.

This PR refactors the CLI structure of rewatch to enhance clarity and improve the usability of subcommands and their associated arguments.

Key Changes:

Introduction of New Subcommands:

legacy: Acts as a passthrough to the legacy CLI rescript. In the future, this will be named rescript-legacy.
dump: Serves as an alias for legacy dump.
format: Serves as an alias for legacy format.

Breaking Change:

The --compiler-args argument has been replaced with a new subcommand compiler-args. I assume this change will have minimal impact. I guess this is mainly used as a debug command.
Arguments must be used after the sub-command. A call like this is invalid now rewatch --bsc-path=something build. This change was made because the number of arguments on the top level was getting out of hand and hard to track.

Benefits:
The refactored structure ensures a more intuitive CLI experience by clearly delineating which arguments apply to specific subcommands.
The introduction of aliases (dump and format) simplifies common operations and aims to make the transition to rewatch as the default build system easier.
The new compiler-args subcommand makes the CLI behavior more consistent and predictable.

pkg-pr-new · 2025-06-16T20:01:52Z

Open in StackBlitz

rescript

npm i https://pkg.pr.new/rescript-lang/rescript@7551

@rescript/darwin-arm64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/darwin-arm64@7551

@rescript/darwin-x64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/darwin-x64@7551

@rescript/linux-arm64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/linux-arm64@7551

@rescript/linux-x64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/linux-x64@7551

@rescript/win32-x64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/win32-x64@7551

commit: 834f890

Bushuo · 2025-06-18T07:59:30Z

@nojaf to answer you on your comment here rescript-lang/rewatch#162 (comment).
I think this is a great idea. I also think the plan was to eventually replace the legacy commands with commands implemented in rewatch.

nojaf · 2025-06-18T09:29:55Z

Not sure if relevant here, but I still see 1.2.0 for bunx rewatch --version.
At some point, this should be the rescript version?

rewatch legacy --help doesn't show any help:

(base) nojaf@nojaf-mbp tower-defense % bunx rewatch legacy --help

thread 'main' panicked at src/helpers.rs:252:14:
Could not find rescript-legacy
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

I got this with bunx rewatch dump as well.

Bushuo · 2025-06-18T09:49:33Z

Not sure if relevant here, but I still see 1.2.0 for bunx rewatch --version. At some point, this should be the rescript version?

I think the right time for this would be when rewatch is the default cli.

rewatch legacy --help doesn't show any help:

(base) nojaf@nojaf-mbp tower-defense % bunx rewatch legacy --help

thread 'main' panicked at src/helpers.rs:252:14:
Could not find rescript-legacy
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

I got this with bunx rewatch dump as well.

I prematurely already look for a binary named rescript-legacy. I guess in this PR we can still look for rescript. I will also add tests for the legacy subcommands.

cknitt · 2025-06-18T14:29:17Z

If I run rewatch help instead of rewatch --help, I get

error: unrecognized subcommand '--bsc-path'

Usage: rewatch.exe [OPTIONS] [FOLDER]
       rewatch.exe <COMMAND>

(the --bsc-path option is appended by the node wrapper script)

jfrolich · 2025-06-23T06:43:21Z

cli/rewatch.js

+        }
+      );
+    } else {
+      child_process.execFileSync(rewatch_exe, [...args], {


why do we need this branch? can we not just pass --bsc-path in both cases?

bsc-path is not a root level arg anymore

It might be an option to use an env var BSC_PATH instead to avoid this problem?

I like this idea. Either that, or we promote --bsc-path to a root level argument again. If we decide for the env var would this be in addition to the arg?

My thinking was that it would replace the arg. What's your opinion @jfrolich?

nojaf · 2025-06-27T08:49:23Z

@Bushuo, there still seems to be something up with the legacy commands:

Bushuo · 2025-06-27T08:51:53Z

@Bushuo, there still seems to be something up with the legacy commands:

Ok, strange, I will look into it.
The legacy build and clean command seems to work though, I included a test for it.
Those commands are not handled differently from format. The args are just passed to bsc.

Bushuo · 2025-06-27T12:27:05Z

@nojaf I can reproduce it and will fix it soon.

refactor `cli.rs` to remove duplication of docstrings

nojaf

Worked great on my machine!

Bushuo marked this pull request as ready for review June 18, 2025 07:59

Bushuo force-pushed the rewatch-cli-refactor branch 4 times, most recently from d38d158 to df28ac1 Compare June 22, 2025 17:35

Bushuo and others added 12 commits June 22, 2025 19:39

chore: force LF on windows

61a4b50

feat: upstream changes of rescript-lang/rewatch#162

475f49d

test: update cli arg ordering

110ba77

fix: look for rescript.exe not rescript-legacy

9859117

test: add legacy test repo

46c8454

test: add legacy build system compile tests

b4a1dbb

test: print stderr output on failure

aaed465

refactor: extract fn to get binary dir

107e510

fix: windows binary path

18dddc3

fix: pass bsc-path arg only to specific subcommands

66974f9

test: add package to testrepo deps

d2c561d

test: update snapshots

7742361

Bushuo force-pushed the rewatch-cli-refactor branch from df28ac1 to 7742361 Compare June 22, 2025 17:48

Merge branch 'master' into rewatch-cli-refactor

aca77bd

jfrolich reviewed Jun 23, 2025

View reviewed changes

Bushuo added 3 commits June 23, 2025 08:53

test: improve test output

fb9400c

fix: args passing in cli wrapper

9bf9d43

fix: pass --bsc-path to implicit build command

7faf311

cknitt approved these changes Jun 27, 2025

View reviewed changes

Bushuo and others added 5 commits June 28, 2025 23:21

fix: wrong path to rescript executable

b730d9f

refactor `cli.rs` to remove duplication of docstrings

fix: legacy tests inconsistency

f003508

test: is error output printed correctly

c88b2d4

debug: print whole output of rewatch legacy

876b797

fix: node script invocation on windows

635159b

nojaf approved these changes Jun 30, 2025

View reviewed changes

Bushuo added 2 commits June 30, 2025 15:26

Update CHANGELOG.md

2006080

Update CHANGELOG.md

834f890

Bushuo mentioned this pull request Jun 30, 2025

legacy subcommand & CLI structure refactor rescript-lang/rewatch#162

Closed

cknitt approved these changes Jun 30, 2025

View reviewed changes

cknitt merged commit 6deee63 into master Jun 30, 2025
28 of 29 checks passed

Bushuo deleted the rewatch-cli-refactor branch July 1, 2025 21:20

This was referenced Jul 3, 2025

Make rewatch the main cli and default build system #7588

Closed

Add reanalyze and doc subcommands to rescript cli #7587

Closed

Make rewatch the default build system / cli #7593

Merged

nojaf mentioned this pull request Jul 7, 2025

Update rewatch compiler-args for higher than alpha 14 rescript-lang/rescript-vscode#1104

Merged

Conversation

Bushuo commented Jun 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new bot commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Bushuo commented Jun 18, 2025

Uh oh!

nojaf commented Jun 18, 2025

Uh oh!

Bushuo commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cknitt commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jfrolich Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

Bushuo Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

cknitt Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

Bushuo Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

cknitt Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

nojaf commented Jun 27, 2025

Uh oh!

Bushuo commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Bushuo commented Jun 27, 2025

Uh oh!

nojaf left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Bushuo commented Jun 15, 2025 •

edited

Loading

pkg-pr-new bot commented Jun 16, 2025 •

edited

Loading

Bushuo commented Jun 18, 2025 •

edited

Loading

cknitt commented Jun 18, 2025 •

edited

Loading

Bushuo commented Jun 27, 2025 •

edited

Loading