feat: deprecate bs-deps and bs-dev-deps

Author: Bushuo

rewatch/src/build/compile.rs

@@ -507,15 +507,15 @@ fn get_dependency_paths(
     build_dev_deps: bool,
 ) -> Vec<Vec<String>> {
     let normal_deps = config
-        .bs_dependencies
+        .dependencies
         .clone()
         .unwrap_or_default()
         .into_iter()
         .map(DependentPackage::Normal)
         .collect();
     let dev_deps = if build_dev_deps {
         config
-            .bs_dev_dependencies
+            .dev_dependencies
             .clone()
             .unwrap_or_default()
             .into_iter()

rewatch/src/build/deps.rs

@@ -37,18 +37,11 @@ fn get_dep_modules(
     // Get the list of allowed dependency packages for this package
     let allowed_dependencies: AHashSet<String> = package
         .config
-        .bs_dependencies
+        .dependencies
         .as_ref()
         .unwrap_or(&vec![])
         .iter()
-        .chain(
-            package
-                .config
-                .bs_dev_dependencies
-                .as_ref()
-                .unwrap_or(&vec![])
-                .iter(),
-        )
+        .chain(package.config.dev_dependencies.as_ref().unwrap_or(&vec![]).iter())
         .cloned()
         .collect();
 

rewatch/src/build/packages.rs

@@ -299,7 +299,7 @@ fn read_dependencies(
     show_progress: bool,
 ) -> Vec<Dependency> {
     return parent_config
-        .bs_dependencies
+        .dependencies
         .to_owned()
         .unwrap_or_default()
         .iter()
@@ -888,9 +888,9 @@ pub fn validate_packages_dependencies(packages: &AHashMap<String, Package>) -> b
     let mut detected_unallowed_dependencies: AHashMap<String, UnallowedDependency> = AHashMap::new();
 
     for (package_name, package) in packages {
-        let bs_dependencies = &package.config.bs_dependencies.to_owned().unwrap_or(vec![]);
+        let bs_dependencies = &package.config.dependencies.to_owned().unwrap_or(vec![]);
         let pinned_dependencies = &package.config.pinned_dependencies.to_owned().unwrap_or(vec![]);
-        let dev_dependencies = &package.config.bs_dev_dependencies.to_owned().unwrap_or(vec![]);
+        let dev_dependencies = &package.config.dev_dependencies.to_owned().unwrap_or(vec![]);
 
         [
             ("bs-dependencies", bs_dependencies),
@@ -979,8 +979,8 @@ mod test {
                 warnings: None,
                 suffix: None,
                 pinned_dependencies: Some(pinned_deps),
-                bs_dependencies: Some(bs_deps),
-                bs_dev_dependencies: Some(build_dev_deps),
+                dependencies: Some(bs_deps),
+                dev_dependencies: Some(build_dev_deps),
                 ppx_flags: None,
                 bsc_flags: None,
                 namespace: None,

rewatch/src/config.rs

@@ -194,10 +194,21 @@ pub struct Config {
     pub suffix: Option<String>,
     #[serde(rename = "pinned-dependencies")]
     pub pinned_dependencies: Option<Vec<String>>,
-    #[serde(rename = "dependencies", alias = "bs-dependencies")]
-    pub bs_dependencies: Option<Vec<String>>,
-    #[serde(rename = "bs-dev-dependencies", alias = "dev-dependencies")]
-    pub bs_dev_dependencies: Option<Vec<String>>,
+
+    #[serde(
+        default,
+        alias = "bs-dependencies",
+        deserialize_with = "deserialize_dependencies"
+    )]
+    pub dependencies: Option<Vec<String>>,
+    #[serde(
+        default,
+        rename = "dev-dependencies",
+        alias = "bs-dev-dependencies",
+        deserialize_with = "deserialize_dev_dependencies"
+    )]
+    pub dev_dependencies: Option<Vec<String>>,
+
     #[serde(rename = "ppx-flags")]
     pub ppx_flags: Option<Vec<OneOrMore<String>>>,
     #[serde(rename = "bsc-flags", alias = "compiler-flags")]
@@ -691,7 +702,7 @@ mod tests {
         "#;
 
         let config = serde_json::from_str::<Config>(json).unwrap();
-        assert_eq!(config.bs_dependencies, Some(vec!["@testrepo/main".to_string()]));
+        assert_eq!(config.dependencies, Some(vec!["@testrepo/main".to_string()]));
     }
 
     #[test]
@@ -715,7 +726,7 @@ mod tests {
         "#;
 
         let config = serde_json::from_str::<Config>(json).unwrap();
-        assert_eq!(config.bs_dependencies, Some(vec!["@testrepo/main".to_string()]));
+        assert_eq!(config.dependencies, Some(vec!["@testrepo/main".to_string()]));
     }
 
     #[test]
@@ -739,10 +750,7 @@ mod tests {
         "#;
 
         let config = serde_json::from_str::<Config>(json).unwrap();
-        assert_eq!(
-            config.bs_dev_dependencies,
-            Some(vec!["@testrepo/main".to_string()])
-        );
+        assert_eq!(config.dev_dependencies, Some(vec!["@testrepo/main".to_string()]));
     }
 
     #[test]
@@ -766,9 +774,6 @@ mod tests {
         "#;
 
         let config = serde_json::from_str::<Config>(json).unwrap();
-        assert_eq!(
-            config.bs_dev_dependencies,
-            Some(vec!["@testrepo/main".to_string()])
-        );
+        assert_eq!(config.dev_dependencies, Some(vec!["@testrepo/main".to_string()]));
     }
 }

rewatch/src/helpers.rs

@@ -9,15 +9,7 @@ use std::time::{SystemTime, UNIX_EPOCH};
 
 pub type StdErr = String;
 
-pub mod deserialize {
-    pub fn default_false() -> bool {
-        false
-    }
-
-    pub fn default_true() -> bool {
-        true
-    }
-}
+pub mod deserialize;
 
 pub mod emojis {
     use console::Emoji;

rewatch/src/helpers/deserialize.rs

@@ -0,0 +1,59 @@
+//! Helper functions for deserializing config files
+
+use serde::Deserialize;
+
+pub fn default_false() -> bool {
+    false
+}
+
+pub fn default_true() -> bool {
+    true
+}
+
+// Custom deserializer for dependencies that emits a warning when bs-dependencies is used
+pub fn deserialize_dependencies<'de, D>(deserializer: D) -> Result<Option<Vec<String>>, D::Error>
+where
+    D: serde::Deserializer<'de>,
+{
+    // Define a wrapper enum to detect which variant was used
+    #[derive(Deserialize)]
+    #[serde(untagged)]
+    enum DependenciesField {
+        #[serde(rename = "bs-dependencies")]
+        BsDependencies(Option<Vec<String>>),
+        #[serde(rename = "dependencies")]
+        Dependencies(Option<Vec<String>>),
+    }
+
+    match DependenciesField::deserialize(deserializer)? {
+        DependenciesField::BsDependencies(deps) => {
+            log::warn!("'bs-dependencies' is deprecated, please use 'dependencies' instead");
+            Ok(deps)
+        }
+        DependenciesField::Dependencies(deps) => Ok(deps),
+    }
+}
+
+// Custom deserializer for dev-dependencies that emits a warning when bs-dev-dependencies is used
+pub fn deserialize_dev_dependencies<'de, D>(deserializer: D) -> Result<Option<Vec<String>>, D::Error>
+where
+    D: serde::Deserializer<'de>,
+{
+    // Define a wrapper enum to detect which variant was used
+    #[derive(Deserialize)]
+    #[serde(untagged)]
+    enum DevDependenciesField {
+        #[serde(rename = "bs-dev-dependencies")]
+        BsDevDependencies(Option<Vec<String>>),
+        #[serde(rename = "dev-dependencies")]
+        DevDependencies(Option<Vec<String>>),
+    }
+
+    match DevDependenciesField::deserialize(deserializer)? {
+        DevDependenciesField::BsDevDependencies(deps) => {
+            log::warn!("'bs-dev-dependencies' is deprecated, please use 'dev-dependencies' instead");
+            Ok(deps)
+        }
+        DevDependenciesField::DevDependencies(deps) => Ok(deps),
+    }
+}

rewatch/src/sourcedirs.rs

@@ -73,8 +73,8 @@ pub fn print(buildstate: &BuildState) {
             // Extract Pkgs
             let pkgs = [
                 &package.config.pinned_dependencies,
-                &package.config.bs_dependencies,
-                &package.config.bs_dev_dependencies,
+                &package.config.dependencies,
+                &package.config.dev_dependencies,
             ]
             .into_iter()
             .map(|dependencies| deps_to_pkgs(&buildstate.packages, dependencies));