sort objects alphabetically, to make diffing easier (#279)

Author: k-yle

lib/build.js

@@ -9,7 +9,7 @@ import marky from 'marky';
 import { createRequire } from 'module';
 import { compile, toSafeIdentifier } from 'json-schema-to-typescript-lite';
 
-import fetchTranslations from './translations.js';
+import fetchTranslations, { sortObject } from './translations.js';
 
 const require = createRequire(import.meta.url);
 
@@ -162,6 +162,10 @@ function processData(options, type) {
     shell.rm('-rf', [distDir + '/translations']);
   }
 
+  categories = sortObject(categories);
+  fields = sortObject(fields);
+  presets = sortObject(presets);
+
   fs.writeFileSync(distDir + '/preset_categories.json', JSON.stringify(categories, null, 4));
   fs.writeFileSync(distDir + '/fields.json', JSON.stringify(fields, null, 4));
   fs.writeFileSync(distDir + '/presets.json', JSON.stringify(presets, null, 4));

lib/translations.js

@@ -4,6 +4,17 @@ import fetch from 'node-fetch';
 import YAML from 'js-yaml';
 import { transifexApi } from '@transifex/api';
 
+/**
+ * Sorts the keys of an object alphabetically
+ * @template {object} T @param {T} original @returns {T}
+ */
+export function sortObject(original) {
+  const sorted = {};
+  for (const k of Object.keys(original).sort()) {
+    sorted[k] = original[k];
+  }
+  return sorted;
+}
 
 function fetchTranslations(options) {
 
@@ -99,9 +110,7 @@ function fetchTranslations(options) {
       };
     }
 
-    const keys = Object.keys(dataLocales).sort();
-    let sortedLocales = {};
-    keys.forEach(k => sortedLocales[k] = dataLocales[k]);
+    const sortedLocales = sortObject(dataLocales);
     fs.writeFileSync(`${outDir}/index.json`, JSON.stringify(sortedLocales));
     fs.writeFileSync(`${outDir}/index.min.json`, JSON.stringify(sortedLocales, null, 4));
   }