feat: deprecate bsc-flags

Author: Bushuo

rewatch/src/build.rs

@@ -476,6 +476,9 @@ fn log_deprecations(build_state: &BuildState) {
                 config::DeprecationWarning::BsDevDependencies => {
                     log_deprecated_config_field(&package.name, "bs-dev-dependencies", "dev-dependencies");
                 }
+                config::DeprecationWarning::BscFlags => {
+                    log_deprecated_config_field(&package.name, "bsc-flags", "compiler-flags");
+                }
             });
     });
 }

rewatch/src/build/compile.rs

@@ -361,7 +361,7 @@ pub fn compiler_args(
     is_type_dev: bool,
     is_local_dep: bool,
 ) -> Vec<String> {
-    let bsc_flags = config::flatten_flags(&config.bsc_flags);
+    let bsc_flags = config::flatten_flags(&config.compiler_flags);
 
     let dependency_paths = get_dependency_paths(config, project_root, workspace_root, packages, is_type_dev);
 

rewatch/src/build/parse.rs

@@ -266,7 +266,7 @@ pub fn parser_args(
     let jsx_module_args = root_config.get_jsx_module_args();
     let jsx_mode_args = root_config.get_jsx_mode_args();
     let jsx_preserve_args = root_config.get_jsx_preserve_args();
-    let bsc_flags = config::flatten_flags(&config.bsc_flags);
+    let bsc_flags = config::flatten_flags(&config.compiler_flags);
 
     let file = PathBuf::from("..").join("..").join(file);
 

rewatch/src/config.rs

@@ -222,6 +222,7 @@ pub type GenTypeConfig = serde_json::Value;
 pub enum DeprecationWarning {
     BsDependencies,
     BsDevDependencies,
+    BscFlags,
 }
 
 /// # bsconfig.json representation
@@ -247,14 +248,15 @@ pub struct Config {
     // Deprecated field: overwrites dev_dependencies
     #[serde(rename = "bs-dev-dependencies")]
     bs_dev_dependencies: Option<Vec<String>>,
-    // Holds all deprecation warnings for the config struct
-    #[serde(skip)]
-    deprecation_warnings: Vec<DeprecationWarning>,
-
     #[serde(rename = "ppx-flags")]
     pub ppx_flags: Option<Vec<OneOrMore<String>>>,
-    #[serde(rename = "bsc-flags", alias = "compiler-flags")]
-    pub bsc_flags: Option<Vec<OneOrMore<String>>>,
+
+    #[serde(rename = "compiler-flags")]
+    pub compiler_flags: Option<Vec<OneOrMore<String>>>,
+    // Deprecated field: overwrites compiler_flags
+    #[serde(rename = "bsc-flags")]
+    bsc_flags: Option<Vec<OneOrMore<String>>>,
+
     pub namespace: Option<NamespaceConfig>,
     pub jsx: Option<JsxSpecs>,
     #[serde(rename = "gentypeconfig")]
@@ -265,6 +267,10 @@ pub struct Config {
     // this is a new feature of rewatch, and it's not part of the bsconfig.json spec
     #[serde(rename = "allowed-dependents")]
     pub allowed_dependents: Option<Vec<String>>,
+
+    // Holds all deprecation warnings for the config struct
+    #[serde(skip)]
+    deprecation_warnings: Vec<DeprecationWarning>,
 }
 
 /// This flattens string flags
@@ -588,6 +594,10 @@ impl Config {
             );
         }
 
+        if self.compiler_flags.is_some() && self.bsc_flags.is_some() {
+            bail!("compiler-flags and bsc-flags are mutually exclusive. Please use 'compiler-flags'");
+        }
+
         if self.bs_dependencies.is_some() {
             self.dependencies = self.bs_dependencies.take();
             self.deprecation_warnings.push(DeprecationWarning::BsDependencies);
@@ -597,6 +607,10 @@ impl Config {
             self.deprecation_warnings
                 .push(DeprecationWarning::BsDevDependencies);
         }
+        if self.bsc_flags.is_some() {
+            self.compiler_flags = self.bsc_flags.take();
+            self.deprecation_warnings.push(DeprecationWarning::BscFlags);
+        }
 
         Ok(())
     }
@@ -629,6 +643,7 @@ pub mod tests {
             bs_dependencies: None,
             bs_dev_dependencies: None,
             ppx_flags: None,
+            compiler_flags: None,
             bsc_flags: None,
             namespace: None,
             jsx: None,

rewatch/testrepo/packages/deprecated-config/rescript.json

@@ -11,5 +11,6 @@
   },
   "suffix": ".mjs",
   "bs-dependencies": [],
-  "bs-dev-dependencies": []
+  "bs-dev-dependencies": [],
+  "bsc-flags": []
 }

rewatch/testrepo/packages/namespace-casing/bsconfig.json

@@ -15,7 +15,7 @@
   ],
   "suffix": ".mjs",
   "dependencies": [],
-  "bsc-flags": [],
+  "compiler-flags": [],
   "jsx": {
     "version": 4
   }

rewatch/tests/snapshots/bs-dev-dependency-used-by-non-dev-source.txt

@@ -8,6 +8,9 @@ Use 'dependencies' instead.
 The field 'bs-dev-dependencies' found in the package config of '@testrepo/deprecated-config' is deprecated and will be removed in a future version.
 Use 'dev-dependencies' instead.
 
+The field 'bsc-flags' found in the package config of '@testrepo/deprecated-config' is deprecated and will be removed in a future version.
+Use 'compiler-flags' instead.
+
   We've found a bug for you!
   /packages/with-dev-deps/src/FileToTest.res:2:6-11
 

rewatch/tests/snapshots/dependency-cycle.txt

@@ -8,6 +8,9 @@ Use 'dependencies' instead.
 The field 'bs-dev-dependencies' found in the package config of '@testrepo/deprecated-config' is deprecated and will be removed in a future version.
 Use 'dev-dependencies' instead.
 
+The field 'bsc-flags' found in the package config of '@testrepo/deprecated-config' is deprecated and will be removed in a future version.
+Use 'compiler-flags' instead.
+
 Can't continue... Found a circular dependency in your code:
 Dep01
  → Dep02

rewatch/tests/snapshots/remove-file.txt

@@ -8,6 +8,9 @@ Use 'dependencies' instead.
 The field 'bs-dev-dependencies' found in the package config of '@testrepo/deprecated-config' is deprecated and will be removed in a future version.
 Use 'dev-dependencies' instead.
 
+The field 'bsc-flags' found in the package config of '@testrepo/deprecated-config' is deprecated and will be removed in a future version.
+Use 'compiler-flags' instead.
+
   We've found a bug for you!
   /packages/dep01/src/Dep01.res:3:9-17
 

rewatch/tests/snapshots/rename-file-internal-dep-namespace.txt

@@ -8,6 +8,9 @@ Use 'dependencies' instead.
 The field 'bs-dev-dependencies' found in the package config of '@testrepo/deprecated-config' is deprecated and will be removed in a future version.
 Use 'dev-dependencies' instead.
 
+The field 'bsc-flags' found in the package config of '@testrepo/deprecated-config' is deprecated and will be removed in a future version.
+Use 'compiler-flags' instead.
+
   We've found a bug for you!
   /packages/new-namespace/src/NS_alias.res:2:1-16