🐛 en-us dictionary has a new different key (en)

Signed-off-by: Marc Nuri <[email protected]>
manusa · Oct 12, 2023 · dcc4ea0 · dcc4ea0
1 parent 3a30e8e
commit dcc4ea0
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 22 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -207,7 +207,7 @@
     "dictionary-ca-valencia": "2.6.0",
     "dictionary-de": "2.0.4",
     "dictionary-en-gb": "2.4.0",
-    "dictionary-en-us": "3.0.0",
+    "dictionary-en": "3.2.0",
     "dictionary-es": "3.2.0",
     "dictionary-eu": "3.2.0",
     "dictionary-fr": "2.8.0",

diff --git a/src/settings/__tests__/index.test.js b/src/settings/__tests__/index.test.js
@@ -43,7 +43,7 @@ describe('Settings module test suite', () => {
       expectHomeDirectoryCreated();
       expect(fs.readFileSync).toHaveBeenCalledTimes(1);
       expect(result.tabs).toEqual([]);
-      expect(result.enabledDictionaries).toEqual(['en-US']);
+      expect(result.enabledDictionaries).toEqual(['en']);
       expect(result.theme).toEqual('system');
     });
     test('settings (empty) exist, should load settings from file system and merge with defaults', () => {
@@ -56,7 +56,7 @@ describe('Settings module test suite', () => {
       expectHomeDirectoryCreated();
       expect(fs.readFileSync).toHaveBeenCalledWith(path.join('$HOME', '.electronim', 'settings.json'));
       expect(result.tabs).toEqual([]);
-      expect(result.enabledDictionaries).toEqual(['en-US']);
+      expect(result.enabledDictionaries).toEqual(['en']);
       expect(result.theme).toEqual('system');
       expect(result.trayEnabled).toEqual(false);
     });
@@ -70,7 +70,7 @@ describe('Settings module test suite', () => {
       expectHomeDirectoryCreated();
       expect(fs.readFileSync).toHaveBeenCalledWith(path.join('$HOME', '.electronim', 'settings.json'));
       expect(result.tabs).toEqual([{id: '1'}]);
-      expect(result.enabledDictionaries).toEqual(['en-US']);
+      expect(result.enabledDictionaries).toEqual(['en']);
       expect(result.activeTab).toBe('1');
       expect(result.otherSetting).toBe(1337);
     });
@@ -84,6 +84,19 @@ describe('Settings module test suite', () => {
       expect(result.tabs).toEqual([{id: '1', disabled: true}, {id: '2'}]);
       expect(result.activeTab).toBe('2');
     });
+    test.each([
+      {enabledDictionaries: ['en-US', 'es'], expected: ['es', 'en']},
+      {enabledDictionaries: ['en-US', 'en', 'es'], expected: ['es', 'en']},
+      {enabledDictionaries: ['en-GB', 'en'], expected: ['en-GB', 'en']}
+    ])('settings with $enabledDictionaries dictionary, should migrate to $expected', ({enabledDictionaries, expected}) => {
+      // Given
+      fs.existsSync.mockImplementationOnce(() => true);
+      fs.readFileSync.mockImplementationOnce(() => JSON.stringify({enabledDictionaries}));
+      // When
+      const result = settings.loadSettings();
+      // Then
+      expect(result.enabledDictionaries).toEqual(expected);
+    });
     test.each([
       {key: 'theme', value: '"light"', expected: 'light'},
       {key: 'activeTab', value: 42, expected: 42},
@@ -110,7 +123,7 @@ describe('Settings module test suite', () => {
       expect(fs.writeFileSync).toHaveBeenCalledWith(path.join('$HOME', '.electronim', 'settings.json'),
         '{\n  "tabs": [],\n' +
         '  "useNativeSpellChecker": false,\n' +
-        '  "enabledDictionaries": [\n    "en-US"\n  ],\n' +
+        '  "enabledDictionaries": [\n    "en"\n  ],\n' +
         '  "theme": "system",\n  "trayEnabled": false,\n' +
         '  "closeButtonBehavior": "quit"\n' +
         '}');
@@ -124,7 +137,7 @@ describe('Settings module test suite', () => {
       expect(fs.writeFileSync).toHaveBeenCalledWith(path.join('$HOME', '.electronim', 'settings.json'),
         '{\n  "tabs": [\n    {\n      "id": 1337\n    }\n  ],\n' +
         '  "useNativeSpellChecker": false,\n' +
-        '  "enabledDictionaries": [\n    "en-US"\n  ],\n' +
+        '  "enabledDictionaries": [\n    "en"\n  ],\n' +
         '  "theme": "system",\n' +
         '  "trayEnabled": false,\n' +
         '  "closeButtonBehavior": "quit",\n' +
@@ -141,7 +154,7 @@ describe('Settings module test suite', () => {
       expect(fs.writeFileSync).toHaveBeenCalledWith(path.join('$HOME', '.electronim', 'settings.json'),
         '{\n  "tabs": [\n    {\n      "id": 1337\n    }\n  ],\n' +
         '  "useNativeSpellChecker": false,\n' +
-        '  "enabledDictionaries": [\n    "en-US"\n  ],\n' +
+        '  "enabledDictionaries": [\n    "en"\n  ],\n' +
         '  "theme": "system",\n' +
         '  "trayEnabled": false,\n' +
         '  "closeButtonBehavior": "quit",\n' +

diff --git a/src/settings/index.js b/src/settings/index.js
@@ -25,7 +25,7 @@ const SETTINGS_FILE = 'settings.json';
 const DEFAULT_SETTINGS = {
   tabs: [],
   useNativeSpellChecker: false,
-  enabledDictionaries: ['en-US'],
+  enabledDictionaries: ['en'],
   theme: 'system',
   trayEnabled: false,
   closeButtonBehavior: CLOSE_BUTTON_BEHAVIORS.quit
@@ -62,6 +62,17 @@ const ensureDefaultValues = settings => {
   return {...settings, activeTab};
 };
 
+const migrate = settings => {
+  // en-us dictionary key is now en
+  if (settings.enabledDictionaries.includes('en-US')) {
+    settings.enabledDictionaries = settings.enabledDictionaries
+      .filter(dictionary => dictionary !== 'en-US')
+      .filter(dictionary => dictionary !== 'en')
+      .concat('en');
+  }
+  return settings;
+};
+
 const initAppDir = () => fs.mkdirSync(appDir, {recursive: true});
 
 const loadSettings = () => {
@@ -70,7 +81,7 @@ const loadSettings = () => {
   if (fs.existsSync(settingsPath)) {
     loadedSettings = JSON.parse(fs.readFileSync(settingsPath));
   }
-  return ensureDefaultValues(loadedSettings);
+  return migrate(ensureDefaultValues(loadedSettings));
 };
 
 const writeSettings = settings => {

diff --git a/src/spell-check/index.js b/src/spell-check/index.js
@@ -30,7 +30,7 @@ const AVAILABLE_DICTIONARIES = {
   'en-GB': {
     name: 'English (GB)'
   },
-  'en-US': {
+  en: {
     name: 'English (US)'
   },
   es: {