feat(config): warn on deprecated values

Author: JamieMason

src/rcfile.rs

@@ -6,7 +6,9 @@ use {
     semver_group::{AnySemverGroup, SemverGroup},
     version_group::{AnyVersionGroup, VersionGroup},
   },
+  log::warn,
   serde::Deserialize,
+  serde_json::Value,
   std::collections::HashMap,
 };
 
@@ -133,6 +135,8 @@ pub struct Rcfile {
   pub strict: bool,
   #[serde(default)]
   pub version_groups: Vec<AnyVersionGroup>,
+  #[serde(flatten)]
+  pub unknown_fields: HashMap<String, Value>,
 }
 
 impl Default for Rcfile {
@@ -142,6 +146,30 @@ impl Default for Rcfile {
 }
 
 impl Rcfile {
+  /// Log warnings for v13 config options that are no longer supported.
+  pub fn warn_deprecated_v13_config(&self) {
+    if self.unknown_fields.contains_key("dependencyTypes") {
+      warn!("Config property 'dependencyTypes' is deprecated in v14.");
+      warn!("Use CLI flag instead: --dependency-types prod,dev,peer");
+    }
+    if self.unknown_fields.contains_key("specifierTypes") {
+      warn!("Config property 'specifierTypes' is deprecated in v14.");
+      warn!("Use CLI flag instead: --specifier-types exact,range");
+    }
+    if self.unknown_fields.contains_key("lintFormatting") {
+      warn!("Config property 'lintFormatting' is deprecated in v14.");
+      warn!("Use 'syncpack format --check' to validate formatting.");
+    }
+    if self.unknown_fields.contains_key("lintSemverRanges") {
+      warn!("Config property 'lintSemverRanges' is deprecated in v14.");
+      warn!("Semver range checking is always enabled in 'syncpack lint'.");
+    }
+    if self.unknown_fields.contains_key("lintVersions") {
+      warn!("Config property 'lintVersions' is deprecated in v14.");
+      warn!("Version checking is always enabled in 'syncpack lint'.");
+    }
+  }
+
   /// Create every alias defined in the rcfile.
   pub fn get_dependency_groups(&self, packages: &Packages, all_dependency_types: &[DependencyType]) -> Vec<GroupSelector> {
     self

src/rcfile/discovery.rs

@@ -34,6 +34,7 @@ impl Rcfile {
         Rcfile::default()
       });
     debug!("Config discovery completed in {:?}", start.elapsed());
+    rcfile.warn_deprecated_v13_config();
     rcfile
   }
 

src/rcfile_test.rs

@@ -1,4 +1,4 @@
-use crate::rcfile::Rcfile;
+use {crate::rcfile::Rcfile, serde_json::json};
 
 #[test]
 fn default_format_bugs_is_false() {
@@ -11,3 +11,84 @@ fn default_format_repository_is_false() {
   let rcfile = Rcfile::default();
   assert!(!rcfile.format_repository);
 }
+
+#[test]
+fn detects_v13_dependency_types_in_config() {
+  let config_json = json!({
+    "dependencyTypes": ["prod", "dev"],
+    "versionGroups": []
+  });
+  let rcfile: Rcfile = serde_json::from_value(config_json).unwrap();
+  assert!(rcfile.unknown_fields.contains_key("dependencyTypes"));
+}
+
+#[test]
+fn detects_v13_specifier_types_in_config() {
+  let config_json = json!({
+    "specifierTypes": ["exact", "range"],
+    "versionGroups": []
+  });
+  let rcfile: Rcfile = serde_json::from_value(config_json).unwrap();
+  assert!(rcfile.unknown_fields.contains_key("specifierTypes"));
+}
+
+#[test]
+fn detects_v13_lint_formatting_in_config() {
+  let config_json = json!({
+    "lintFormatting": true,
+    "versionGroups": []
+  });
+  let rcfile: Rcfile = serde_json::from_value(config_json).unwrap();
+  assert!(rcfile.unknown_fields.contains_key("lintFormatting"));
+}
+
+#[test]
+fn detects_v13_lint_semver_ranges_in_config() {
+  let config_json = json!({
+    "lintSemverRanges": true,
+    "versionGroups": []
+  });
+  let rcfile: Rcfile = serde_json::from_value(config_json).unwrap();
+  assert!(rcfile.unknown_fields.contains_key("lintSemverRanges"));
+}
+
+#[test]
+fn detects_v13_lint_versions_in_config() {
+  let config_json = json!({
+    "lintVersions": true,
+    "versionGroups": []
+  });
+  let rcfile: Rcfile = serde_json::from_value(config_json).unwrap();
+  assert!(rcfile.unknown_fields.contains_key("lintVersions"));
+}
+
+#[test]
+fn detects_multiple_v13_properties_in_config() {
+  let config_json = json!({
+    "dependencyTypes": ["prod", "dev"],
+    "specifierTypes": ["exact"],
+    "lintFormatting": true,
+    "lintSemverRanges": false,
+    "lintVersions": true,
+    "versionGroups": []
+  });
+  let rcfile: Rcfile = serde_json::from_value(config_json).unwrap();
+  assert_eq!(rcfile.unknown_fields.len(), 5);
+  assert!(rcfile.unknown_fields.contains_key("dependencyTypes"));
+  assert!(rcfile.unknown_fields.contains_key("specifierTypes"));
+  assert!(rcfile.unknown_fields.contains_key("lintFormatting"));
+  assert!(rcfile.unknown_fields.contains_key("lintSemverRanges"));
+  assert!(rcfile.unknown_fields.contains_key("lintVersions"));
+}
+
+#[test]
+fn valid_v14_config_has_no_unknown_fields() {
+  let config_json = json!({
+    "versionGroups": [],
+    "semverGroups": [],
+    "indent": "  ",
+    "source": ["packages/*/package.json"]
+  });
+  let rcfile: Rcfile = serde_json::from_value(config_json).unwrap();
+  assert_eq!(rcfile.unknown_fields.len(), 0);
+}