Merge pull request #5737 from HSLdevcom/add-translation-sorting

AB#542 - Add translation sorting script, add format script, and change lint script to only check

Author: vesameskanen

package.json

@@ -30,10 +30,15 @@
     "test:update-all-desktop-snapshots": "CONFIG=hsl yarn test:update-snapshots && CONFIG=tampere yarn test:update-snapshots && CONFIG=matka yarn test:update-snapshots",
     "test:update-all-mobile-snapshots": "MOBILE=true CONFIG=hsl yarn test:update-snapshots && MOBILE=true CONFIG=tampere yarn test:update-snapshots && MOBILE=true CONFIG=matka yarn test:update-snapshots",
     "test:update-all-snapshots": "yarn test:update-all-desktop-snapshots && yarn test:update-all-mobile-snapshots",
-    "es-lint": "eslint .",
-    "lint": "yarn run es-lint && yarn run prettier-styles && yarn run stylelint",
-    "prettier-styles": "prettier sass/**/*.scss app/**/*.scss digitransit-component/**/*.scss --fix --write",
+    "lint": "yarn run eslint && yarn run prettier-styles && yarn run stylelint",
+    "format": "yarn run sort-translations && yarn run eslint-fix && yarn run prettier-styles-fix && yarn run stylelint-fix",
+    "sort-translations": "node scripts/sort-translations.mjs",
+    "eslint": "eslint .",
+    "eslint-fix": "eslint . --fix",
+    "prettier-styles": "prettier sass/**/*.scss app/**/*.scss digitransit-component/**/*.scss --check",
+    "prettier-styles-fix": "prettier sass/**/*.scss app/**/*.scss digitransit-component/**/*.scss --write",
     "stylelint": "stylelint sass/**/*.scss app/**/*.scss digitransit-component/**/*.scss",
+    "stylelint-fix": "stylelint sass/**/*.scss app/**/*.scss digitransit-component/**/*.scss --fix",
     "build": "NODE_OPTIONS=--openssl-legacy-provider && NODE_ENV=production && yarn prebuild && node --max_old_space_size=4096 node_modules/.bin/webpack --progress --color",
     "build-workspaces": "yarn build-components && yarn build-search-utils && yarn build-store",
     "start": "NODE_ENV=production node $NODE_OPTS server/server",

scripts/README.md

@@ -1,12 +1,19 @@
-# Using scripts
+# Scripts
+
+## Using `sort-translations.js`
+
+This script sorts translation files in the [`app/translations`](/app/translations) directory.
+See the `sort-translations` and `format` scripts in [`package.json`](/package.json).
+
+## Using `ui.sh`
 
 See the `themeMap` in `app/configurations/config.default.js` for configuration options.
 
-## Before using
+### Before using
 ```
 source ui.sh
 ```
-## Usage examples
+### Usage examples
 
 Using remote instance of OTP with subscription key:
 ```

scripts/sort-translations.mjs

@@ -0,0 +1,98 @@
+#!/usr/bin/env node
+/* eslint-disable no-console */
+
+import fs from 'fs';
+import path from 'path';
+
+const TRANSLATIONS_DIR = path.resolve(
+  import.meta.dirname,
+  '../app/translations',
+);
+const PRINT_WIDTH = 80;
+
+function needsQuoting(key) {
+  return !/^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(key);
+}
+
+function formatKey(key) {
+  return needsQuoting(key) ? `'${key}'` : key;
+}
+
+function formatValue(value) {
+  const escaped = value
+    .replace(/\\/g, '\\\\')
+    .replace(/\n/g, '\\n')
+    .replace(/\r/g, '\\r')
+    .replace(/\t/g, '\\t');
+  // Use double quotes when value contains a single quote to avoid escaping
+  if (escaped.includes("'")) {
+    return `"${escaped.replace(/"/g, '\\"')}"`;
+  }
+  return `'${escaped}'`;
+}
+
+function sortedTranslationsFileContent(lang, translations) {
+  const lines = [];
+  lines.push('/* eslint sort-keys: "error" */');
+  lines.push('export default {');
+  lines.push(`  ${formatKey(lang)}: {`);
+
+  const keys = Object.keys(translations).sort();
+  for (let j = 0; j < keys.length; j++) {
+    const key = keys[j];
+    const formattedKey = formatKey(key);
+    const formattedValue = formatValue(translations[key]);
+    const singleLine = `    ${formattedKey}: ${formattedValue},`;
+    if (singleLine.length <= PRINT_WIDTH) {
+      lines.push(singleLine);
+    } else {
+      lines.push(`    ${formattedKey}:`);
+      lines.push(`      ${formattedValue},`);
+    }
+  }
+
+  lines.push('  },');
+  lines.push('};');
+  lines.push('');
+
+  return lines.join('\n');
+}
+
+async function main() {
+  try {
+    console.log('---------- Running sort-translations.mjs script ----------');
+
+    const files = fs
+      .readdirSync(TRANSLATIONS_DIR)
+      .filter(f => f.endsWith('.js'))
+      .sort();
+
+    for (let i = 0; i < files.length; i++) {
+      const file = files[i];
+      const filePath = path.join(TRANSLATIONS_DIR, file);
+      console.log('Processing file', filePath);
+      // eslint-disable-next-line no-await-in-loop
+      const module = await import(filePath);
+      const langData = module.default;
+      const lang = Object.keys(langData)[0];
+      const sorted = sortedTranslationsFileContent(lang, langData[lang]);
+
+      try {
+        fs.writeFileSync(filePath, sorted, 'utf-8');
+        console.log('Sorted translations written to', filePath);
+      } catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        console.error(
+          `Failed to write sorted translations to ${filePath}: ${message}`,
+        );
+        process.exitCode = 1;
+      }
+    }
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error);
+    console.error(`Failed to process translations: ${message}`);
+    process.exitCode = 1;
+  }
+}
+
+main();