fix configuration not being reloaded, "generationEnabled" not being used, formatting when running "Sort arb Files", add option to run sort & format when manually editing (#432)

schindler-s · web-flow · commit dba54171e1c9 · 2024-04-05T21:09:43.000+02:00
Authored-by: Stefan Schindler &lt;s.schindler@microist.com&gt;
diff --git a/.DS_Store b/.DS_Store
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -13,5 +13,8 @@
   // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
   "typescript.tsc.autoDetect": "off",
   "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.formatOnSave": true
+  "editor.formatOnSave": false,
+  "[dart]": {
+    "editor.formatOnSave": true
+  }
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "icon": "images/logo.png",
   "name": "l10nization",
   "displayName": "L10nization",
-  "version": "3.2.0",
+  "version": "3.2.2",
   "publisher": "lsaudon",
   "description": "A tool for extracting text to arb files in a Flutter application.",
   "author": {
@@ -90,6 +90,10 @@
           "type": "boolean",
           "default": true,
           "markdownDescription": "If enabled, sort keys alphabetically except for `@@locale` is first and `@key` are below their `key`."
+        }, "l10nization.organizeOnSave": {
+          "type": "boolean",
+          "default": true,
+          "markdownDescription": "If enabled and editing arb files manually, when saving runs sort if enabled and formats file"
         },
         "l10nization.addNewMessagesIn": {
           "type": "string",
diff --git a/src/extension/applySaveAndRunFlutterPubGet.ts b/src/extension/applySaveAndRunFlutterPubGet.ts
@@ -1,7 +1,7 @@
 import * as vscode from 'vscode';
 import { EditFilesParameters } from '../commands/editFilesParameters';
 import { getChangesForArbFiles } from './getChangesForArbFiles';
-import { runGeneration } from './runFlutterPubGet';
+import { runGeneration } from './runGeneration';
 
 export async function applySaveAndRunGeneration(editFilesParameters: EditFilesParameters): Promise<void> {
   const { workspace } = vscode;
diff --git a/src/extension/extension.ts b/src/extension/extension.ts
@@ -1,14 +1,24 @@
+import * as path from 'path';
 import * as vscode from 'vscode';
 import { CommandParameters } from '../commands/commandParameters';
+import { Configuration } from '../shared/configuration';
 import { EditFilesCommand } from '../commands/editFilesCommand';
 import { EditFilesParameters } from '../commands/editFilesParameters';
 import { InputBoxCommand } from '../commands/inputBoxCommand';
 import { LocalizationActionProvider } from '../codeActions/localizationActionProvider';
 import { applySaveAndRunGeneration } from './applySaveAndRunFlutterPubGet';
 import { setEditFilesParameters } from './setEditFilesParameters';
+import { sortAndFormat } from './sortAndFormat';
 import { sortAndSave } from './sortAndSave';
 
 export function activate(context: vscode.ExtensionContext): void {
+  vscode.workspace.onDidChangeConfiguration((event) => {
+    const affected = event.affectsConfiguration('l10nization');
+    if (affected) {
+      // reload configuration on changes to l10nization settings
+      Configuration.getInstance().reload();
+    }
+  });
   context.subscriptions.push(
     vscode.languages.registerCodeActionsProvider('dart', new LocalizationActionProvider(), {
       providedCodeActionKinds: LocalizationActionProvider.providedCodeActionKinds,
@@ -24,6 +34,20 @@ export function activate(context: vscode.ExtensionContext): void {
     vscode.commands.registerCommand(EditFilesCommand.commandName, async (...args: EditFilesParameters[]): Promise<void> => applySaveAndRunGeneration(args[0])),
   );
   context.subscriptions.push(vscode.commands.registerCommand('l10nization.sortArbFiles', async (): Promise<void> => sortAndSave()));
+
+  context.subscriptions.push(
+    vscode.workspace.onWillSaveTextDocument((e) => {
+      const organize = Configuration.getInstance().getOrganizeOnSave();
+
+      if (organize) {
+        const editor = vscode.window.activeTextEditor;
+
+        if (editor && editor.document === e.document && path.extname(e.document.fileName) === '.arb') {
+          e.waitUntil(sortAndFormat(e.document, editor));
+        }
+      }
+    }),
+  );
 }
 
 export function deactivate(): void {}
diff --git a/src/extension/getArbFiles.ts b/src/extension/getArbFiles.ts
@@ -1,6 +1,6 @@
 import * as vscode from 'vscode';
 import * as yaml from 'yaml';
-import { AddMessageInStatus, getAddNewMessagesIn, getYamlFileName } from '../shared/configuration';
+import { AddMessageInStatus, Configuration } from '../shared/configuration';
 import { resolvePath } from '../shared/resolvePath';
 
 async function findYamlFiles(projectName: string, yamlFileName: string): Promise<vscode.Uri[]> {
@@ -24,7 +24,7 @@ async function findArbFiles(projectName: string, arbDir: string): Promise<vscode
 }
 
 export async function getArbFiles(projectName: string): Promise<[vscode.Uri[], vscode.Uri | undefined]> {
-  const yamlFileName = getYamlFileName;
+  const yamlFileName = Configuration.getInstance().getYamlFileName();
   const yamlFiles = await findYamlFiles(projectName, yamlFileName);
 
   if (yamlFiles.length === 0) {
@@ -41,7 +41,7 @@ export async function getArbFiles(projectName: string): Promise<[vscode.Uri[], v
 
   const templateArbFileName = (parsedConfiguration.get('template-arb-file') as string | undefined) ?? 'app_en.arb';
   const templateArbFile = arbFiles.find((arbFile) => arbFile.path.endsWith(templateArbFileName));
-  const addMessageInStatus = getAddNewMessagesIn;
+  const addMessageInStatus = Configuration.getInstance().getAddNewMessagesIn();
   switch (addMessageInStatus) {
     case AddMessageInStatus.All:
       return [arbFiles, templateArbFile];
diff --git a/src/extension/getChangesForArbFiles.ts b/src/extension/getChangesForArbFiles.ts
@@ -1,6 +1,7 @@
 import * as vscode from 'vscode';
-import { getAppLocalizationsVariable, getCopyMetadataInAllFiles, getSortArbEnabled } from '../shared/configuration';
+import { Configuration } from '../shared/configuration';
 import { EditFilesParameters } from '../commands/editFilesParameters';
+import { L10nObject } from './l10nObject';
 import { getArbFiles } from './getArbFiles';
 import { getFunctionCall } from './getFunctionCall';
 import { getProjectName } from './getProjectName';
@@ -24,18 +25,18 @@ export async function getChangesForArbFiles(parameters: EditFilesParameters): Pr
   const workspaceEdit = new vscode.WorkspaceEdit();
   const { key, value } = parameters.keyValue;
   const { description, placeholders } = parameters;
-  const sortArbEnabled = getSortArbEnabled;
+  const sortArbEnabled = Configuration.getInstance().getSortArbEnabled();
   (await Promise.all(openTextDocuments)).forEach((content, index) => {
     const file = files[index];
-    const isMetadataEnabled = getCopyMetadataInAllFiles;
+    const isMetadataEnabled = Configuration.getInstance().getCopyMetadataInAllFiles();
     workspaceEdit.replace(
       file,
       new vscode.Range(new vscode.Position(0, 0), new vscode.Position(Number.MAX_SAFE_INTEGER, Number.MAX_SAFE_INTEGER)),
-      toJson(content.getText(), isMetadataEnabled || file === templateFile, key, description, value, placeholders, sortArbEnabled),
+      toJson(content.getText(), new L10nObject(isMetadataEnabled || file === templateFile, key, description, value, placeholders), sortArbEnabled),
     );
   });
 
-  const appLocalizationsVariable = getAppLocalizationsVariable;
+  const appLocalizationsVariable = Configuration.getInstance().getAppLocalizationsVariable();
   workspaceEdit.replace(
     parameters.uri,
     parameters.range,
diff --git a/src/extension/l10nObject.ts b/src/extension/l10nObject.ts
@@ -0,0 +1,17 @@
+import { Placeholder } from '../placeholders/placeholder';
+
+export class L10nObject {
+  readonly isMetadataEnabled: boolean;
+  readonly key: string;
+  readonly description: string | null;
+  readonly value: string;
+  readonly placeholders: Placeholder[];
+
+  constructor(isMetadataEnabled: boolean, key: string, description: string | null, value: string, placeholders: Placeholder[]) {
+    this.isMetadataEnabled = isMetadataEnabled;
+    this.key = key;
+    this.description = description;
+    this.value = value;
+    this.placeholders = placeholders;
+  }
+}
diff --git a/src/extension/runGeneration.ts b/src/extension/runGeneration.ts
@@ -1,8 +1,8 @@
-import { getGenerationActivted } from '../shared/configuration';
+import { Configuration } from '../shared/configuration';
 import { runIfExist } from './runIfExist';
 
 export async function runGeneration(): Promise<void> {
-  if (!getGenerationActivted) {
+  if (!Configuration.getInstance().getGenerationActivated()) {
     return;
   }
   await runIfExist('flutter.task.genl10n');
diff --git a/src/extension/setEditFilesParameters.ts b/src/extension/setEditFilesParameters.ts
@@ -4,13 +4,13 @@ import { LionizationPickItem, showQuickPick } from '../quickPick/showQuickPick';
 
 import { includeInCustomPattern, includeInDecimalDigits, includeInSymbol, validNumberFormats } from '../placeholders/numberFormat';
 import { CommandParameters } from '../commands/commandParameters';
+import { Configuration } from '../shared/configuration';
 import { EditFilesParameters } from '../commands/editFilesParameters';
 import { KeyValuePair } from './keyValuePair';
 import { Placeholder } from '../placeholders/placeholder';
 import { PlaceholderType } from '../placeholders/placeholderType';
 import { camelize } from '../shared/camelize';
 import { extractInterpolatedVariables } from '../shared/parser/parser';
-import { getHaveDescription } from '../shared/configuration';
 import { showDateFormatQuickPick } from '../placeholders/dateFormatQuickPick';
 import { showInputBox } from '../inputBox/showInputBox';
 import { showPlaceholderQuickPick } from '../placeholders/placeholderQuickPick';
@@ -67,7 +67,7 @@ export async function setEditFilesParameters(commandParameters: CommandParameter
   const key = await showInputBox('Enter the message name', camelize(commandParameters.value));
 
   let description = null;
-  if (getHaveDescription) {
+  if (Configuration.getInstance().getHaveDescription()) {
     description = await showInputBox('Enter the description', '');
   }
 
diff --git a/src/extension/sortAndFormat.ts b/src/extension/sortAndFormat.ts
@@ -0,0 +1,26 @@
+import * as vscode from 'vscode';
+import { Configuration } from '../shared/configuration';
+import { runGeneration } from './runGeneration';
+import { toJson } from './toJson';
+
+export async function sortAndFormat(document: vscode.TextDocument, editor: vscode.TextEditor): Promise<void> {
+  const { version } = document;
+  const text = document.getText();
+
+  try {
+    const startPosition = new vscode.Position(0, 0);
+    const endPosition = new vscode.Position(document.lineCount, 0);
+    const replaceRange = new vscode.Range(startPosition, endPosition);
+
+    const sortArbEnabled = Configuration.getInstance().getSortArbEnabled();
+    const result = toJson(text, null, sortArbEnabled);
+
+    if (text !== result && editor.document.version === version) {
+      await editor.edit((edit) => edit.replace(replaceRange, result));
+
+      await runGeneration();
+    }
+  } catch (e) {
+    console.log(e);
+  }
+}
diff --git a/src/extension/sortArbFiles.ts b/src/extension/sortArbFiles.ts
@@ -1,7 +1,7 @@
 import * as vscode from 'vscode';
 import { getArbFiles } from './getArbFiles';
 import { getProjectName } from './getProjectName';
-import { sortArb } from './sortArb';
+import { toJson } from './toJson';
 
 export async function sortArbFiles(): Promise<vscode.WorkspaceEdit> {
   const { activeTextEditor } = vscode.window;
@@ -23,7 +23,7 @@ export async function sortArbFiles(): Promise<vscode.WorkspaceEdit> {
   const textEdits = (await Promise.all(files.map((f) => vscode.workspace.openTextDocument(f).then((document) => document.getText())))).map((text) =>
     vscode.TextEdit.replace(
       new vscode.Range(new vscode.Position(0, 0), new vscode.Position(Number.MAX_SAFE_INTEGER, Number.MAX_SAFE_INTEGER)),
-      JSON.stringify(Object.fromEntries(sortArb(new Map<string, unknown>(Object.entries<string>(JSON.parse(text) as string))))),
+      toJson(text, null, true),
     ),
   );
 
diff --git a/src/extension/toJson.ts b/src/extension/toJson.ts
@@ -1,3 +1,4 @@
+import { L10nObject } from './l10nObject';
 import { Placeholder } from '../placeholders/placeholder';
 import { PlaceholderType } from '../placeholders/placeholderType';
 import { notInclude } from '../placeholders/dateFormat';
@@ -57,26 +58,21 @@ const replacePlaceholders = (value: string, placeholders: Placeholder[]): string
     return p.type === PlaceholderType.plural ? `{${p.name}, plural, other{${current}}}` : current;
   }, value);
 
-export function toJson(
-  text: string,
-  isMetadataEnabled: boolean,
-  key: string,
-  description: string | null,
-  value: string,
-  placeholders: Placeholder[],
-  sorted: boolean,
-): string {
+export function toJson(text: string, l10nKey: L10nObject | null, sorted: boolean): string {
   const map = new Map<string, unknown>(Object.entries<string>(JSON.parse(text) as string));
-  map.set(key, placeholders.length > 0 ? replacePlaceholders(value, placeholders) : value);
+  if (l10nKey) {
+    const { isMetadataEnabled, key, description, value, placeholders } = l10nKey;
+    map.set(key, placeholders.length > 0 ? replacePlaceholders(value, placeholders) : value);
 
-  if (isMetadataEnabled && (description || placeholders.length > 0)) {
-    const entry = {
-      ...(description && { description }),
-      ...(placeholders.length > 0 && {
-        placeholders: Object.fromEntries(getPlaceholdersMap(placeholders)),
-      }),
-    };
-    map.set(`@${key}`, entry);
+    if (isMetadataEnabled && (description || placeholders.length > 0)) {
+      const entry = {
+        ...(description && { description }),
+        ...(placeholders.length > 0 && {
+          placeholders: Object.fromEntries(getPlaceholdersMap(placeholders)),
+        }),
+      };
+      map.set(`@${key}`, entry);
+    }
   }
   return JSON.stringify(
     Object.fromEntries(sorted ? sortArb(map) : map),
diff --git a/src/shared/configuration.ts b/src/shared/configuration.ts
@@ -5,11 +5,83 @@ export enum AddMessageInStatus {
   Template = 'template',
 }
 
-const getConfiguration = vscode.workspace.getConfiguration('l10nization');
-export const getYamlFileName = getConfiguration.get<string>('yamlFile', 'l10n.yaml');
-export const getAppLocalizationsVariable = getConfiguration.get<string>('appLocalizationsVariable', 'l10n');
-export const getHaveDescription = getConfiguration.get<boolean>('haveDescription', false);
-export const getCopyMetadataInAllFiles = getConfiguration.get<boolean>('copyMetadataInAllFiles', true);
-export const getSortArbEnabled = getConfiguration.get<boolean>('arbSort', true);
-export const getGenerationActivted = getConfiguration.get<boolean>('flutterPubGetEnabled', true);
-export const getAddNewMessagesIn = getConfiguration.get<string>('addNewMessagesIn', 'all') as AddMessageInStatus;
+export class Configuration {
+  // eslint-disable-next-line no-use-before-define
+  private static instance: Configuration;
+  private yamlFileName!: string;
+  private appLocalizationsVariable!: string;
+  private haveDescription!: boolean;
+  private copyMetadataInAllFiles!: boolean;
+  private sortArbEnabled!: boolean;
+  private generationActivated!: boolean;
+  private addNewMessagesIn!: AddMessageInStatus;
+  private organizeOnSave!: boolean;
+
+  private constructor() {
+    this.reload();
+  }
+
+  public static getInstance(): Configuration {
+    if (!Configuration.instance) {
+      Configuration.instance = new Configuration();
+    }
+    return Configuration.instance;
+  }
+
+  public reload() {
+    const config = vscode.workspace.getConfiguration('l10nization');
+    this.yamlFileName = config.get<string>('yamlFile', 'l10n.yaml');
+    this.appLocalizationsVariable = config.get<string>('appLocalizationsVariable', 'l10n');
+    this.haveDescription = config.get<boolean>('haveDescription', false);
+    this.copyMetadataInAllFiles = config.get<boolean>('copyMetadataInAllFiles', true);
+    this.sortArbEnabled = config.get<boolean>('arbSort', true);
+    this.generationActivated = config.get<boolean>('generationEnabled', true);
+    this.addNewMessagesIn = config.get<string>('addNewMessagesIn', 'all') as AddMessageInStatus;
+    this.organizeOnSave = config.get<boolean>('organizeOnSave', true);
+  }
+
+  public getYamlFileName(): string {
+    return this.yamlFileName;
+  }
+
+  public getAppLocalizationsVariable(): string {
+    return this.appLocalizationsVariable;
+  }
+
+  public getHaveDescription(): boolean {
+    return this.haveDescription;
+  }
+
+  public getCopyMetadataInAllFiles(): boolean {
+    return this.copyMetadataInAllFiles;
+  }
+
+  public getSortArbEnabled(): boolean {
+    return this.sortArbEnabled;
+  }
+
+  public getGenerationActivated(): boolean {
+    return this.generationActivated;
+  }
+
+  public getAddNewMessagesIn(): AddMessageInStatus {
+    return this.addNewMessagesIn;
+  }
+
+  public getOrganizeOnSave(): boolean {
+    return this.organizeOnSave;
+  }
+
+  public toString(): string {
+    return `
+        YamlFileName: ${this.yamlFileName}
+        AppLocalizationsVariable: ${this.appLocalizationsVariable}
+        HaveDescription: ${this.haveDescription}
+        CopyMetadataInAllFiles: ${this.copyMetadataInAllFiles}
+        SortArbEnabled: ${this.sortArbEnabled}
+        GenerationActivated: ${this.generationActivated}
+        AddNewMessagesIn: ${this.addNewMessagesIn}
+        OrganizeOnSave: ${this.organizeOnSave}
+      `;
+  }
+}
diff --git a/src/test/suite/toJson.spec.ts b/src/test/suite/toJson.spec.ts
