XLIFF Sync - New Build with Translations command

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## [1.5.3] 24-07-2024
+
+* Changed default setting for `xliffSync.defaultLanguages` to empty
+* Fixed extension not asking for languages when generating translations with `xliffSync.defaultLanguages` being empty
+* Changed settings order
+
+## [1.5.2] 19-07-2024
+
+* Fixed saving Translation file issue when no Auto Save and using the `xliffSync.buildWithTranslations` command
+* Updated `README` with new Features
+
+## [1.5.1] 18-07-2024
+
+* New setting `xliffSync.defaultLanguages` that specifies the languages to automatically use when generating translations
+* New setting `xliffSync.buildCommandToExecute` that specifies the build command to execute for the `xliffSync.buildWithTranslations` command
+* Fixed `xliffSync.buildWithTranslations` command syncing translations twice
+
+## [1.5.0] 17-07-2024
+
+* New command `xliffSync.buildWithTranslations` that combines multiple commands into one
+
 ## [1.4.0] 30-12-2022
 
 * New setting `xliffSync.useSelfClosingTags` that can be used to specify whether to use self-closing tags in the XLIFF target translation files. (GitHub issue [#97](https://github.com/rvanbekkum/vsc-xliff-sync/issues/97))

README.md

@@ -1,6 +1,6 @@
 # XLIFF Sync
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![Version](https://vsmarketplacebadges.dev/version-short/rvanbekkum.xliff-sync.svg?color=blue)](https://marketplace.visualstudio.com/items?itemName=rvanbekkum.xliff-sync) [![Installs](https://vsmarketplacebadges.dev/installs/rvanbekkum.xliff-sync.svg?color=blue)](https://marketplace.visualstudio.com/items?itemName=rvanbekkum.xliff-sync)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.png)](https://opensource.org/licenses/MIT)
 
 <a href="https://www.buymeacoffee.com/robvanbekkum" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
 
@@ -20,21 +20,39 @@ View the demo in the [Areopa](https://areopa.academy/) webinar recording: [VS Co
 
 More information: [XLIFF Sync: Time for a complete overview](https://robvanbekkum.nl/xliff-sync-overview/)
 
-* [Features](#features)
-* [Contributions](#contributions)
-  * [Commands](#commands)
-  * [Settings](#settings)
-* [Usage](#usage)
-  * [Create New Target File(s)](#create-new-target-files)
-  * [Synchronize to Single File](#synchronize-to-single-file)
-  * [Synchronize Translation Units](#synchronize-translation-units)
-  * [Check for Missing Translations](#check-for-missing-translations)
-  * [Check for Need Work Translations](#check-for-need-work-translations)
-  * [Find Next Missing Translation in XLIFF File](#find-next-missing-translation-in-xliff-file)
-  * [Find Next Needs Work Translation in XLIFF File](#find-next-needs-work-translation-in-xliff-file)
-  * [Import Translations from File(s)](#import-translations-from-files)
-* [Known Issues](#known-issues)
-* [Contributors](#contributors)
+- [XLIFF Sync](#xliff-sync)
+  - [Summary](#summary)
+  - [Features](#features)
+  - [Contributions](#contributions)
+    - [Commands](#commands)
+    - [Settings](#settings)
+  - [Usage](#usage)
+    - [Create New Target File(s)](#create-new-target-files)
+      - [Using the Command Palette](#using-the-command-palette)
+    - [Synchronize to Single File](#synchronize-to-single-file)
+      - [Using the Command Palette](#using-the-command-palette-1)
+      - [Using keyboard shortcut](#using-keyboard-shortcut)
+    - [Synchronize Translation Units](#synchronize-translation-units)
+      - [Using the Command Palette](#using-the-command-palette-2)
+      - [Using keyboard shortcut](#using-keyboard-shortcut-1)
+      - [From the Explorer](#from-the-explorer)
+    - [Check for Missing Translations](#check-for-missing-translations)
+      - [Using the Command Palette](#using-the-command-palette-3)
+    - [Check for Need Work Translations](#check-for-need-work-translations)
+      - [Using the Command Palette](#using-the-command-palette-4)
+    - [Find Next Missing Translation in XLIFF File](#find-next-missing-translation-in-xliff-file)
+      - [Using the Command Palette](#using-the-command-palette-5)
+      - [Using keyboard shortcut](#using-keyboard-shortcut-2)
+    - [Find Next Needs Work Translation in XLIFF File](#find-next-needs-work-translation-in-xliff-file)
+      - [Using the Command Palette](#using-the-command-palette-6)
+      - [Using keyboard shortcut](#using-keyboard-shortcut-3)
+    - [Import Translations from File(s)](#import-translations-from-files)
+      - [Using the Command Palette](#using-the-command-palette-7)
+    - [Build with Translations](#build-with-translations)
+      - [Using the Command Palette](#using-the-command-palette-8)
+      - [Using keyboard shortcut](#using-keyboard-shortcut-4)
+  - [Known Issues](#known-issues)
+  - [Contributors](#contributors)
 
 ## Features
 
@@ -61,6 +79,7 @@ More information: [XLIFF Sync: Time for a complete overview](https://robvanbekku
 | **XLIFF: Next Missing Translation** | In an XLIFF file that is currently opened in the active editor, search for the next missing translation. |
 | **XLIFF: Next Needs Work Translation** | In an XLIFF file that is currently opened in the active editor, search for the next translation tagged as `needs-adaptation`. |
 | **XLIFF: Import Translations from File(s)** | Import/Copy translations from external XLIFF files to trans-units with matching sources of target XLIFF files with the same target-language. |
+| **XLIFF: Build with Translations** | Deletes, Builds and generates Translations all in one for the current opened files App |
 
 ![XLIFF Sync Command Palette Commands](resources/xliffSync_commandPaletteCommands.png)
 
@@ -111,6 +130,8 @@ More information: [XLIFF Sync: Time for a complete overview](https://robvanbekku
 | xliffSync.decorationTargetTextOnly | `false` | Specifies whether decorations for missing translations and translations that need work should only be applied to the target text. |
 | xliffSync.enableSnippetsForLanguages | `[]` | Specifies the programming languages for which the XLIFF Sync snippets should be enabled. Currently supported: `al`. |
 | xliffSync.snippetTargetLanguage | `TargetLanguageCode` | Specifies which target language to use by default in the XLIFF Sync snippets (e.g., `nl-NL`). |
+| xliffSync.defaultLanguages | `[]` | Specifies the languages that should automatically be used for the translation file generation. If empty, asks which language to use. |
+| xliffSync.buildCommandToExecute | `al.package` | Specifies the build command to execute when building with translations. |
 
 ## Usage
 
@@ -138,7 +159,7 @@ If no trans-unit or translation is found, the unit is added and its target node
 > 1. F1 or Ctrl/Cmd + Shift + P to open the command palette
 > 2. **XLIFF: Create New Target File(s)**
 
-This command will let you create one or more new target files, letting you choose from a set of RFC 4646 or RFC 5646 language tags depending on the XLIFF file type (i.e., `xlf` or `xlf2`).
+This command will let you create one or more new target files, using the languages specified in the `xliffSync.defaultLanguages` setting or when empty letting you choose from a set of RFC 4646 or RFC 5646 language tags depending on the XLIFF file type (i.e., `xlf` or `xlf2`).
 The new file is automatically synced with the base file; if it is not known you will be prompted to specify the file to use as the base file first.
 
 ![XLIFF Sync Create New Target Files Options](resources/xliffSync_createNewTargetFilesOptions.png)
@@ -283,6 +304,25 @@ That way you could utilize the Developer note to have the import perform a more
 
 More detailed instruction: [Import Translations from Files](https://robvanbekkum.nl/xliff-sync-overview/#import-translations-from-files)
 
+### Build with Translations
+
+#### Using the Command Palette
+
+> 1.  F1 or CMD + Shift + P to open the command palette
+> 2.  **XLIFF: Build with Translations**
+
+#### Using keyboard shortcut
+
+> 1.  Ctrl + Shift + T (default shortcut)
+
+This command combines multiple actions into one command:
+> 1. Delete current translation files
+> 2. Build App using the build command defined in new Setting `xliffSync.buildCommandToExecute`
+> 3. Create new Target files for Languages defined in new Setting `xliffSync.defaultLanguages`
+> 4. Syncs Translations files to show if translations are missing
+
+To use this, a file from the App for which you want to update the Translations has to be opened. Then execute the command.
+
 ## Known Issues
 
 * Automatically inserting _new_ groups into target files is not implemented.
@@ -295,6 +335,7 @@ More detailed instruction: [Import Translations from Files](https://robvanbekkum
 * [manux54](https://github.com/manux54)
 * [rvanbekkum](https://github.com/rvanbekkum)
 * [warlof](https://github.com/warlof)
+* [der_floh](https://github.com/Der-Floh)
 
 You can find the contributions in the [Changelog](https://marketplace.visualstudio.com/items/rvanbekkum.xliff-sync/changelog).
 Thank you all! 🤍

package.json

@@ -2,7 +2,7 @@
     "name": "xliff-sync",
     "displayName": "XLIFF Sync",
     "description": "A tool to keep XLIFF translation files in sync.",
-    "version": "1.4.0",
+    "version": "1.5.3",
     "publisher": "rvanbekkum",
     "repository": {
         "type": "git",
@@ -383,6 +383,29 @@
                     "default": "TargetLanguageCode",
                     "description": "Specifies which target language to use by default in the XLIFF Sync snippets.",
                     "scope": "resource"
+                },
+                "xliffSync.defaultLanguages": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "pattern": "^[a-z]{2}-[A-Z]{2}$"
+                    },
+                    "examples": [
+                        "en-US",
+                        "de-DE"
+                    ],
+                    "default": [],
+                    "uniqueItems": true,
+                    "description": "Specifies the languages that should automatically be used for the translation file generation. \nExamples: \"en-US\", \"de-DE\".",
+                    "order": 0,
+                    "scope": "resource"
+                },
+                "xliffSync.buildCommandToExecute": {
+                    "type": "string",
+                    "default": "al.package",
+                    "description": "Specifies the build command to execute when building with translations.",
+                    "order": 1,
+                    "scope": "resource"
                 }
             }
         },
@@ -426,6 +449,11 @@
                 "command": "xliffSync.importTranslationsFromFiles",
                 "title": "Import Translations from File(s)",
                 "category": "XLIFF"
+            },
+            {
+                "command": "xliffSync.buildWithTranslations",
+                "title": "Build with Translations",
+                "category": "XLIFF"
             }
         ],
         "keybindings": [
@@ -446,6 +474,11 @@
                 "command": "xliffSync.findNextNeedsWorkTarget",
                 "key": "alt+x w",
                 "when": "resourceExtname == .xlf"
+            },
+            {
+                "command": "xliffSync.buildWithTranslations",
+                "key": "ctrl+shift+t",
+                "when": "workspaceFolderCount > 0"
             }
         ],
         "menus": {
@@ -514,4 +547,4 @@
         "xml2js": "^0.4.19",
         "xmlbuilder": "^9.0.7"
     }
-}
+}

src/extension.ts

@@ -4,7 +4,7 @@ import {
 } from 'vscode';
 
 import { registerSnippets } from './features/snippets';
-import { synchronizeFiles, synchronizeWithSelectedFile, createNewTargetFiles } from './features/trans-sync';
+import { synchronizeFiles, synchronizeWithSelectedFile, createNewTargetFiles, buildWithTranslations } from './features/trans-sync';
 import { XliffTranslationChecker } from './features/trans-check';
 import { XliffTranslationImport } from './features/trans-import';
 
@@ -13,7 +13,7 @@ export function activate(context: ExtensionContext) {
     new XliffTranslationImport(context);
 
     context.subscriptions.push(
-        commands.registerCommand('xliffSync.createNewTargetFiles', async() => {
+        commands.registerCommand('xliffSync.createNewTargetFiles', async () => {
             createNewTargetFiles();
         })
     );
@@ -35,6 +35,12 @@ export function activate(context: ExtensionContext) {
         })
     );
 
+    context.subscriptions.push(
+        commands.registerCommand('xliffSync.buildWithTranslations', async () => {
+            buildWithTranslations();
+        })
+    );
+
     registerSnippets();
 }
 

src/features/tools/files-helper.ts

@@ -51,30 +51,48 @@ export class FilesHelper {
     let uris: Uri[] = [];
 
     if (fileType) {
-        uris = (await FilesHelper.findTranslationFiles(fileType, workspaceFolder)) || [];
+      uris = (await FilesHelper.findTranslationFiles(fileType, workspaceFolder)) || [];
     }
 
     if (!uris.length) {
-        fileType = await window.showQuickPick(['xlf', 'xlf2'], {
-            placeHolder: 'Translation file type',
-        });
+      fileType = await window.showQuickPick(['xlf', 'xlf2'], {
+        placeHolder: 'Translation file type',
+      });
 
-        if (fileType) {
-            uris = (await FilesHelper.findTranslationFiles(fileType, workspaceFolder)) || [];
+      if (fileType) {
+        uris = (await FilesHelper.findTranslationFiles(fileType, workspaceFolder)) || [];
 
-            if (uris.length) {
-                workspace.getConfiguration('xliffSync', workspaceFolder?.uri).update('fileType', fileType);
-            }
+        if (uris.length) {
+          workspace.getConfiguration('xliffSync', workspaceFolder?.uri).update('fileType', fileType);
         }
+      }
     }
 
     if (!uris.length) {
-        throw new Error(`No translation file found (Workspace: "${workspaceFolder?.name}").`);
+      throw new Error(`No translation file found (Workspace: "${workspaceFolder?.name}").`);
     }
 
     return uris;
   }
 
+  /**
+    * Checks if translation files exist in the opened workspace
+    *
+    * @param {WorkspaceFolder} workspaceFolder The folder to restrict the search to.
+    *
+    * @returns A boolean that specifies wether translation files exist in the current workspace.
+    */
+  public static async checkXliffFilesExist(workspaceFolder?: WorkspaceFolder): Promise<boolean> {
+    let fileType: string | undefined = workspace.getConfiguration('xliffSync', workspaceFolder?.uri)['fileType'];
+    let uris: Uri[] = [];
+
+    if (fileType) {
+      uris = (await FilesHelper.findTranslationFiles(fileType, workspaceFolder)) || [];
+    }
+
+    return uris.length !== 0;
+  }
+
   /**
    * Retrieves the base/source/generated XLIFF file from a collection of XLIFF file URIs.
    * Also prompts the user to specify a base file, if this wasn't done already.
@@ -114,11 +132,11 @@ export class FilesHelper {
     if (xliffUris.length > 1) {
       const fsPaths = xliffUris.map((uri) => uri.fsPath);
       const sourcePath = await window.showQuickPick(fsPaths, {
-          placeHolder: 'Select the base XLIFF file',
+        placeHolder: 'Select the base XLIFF file',
       });
 
       if (!sourcePath) {
-          return undefined;
+        return undefined;
       }
 
       sourceUri = xliffUris.find((uri) => uri.fsPath === sourcePath)!;
@@ -168,7 +186,7 @@ export class FilesHelper {
   }
 
   public static getTranslationFileExtensions(fileType: string): string {
-    switch(fileType) {
+    switch (fileType) {
       case 'xlf':
         return 'xlf';
       case 'xlf2':
@@ -248,4 +266,15 @@ export class FilesHelper {
   public static getSupportedFileExtensions(): string[] {
     return ['xlf', 'xlf2'];
   }
+
+  public static async saveOpenXliffFiles() {
+    const editorTabs = window.visibleTextEditors;
+
+    for (const editor of editorTabs) {
+      const document = editor.document;
+      if (document.fileName.endsWith('.xlf')) {
+        await document.save();
+      }
+    }
+  }
 }