Add explicit --prod flag for rewatch commands (#8347)

* Add --prod flag to rewatch build, watch, and clean commands

Skip dev-dependencies and dev source folders (type: "dev") when --prod is passed, enabling production builds without dev tooling installed.

Signed-Off-By: Jono Prest <jjprest@gmail.com>

* Add tests

* Run cargo fmt

* Update cli help test

* Update changelog

---------

Signed-off-by: Jono Prest <jjprest@gmail.com>

Author: JonoPrest

CHANGELOG.md

@@ -21,6 +21,8 @@
 
 #### :rocket: New Feature
 
+- Rewatch: add `--prod` flag to `build`, `watch`, and `clean` to skip dev-dependencies and dev sources (`"type": "dev"`), enabling builds in environments where dev packages aren't installed (e.g. after `pnpm install --prod`). https://github.com/rescript-lang/rescript/pull/8347
+
 #### :bug: Bug fix
 
 - Fix partial application generalization for `...`. https://github.com/rescript-lang/rescript/pull/8343

rewatch/src/build.rs

@@ -134,12 +134,13 @@ pub fn initialize_build(
     path: &Path,
     plain_output: bool,
     warn_error: Option<String>,
+    prod: bool,
 ) -> Result<BuildCommandState> {
     let project_context = ProjectContext::new(path)?;
     let compiler = get_compiler_info(&project_context)?;
 
     let timing_clean_start = Instant::now();
-    let packages = packages::make(filter, &project_context, show_progress)?;
+    let packages = packages::make(filter, &project_context, show_progress, prod)?;
 
     let compiler_check = verify_compiler_info(&packages, &compiler);
 
@@ -489,6 +490,7 @@ pub fn build(
     create_sourcedirs: bool,
     plain_output: bool,
     warn_error: Option<String>,
+    prod: bool,
 ) -> Result<BuildCommandState> {
     let default_timing: Option<std::time::Duration> = if no_timing {
         Some(std::time::Duration::new(0.0 as u64, 0.0 as u32))
@@ -503,6 +505,7 @@ pub fn build(
         path,
         plain_output,
         warn_error,
+        prod,
     )
     .with_context(|| "Could not initialize build")?;
 

rewatch/src/build/clean.rs

@@ -332,10 +332,10 @@ pub fn cleanup_after_build(build_state: &BuildCommandState) {
     });
 }
 
-pub fn clean(path: &Path, show_progress: bool, plain_output: bool) -> Result<()> {
+pub fn clean(path: &Path, show_progress: bool, plain_output: bool, prod: bool) -> Result<()> {
     let project_context = ProjectContext::new(path)?;
     let compiler_info = build::get_compiler_info(&project_context)?;
-    let packages = packages::make(&None, &project_context, show_progress)?;
+    let packages = packages::make(&None, &project_context, show_progress, prod)?;
 
     let timing_clean_compiler_assets = Instant::now();
     if !plain_output && show_progress {

rewatch/src/build/packages.rs

@@ -285,11 +285,15 @@ fn read_dependencies(
     package_config: &Config,
     show_progress: bool,
     is_local_dep: bool,
+    prod: bool,
 ) -> Vec<Dependency> {
     let mut dependencies = package_config.dependencies.to_owned().unwrap_or_default();
 
-    // Concatenate dev dependencies if is_local_dep is true
-    if is_local_dep && let Some(dev_deps) = package_config.dev_dependencies.to_owned() {
+    // Concatenate dev dependencies if is_local_dep is true and not in prod mode
+    if is_local_dep
+        && !prod
+        && let Some(dev_deps) = package_config.dev_dependencies.to_owned()
+    {
         dependencies.extend(dev_deps);
     }
 
@@ -395,6 +399,7 @@ fn read_dependencies(
                 &config,
                 show_progress,
                 is_local_dep,
+                prod,
             );
 
             Dependency {
@@ -509,7 +514,11 @@ This inconsistency will cause issues with package resolution.\n",
     })
 }
 
-fn read_packages(project_context: &ProjectContext, show_progress: bool) -> Result<AHashMap<String, Package>> {
+fn read_packages(
+    project_context: &ProjectContext,
+    show_progress: bool,
+    prod: bool,
+) -> Result<AHashMap<String, Package>> {
     // Store all packages and completely deduplicate them
     let mut map: AHashMap<String, Package> = AHashMap::new();
 
@@ -531,6 +540,7 @@ fn read_packages(project_context: &ProjectContext, show_progress: bool) -> Resul
         &project_context.current_config,
         show_progress,
         /* is local dep */ true,
+        prod,
     ));
 
     for d in dependencies.iter() {
@@ -594,6 +604,7 @@ pub fn get_source_files(
 fn extend_with_children(
     filter: &Option<regex::Regex>,
     mut build: AHashMap<String, Package>,
+    prod: bool,
 ) -> AHashMap<String, Package> {
     for (_key, package) in build.iter_mut() {
         let mut map: AHashMap<PathBuf, SourceFileMeta> = AHashMap::new();
@@ -606,7 +617,7 @@ fn extend_with_children(
                     Path::new(&package.path),
                     filter,
                     source,
-                    package.is_local_dep,
+                    package.is_local_dep && !prod,
                 )
             })
             .collect::<Vec<AHashMap<PathBuf, SourceFileMeta>>>()
@@ -649,12 +660,13 @@ pub fn make(
     filter: &Option<regex::Regex>,
     project_context: &ProjectContext,
     show_progress: bool,
+    prod: bool,
 ) -> Result<AHashMap<String, Package>> {
-    let map = read_packages(project_context, show_progress)?;
+    let map = read_packages(project_context, show_progress, prod)?;
 
     /* Once we have the deduplicated packages, we can add the source files for each - to minimize
      * the IO */
-    let result = extend_with_children(filter, map);
+    let result = extend_with_children(filter, map, prod);
 
     Ok(result)
 }

rewatch/src/cli.rs

@@ -219,6 +219,10 @@ pub struct BuildArgs {
     /// Disable output timing
     #[arg(short, long, default_value_t = false, num_args = 0..=1)]
     pub no_timing: bool,
+
+    /// Skip dev-dependencies and dev sources (type: "dev")
+    #[arg(long, default_value_t = false)]
+    pub prod: bool,
 }
 
 #[cfg(test)]
@@ -348,6 +352,57 @@ mod tests {
         assert_eq!(err.kind(), ErrorKind::DisplayVersion);
     }
 
+    // --prod flag tests.
+    #[test]
+    fn build_prod_flag_is_parsed() {
+        let cli = parse(&["rescript", "build", "--prod"]).expect("expected build command");
+
+        match cli.command {
+            Command::Build(build_args) => assert!(build_args.prod),
+            other => panic!("expected build command, got {other:?}"),
+        }
+    }
+
+    #[test]
+    fn build_prod_flag_defaults_to_false() {
+        let cli = parse(&["rescript", "build"]).expect("expected build command");
+
+        match cli.command {
+            Command::Build(build_args) => assert!(!build_args.prod),
+            other => panic!("expected build command, got {other:?}"),
+        }
+    }
+
+    #[test]
+    fn watch_prod_flag_is_parsed() {
+        let cli = parse(&["rescript", "watch", "--prod"]).expect("expected watch command");
+
+        match cli.command {
+            Command::Watch(watch_args) => assert!(watch_args.prod),
+            other => panic!("expected watch command, got {other:?}"),
+        }
+    }
+
+    #[test]
+    fn clean_prod_flag_is_parsed() {
+        let cli = parse(&["rescript", "clean", "--prod"]).expect("expected clean command");
+
+        match cli.command {
+            Command::Clean { prod, .. } => assert!(prod),
+            other => panic!("expected clean command, got {other:?}"),
+        }
+    }
+
+    #[test]
+    fn prod_flag_defaults_to_build_command() {
+        let cli = parse(&["rescript", "--prod"]).expect("expected default build command");
+
+        match cli.command {
+            Command::Build(build_args) => assert!(build_args.prod),
+            other => panic!("expected build command, got {other:?}"),
+        }
+    }
+
     #[cfg(unix)]
     #[test]
     fn non_utf_argument_returns_error() {
@@ -372,6 +427,10 @@ pub struct WatchArgs {
 
     #[command(flatten)]
     pub warn_error: WarnErrorArg,
+
+    /// Skip dev-dependencies and dev sources (type: "dev")
+    #[arg(long, default_value_t = false)]
+    pub prod: bool,
 }
 
 impl From<BuildArgs> for WatchArgs {
@@ -381,6 +440,7 @@ impl From<BuildArgs> for WatchArgs {
             filter: build_args.filter,
             after_build: build_args.after_build,
             warn_error: build_args.warn_error,
+            prod: build_args.prod,
         }
     }
 }
@@ -395,6 +455,10 @@ pub enum Command {
     Clean {
         #[command(flatten)]
         folder: FolderArg,
+
+        /// Skip dev-dependencies and dev sources (type: "dev")
+        #[arg(long, default_value_t = false)]
+        prod: bool,
     },
     /// Format ReScript files.
     Format {

rewatch/src/format.rs

@@ -36,7 +36,7 @@ fn get_files_in_scope() -> Result<Vec<String>> {
     let current_dir = std::env::current_dir()?;
     let project_context = project_context::ProjectContext::new(&current_dir)?;
 
-    let packages = packages::make(&None, &project_context, false)?;
+    let packages = packages::make(&None, &project_context, false, false)?;
     let mut files: Vec<String> = Vec::new();
     let packages_to_format = project_context.get_scoped_local_packages();
 

rewatch/src/main.rs

@@ -54,6 +54,7 @@ fn main() -> Result<()> {
                 true, // create_sourcedirs is now always enabled
                 plain_output,
                 (*build_args.warn_error).clone(),
+                build_args.prod,
             ) {
                 Err(e) => {
                     eprintln!("{:#}", e);
@@ -78,6 +79,7 @@ fn main() -> Result<()> {
                 true, // create_sourcedirs is now always enabled
                 plain_output,
                 (*watch_args.warn_error).clone(),
+                watch_args.prod,
             ) {
                 Err(e) => {
                     eprintln!("{:#}", e);
@@ -86,9 +88,9 @@ fn main() -> Result<()> {
                 Ok(_) => Ok(()),
             }
         }
-        cli::Command::Clean { folder } => {
+        cli::Command::Clean { folder, prod } => {
             let _lock = get_lock_or_exit(LockKind::Build, &folder);
-            let result = build::clean::clean(Path::new(&folder as &str), show_progress, plain_output);
+            let result = build::clean::clean(Path::new(&folder as &str), show_progress, plain_output, prod);
             let _lock = drop_lock(LockKind::Build, &folder);
 
             result

rewatch/src/watcher.rs

@@ -189,6 +189,7 @@ struct AsyncWatchArgs<'a> {
     after_build: Option<String>,
     create_sourcedirs: bool,
     plain_output: bool,
+    prod: bool,
 }
 
 async fn async_watch(
@@ -203,6 +204,7 @@ async fn async_watch(
         after_build,
         create_sourcedirs,
         plain_output,
+        prod,
     }: AsyncWatchArgs<'_>,
 ) -> Result<()> {
     let mut build_state = initial_build_state;
@@ -419,6 +421,7 @@ async fn async_watch(
                     path,
                     plain_output,
                     build_state.get_warn_error_override(),
+                    prod,
                 )
                 .expect("Could not initialize build");
 
@@ -478,6 +481,7 @@ pub fn start(
     create_sourcedirs: bool,
     plain_output: bool,
     warn_error: Option<String>,
+    prod: bool,
 ) -> Result<()> {
     futures::executor::block_on(async {
         let queue = Arc::new(FifoQueue::<Result<Event, Error>>::new());
@@ -497,6 +501,7 @@ pub fn start(
             path,
             plain_output,
             warn_error.clone(),
+            prod,
         )
         .with_context(|| "Could not initialize build")?;
 
@@ -515,6 +520,7 @@ pub fn start(
             after_build,
             create_sourcedirs,
             plain_output,
+            prod,
         })
         .await
     })