Sort localizations by languages on add

Author: mshibanami

src/commands/add.ts

@@ -6,6 +6,14 @@ import { runAddCommand, StringsFormat } from '../utils/cli.js';
 import logger from '../utils/logger.js';
 import chalk from 'chalk';
 
+type LocalizationMap = NonNullable<XCStringUnit['localizations']>;
+
+const sortLocalizations = (localizations: LocalizationMap): LocalizationMap => {
+    const sorted = Object.entries(localizations)
+        .sort(([langA], [langB]) => langA.localeCompare(langB, 'en', { sensitivity: 'case' }));
+    return Object.fromEntries(sorted) as LocalizationMap;
+};
+
 export function createAddCommand(): CommandModule {
     return {
         command: 'add',
@@ -172,5 +180,9 @@ export async function add(
     }
 
     data.strings[key] = unit;
+
+    if (unit.localizations) {
+        unit.localizations = sortLocalizations(unit.localizations);
+    }
     await writeXCStrings(path, data);
 }

tests/cli.add-state.single.test.ts

@@ -47,6 +47,27 @@ describe('cli add: state (single)', () => {
         expect(content.strings['greeting-review'].localizations.ja.stringUnit.state).toBe('needs_review');
     });
 
+    it('sorts localizations alphabetically when adding default text with translations', async () => {
+        const tempFile = await setupTempFile('no-strings.xcstrings');
+        const tempConfigPath = resolve(tempFile + '.config.json');
+        await writeFile(tempConfigPath, JSON.stringify({ missingLanguagePolicy: 'include' }), 'utf-8');
+
+        await runAddCommand({
+            path: tempFile,
+            key: 'greeting-order',
+            comment: undefined,
+            stringsArg: '{"ja":{"value":"こんにちは"},"de":{"value":"Hallo"}}',
+            stringsFormat: 'json',
+            defaultString: 'Hello',
+            stdinReader: async () => Promise.resolve(''),
+            configPath: tempConfigPath,
+        });
+
+        const content = JSON.parse(await readFile(tempFile, 'utf-8'));
+        const localizations = content.strings['greeting-order'].localizations;
+        expect(Object.keys(localizations)).toEqual(['de', 'en', 'ja']);
+    });
+
     it('rejects invalid state values with a clear message', async () => {
         const tempFile = await setupTempFile('no-strings.xcstrings');
         const tempConfigPath = resolve(tempFile + '.config.json');