Rewatch cli refactor (#7551)

* chore: force LF on windows

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

* test: update cli arg ordering

* fix: look for rescript.exe not rescript-legacy

* test: add legacy test repo

* test: add legacy build system compile tests

* test: print stderr output on failure

* refactor: extract fn to get binary dir

* fix: windows binary path

* fix: pass bsc-path arg only to specific subcommands

* test: add package to testrepo deps

* test: update snapshots

* test: improve test output

* fix: args passing in cli wrapper

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

* fix: wrong path to `rescript` executable

refactor `cli.rs` to remove duplication of docstrings

* fix: legacy tests inconsistency

* test: is error output printed correctly

* debug: print whole output of rewatch legacy

* fix: node script invocation on windows

* Update CHANGELOG.md

* Update CHANGELOG.md

Author: Bushuo

.gitattributes

@@ -1,3 +1,5 @@
+* text=auto eol=lf
+
 *.ml linguist-language=OCaml
 *.mli linguist-language=OCaml
 *.res linguist-language=ReScript

CHANGELOG.md

@@ -12,6 +12,10 @@
 
 # 12.0.0-alpha.15 (Unreleased)
 
+#### :boom: Breaking Change
+
+- The legacy rescript cli can be called through rewatch via `rewatch legacy`. Arguments to rewatch need to be passed after the subcommand. Argument `--compiler-args` is now a subcommand `compiler-args`. https://github.com/rescript-lang/rescript/pull/7551
+
 #### :bug: Bug fix
 
 - Ignore inferred arity in functions inside `%raw` functions, leaving to `%ffi` the responsibility to check the arity since it gives an error in case of mismatch. https://github.com/rescript-lang/rescript/pull/7542

cli/rewatch.js

@@ -7,10 +7,37 @@ import { rewatch_exe, bsc_exe } from "./common/bins.js";
 
 const args = process.argv.slice(2);
 
+const firstPositionalArgIndex = args.findIndex((arg) => !arg.startsWith("-"));
+
 try {
-  child_process.execFileSync(rewatch_exe, [...args, "--bsc-path", bsc_exe], {
-    stdio: "inherit",
-  });
+  if (firstPositionalArgIndex !== -1) {
+    const subcommand = args[firstPositionalArgIndex];
+    const subcommandWithArgs = args.slice(firstPositionalArgIndex);
+
+    if (
+      subcommand === "build" ||
+      subcommand === "watch" ||
+      subcommand === "clean" ||
+      subcommand === "compiler-args"
+    ) {
+      child_process.execFileSync(
+        rewatch_exe,
+        [...subcommandWithArgs, "--bsc-path", bsc_exe],
+        {
+          stdio: "inherit",
+        }
+      );
+    } else {
+      child_process.execFileSync(rewatch_exe, [...args], {
+        stdio: "inherit",
+      });
+    }
+  } else {
+    // no subcommand means build subcommand
+    child_process.execFileSync(rewatch_exe, [...args, "--bsc-path", bsc_exe], {
+      stdio: "inherit",
+    });
+  }
 } catch (err) {
   if (err.status !== undefined) {
     process.exit(err.status); // Pass through the exit code

rewatch/src/build.rs

@@ -18,10 +18,12 @@ use console::style;
 use indicatif::{ProgressBar, ProgressStyle};
 use log::log_enabled;
 use serde::Serialize;
+use std::ffi::OsString;
 use std::fmt;
 use std::fs::File;
 use std::io::{stdout, Write};
 use std::path::{Path, PathBuf};
+use std::process::Stdio;
 use std::time::{Duration, Instant};
 
 use self::compile::compiler_args;
@@ -57,7 +59,7 @@ pub struct CompilerArgs {
 pub fn get_compiler_args(
     path: &Path,
     rescript_version: Option<String>,
-    bsc_path: &Option<PathBuf>,
+    bsc_path: Option<PathBuf>,
     build_dev_deps: bool,
 ) -> Result<String> {
     let filename = &helpers::get_abs_path(path);
@@ -499,7 +501,7 @@ pub fn build(
     show_progress: bool,
     no_timing: bool,
     create_sourcedirs: bool,
-    bsc_path: &Option<PathBuf>,
+    bsc_path: Option<PathBuf>,
     build_dev_deps: bool,
     snapshot_output: bool,
 ) -> Result<BuildState> {
@@ -514,7 +516,7 @@ pub fn build(
         filter,
         show_progress,
         path,
-        bsc_path,
+        &bsc_path,
         build_dev_deps,
         snapshot_output,
     )
@@ -551,3 +553,25 @@ pub fn build(
         }
     }
 }
+
+pub fn pass_through_legacy(mut args: Vec<OsString>) -> i32 {
+    let project_root = helpers::get_abs_path(Path::new("."));
+    let workspace_root = helpers::get_workspace_root(&project_root);
+
+    let rescript_legacy_path = helpers::get_rescript_legacy(&project_root, workspace_root);
+
+    args.insert(0, rescript_legacy_path.into());
+    let status = std::process::Command::new("node")
+        .args(args)
+        .stdout(Stdio::inherit())
+        .stderr(Stdio::inherit())
+        .status();
+
+    match status {
+        Ok(s) => s.code().unwrap_or(0),
+        Err(err) => {
+            eprintln!("Error running the legacy build system: {err}");
+            1
+        }
+    }
+}

rewatch/src/build/clean.rs

@@ -334,8 +334,7 @@ pub fn cleanup_after_build(build_state: &BuildState) {
 pub fn clean(
     path: &Path,
     show_progress: bool,
-    bsc_path: &Option<PathBuf>,
-    build_dev_deps: bool,
+    bsc_path: Option<PathBuf>,
     snapshot_output: bool,
 ) -> Result<()> {
     let project_root = helpers::get_abs_path(path);
@@ -345,8 +344,9 @@ pub fn clean(
         &project_root,
         &workspace_root,
         show_progress,
-        // Always clean dev dependencies
-        build_dev_deps,
+        // Build the package tree with dev dependencies.
+        // They should always be cleaned if they are there.
+        true,
     )?;
     let root_config_name = packages::read_package_name(&project_root)?;
     let bsc_path = match bsc_path {