Merge pull request #40 from dms-viz/39-sort-the-json-consistently-for…

…-diffing

Sort the output `JSON` consistently for diffing

CHANGELOG.md

@@ -348,4 +348,22 @@
 
 ### Removed
 
+- N/A
+
+## [1.6.0] - 2024-11-25
+
+### Added
+
+- N/A
+
+### Changed
+
+- Sort the keys in the output JSON to prevent overhead in `git` diffs. 
+
+### Deprecated
+
+- N/A
+
+### Removed
+
 - N/A

configure_dms_viz/configure_dms_viz.py

@@ -1015,7 +1015,7 @@ def format(
 
     # Write the dictionary to a json file
     with open(output, "w") as f:
-        json.dump({name: experiment_dict}, f)
+        json.dump({name: experiment_dict}, f, sort_keys=True)
 
     click.secho(
         message=f"\nSuccess! The visualization JSON was written to '{output}'",
@@ -1088,7 +1088,7 @@ def join_command(input, output, description):
     try:
         # Write the combined data to the specified output file
         with open(output, "w") as f:
-            json.dump(combined_data, f)
+            json.dump(combined_data, f, sort_keys=True)
     except Exception as e:
         click.secho(f"Failed to write to output file. Error: {str(e)}", fg="red")
         return

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "configure-dms-viz"
-version = "1.5.0"
+version = "1.6.0"
 description = "Configure your data for visualization with dms-viz.github.io"
 authors = ["Will Hannon <[email protected]>"]
 maintainers = ["Will Hannon <[email protected]>"]