Merge pull request #1012 from Automattic/sort-config

feat(core): make `LintConfig` sorted by key

Author: elijah-potter

harper-core/src/linting/lint_group.rs

@@ -73,7 +73,8 @@ use crate::{Dictionary, MutableDictionary};
 #[derive(Debug, Serialize, Deserialize, Default, Clone)]
 #[serde(transparent)]
 pub struct LintGroupConfig {
-    inner: HashMap<String, Option<bool>>,
+    /// A `BTreeMap` so that the config has a stable ordering when written to disk.
+    inner: BTreeMap<String, Option<bool>>,
 }
 
 #[cached]
@@ -95,7 +96,7 @@ impl LintGroupConfig {
     }
 
     pub fn set_rule_enabled_if_unset(&mut self, key: impl AsRef<str>, val: bool) {
-        if self.inner.get(key.as_ref()).is_none() {
+        if !self.inner.contains_key(key.as_ref()) {
             self.set_rule_enabled(key.as_ref().to_string(), val);
         }
     }
@@ -117,13 +118,15 @@ impl LintGroupConfig {
     ///
     /// Conflicting keys will be overridden by the value in the other group.
     pub fn merge_from(&mut self, other: &mut LintGroupConfig) {
-        for (key, val) in other.inner.drain() {
+        for (key, val) in other.inner.iter() {
             if val.is_none() {
                 continue;
             }
 
-            self.inner.insert(key, val);
+            self.inner.insert(key.to_string(), *val);
         }
+
+        other.clear();
     }
 
     /// Fill the group with the values for the curated lint group.

packages/harper.js/src/Linter.test.ts

@@ -210,12 +210,11 @@ test('Linters have the same JSON config format', async () => {
 	for (const Linter of Object.values(linters)) {
 		const linter = new Linter({ binary });
 
-		configs.push(await linter.getLintConfig());
+		configs.push(await linter.getLintConfigAsJSON());
 	}
 
 	for (const config of configs) {
-		// The keys of stringified configs would be unstable, so we'll just check the object.
 		expect(config).toEqual(configs[0]);
-		expect(config).toBeTypeOf('object');
+		expect(config).toBeTypeOf('string');
 	}
 });