@tolgee/cli 2.8.4 → 2.10.0

package/dist/utils/checkPathNotAFile.js

@@ -1,16 +1,27 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 import { stat } from 'fs/promises';
 import { exitWithError } from './logger.js';
-export async function checkPathNotAFile(path) {
-    try {
-        const stats = await stat(path);
-        if (!stats.isDirectory()) {
-            exitWithError('The specified path already exists and is not a directory.');
+export function checkPathNotAFile(path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const stats = yield stat(path);
+            if (!stats.isDirectory()) {
+                exitWithError('The specified path already exists and is not a directory.');
+            }
         }
-    }
-    catch (e) {
-        // Ignore "file doesn't exist" error
-        if (e.code !== 'ENOENT') {
-            throw e;
+        catch (e) {
+            // Ignore "file doesn't exist" error
+            if (e.code !== 'ENOENT') {
+                throw e;
+            }
         }
-    }
+    });
 }

package/dist/utils/filesTemplate.js

@@ -0,0 +1,147 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { glob } from 'tinyglobby';
+import { exitWithError } from './logger.js';
+const GLOB_EXISTING_DOUBLE_STAR = /(\*\*)/g;
+const GLOB_EXISTING_STAR = /(\*)/g;
+const GLOB_EXISTING_ENUM = /\{([^}]*?,[^}]*?)\}/g;
+const PLACEHOLDER_DOUBLE_ASTERISK = '__double_asterisk';
+const PLACEHOLDER_ASTERISK = '__asterisk';
+const PLACEHOLDER_ENUM_PREFIX = '__enum:';
+export class FileMatcherException extends Error {
+    constructor(message) {
+        super(message);
+        this.name = this.constructor.name;
+    }
+}
+function splitToParts(template) {
+    return template.split(/(\{.*?\})/g).filter(Boolean);
+}
+function getVariableName(part) {
+    if (part.startsWith('{') && part.endsWith('}')) {
+        return part.substring(1, part.length - 1).trim();
+    }
+    return false;
+}
+export function sanitizeTemplate(template) {
+    var _a;
+    let value = template;
+    const matchedEnums = [...(((_a = value.match(GLOB_EXISTING_ENUM)) === null || _a === void 0 ? void 0 : _a.values()) || [])];
+    matchedEnums.forEach((val) => {
+        value = value.replace(val, `{${PLACEHOLDER_ENUM_PREFIX}${getVariableName(val)}}`);
+    });
+    value = value.replaceAll(GLOB_EXISTING_DOUBLE_STAR, '{' + PLACEHOLDER_DOUBLE_ASTERISK + '}');
+    value = value.replaceAll(GLOB_EXISTING_STAR, '{' + PLACEHOLDER_ASTERISK + '}');
+    return value;
+}
+export function getFileMatcher(file, template) {
+    let fileName = file;
+    const allVariables = {};
+    const templateParts = splitToParts(template);
+    for (const [i, part] of templateParts.entries()) {
+        const variable = getVariableName(part);
+        if (!variable) {
+            if (fileName.startsWith(part)) {
+                fileName = fileName.substring(part.length);
+            }
+            else {
+                throw new FileMatcherException(`Unexpected part "${part}"`);
+            }
+        }
+        else {
+            const next = templateParts[i + 1];
+            if (next) {
+                const variableEnd = fileName.indexOf(next);
+                if (getVariableName(next) || variableEnd === -1) {
+                    throw new FileMatcherException(`Can't have two variables without separator (${part} + ${next})`);
+                }
+                else {
+                    allVariables[variable] = fileName.substring(0, variableEnd);
+                    fileName = fileName.substring(variableEnd);
+                }
+            }
+            else {
+                allVariables[variable] = fileName;
+            }
+        }
+    }
+    const result = { path: file };
+    for (const [variable, value] of Object.entries(allVariables)) {
+        if (variable === 'languageTag') {
+            result.language = value;
+        }
+        else if (variable === 'snakeLanguageTag') {
+            result.language = value.replaceAll('_', '-');
+        }
+        else if (variable === 'androidLanguageTag') {
+            if (value[3] === 'r') {
+                result.language =
+                    value.substring(0, 3) + value.substring(4, value.length);
+            }
+            else {
+                result.language = value;
+            }
+        }
+        else if (variable === 'namespace') {
+            result.namespace = value;
+        }
+        else if (variable !== 'extension' &&
+            ![PLACEHOLDER_ASTERISK, PLACEHOLDER_DOUBLE_ASTERISK].includes(variable) &&
+            !variable.startsWith(PLACEHOLDER_ENUM_PREFIX)) {
+            throw new FileMatcherException(`Unknown variable "${variable}"`);
+        }
+    }
+    return result;
+}
+export function getGlobPattern(template) {
+    let value = template.replaceAll(GLOB_EXISTING_DOUBLE_STAR, '{__double_asterisk}');
+    value = value.replaceAll(GLOB_EXISTING_STAR, '{__asterisk}');
+    const parts = splitToParts(value);
+    const globPattern = parts
+        .map((part) => {
+        const variableName = getVariableName(part);
+        if (variableName) {
+            if (variableName === PLACEHOLDER_DOUBLE_ASTERISK) {
+                return '**';
+            }
+            else if (variableName.startsWith(PLACEHOLDER_ENUM_PREFIX)) {
+                return ('{' + variableName.substring(PLACEHOLDER_ENUM_PREFIX.length) + '}');
+            }
+            else {
+                return '*';
+            }
+        }
+        else {
+            return part;
+        }
+    })
+        .join('');
+    return globPattern;
+}
+export function findFilesByTemplate(template) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const sanitized = sanitizeTemplate(template);
+            const globPattern = getGlobPattern(sanitized);
+            const files = yield glob(globPattern, { onlyFiles: true, absolute: true });
+            return files.map((file) => {
+                return getFileMatcher(file, sanitized);
+            });
+        }
+        catch (e) {
+            if (e instanceof FileMatcherException) {
+                exitWithError(e.message + ` in template ${template}`);
+            }
+            else {
+                throw e;
+            }
+        }
+    });
+}

package/dist/utils/mapExportFormat.js

@@ -9,6 +9,8 @@ export const mapExportFormat = (format) => {
             };
         case 'APPLE_XLIFF':
             return { format: 'APPLE_XLIFF', messageFormat: 'APPLE_SPRINTF' };
+        case 'APPLE_XCSTRINGS':
+            return { format: 'APPLE_XCSTRINGS', messageFormat: 'APPLE_SPRINTF' };
         case 'COMPOSE_XML':
             return { format: 'COMPOSE_XML', messageFormat: 'JAVA_STRING_FORMAT' };
         case 'FLUTTER_ARB':

package/dist/utils/mapImportFormat.js

@@ -13,6 +13,6 @@ export const mapImportFormat = (format, extension) => {
         case 'JSON_TOLGEE':
             return 'JSON_ICU';
         default:
-            return format ?? 'JSON_ICU';
+            return format !== null && format !== void 0 ? format : 'JSON_ICU';
     }
 };

package/dist/utils/moduleLoader.js

@@ -1,28 +1,42 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 import { pathToFileURL } from 'url';
 let jiti;
 // https://github.com/eslint/eslint/blob/6f37b0747a14dfa9a9e3bdebc5caed1f39b6b0e2/lib/config/config-loader.js#L164-L197
-async function importTypeScript(file) {
-    // @ts-ignore
-    if (!!globalThis.Bun || !!globalThis.Deno) {
-        // We're in an env that natively supports TS
-        return import(file);
-    }
-    if (!jiti) {
-        const { createJiti } = await import('jiti').catch(() => {
-            throw new Error("The 'jiti' library is required for loading TypeScript extractors. Make sure to install it.");
-        });
-        jiti = createJiti(import.meta.url);
-    }
-    return jiti.import(file);
+function importTypeScript(file) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // @ts-ignore
+        if (!!globalThis.Bun || !!globalThis.Deno) {
+            // We're in an env that natively supports TS
+            return import(file);
+        }
+        if (!jiti) {
+            const { createJiti } = yield import('jiti').catch(() => {
+                throw new Error("The 'jiti' library is required for loading TypeScript extractors. Make sure to install it.");
+            });
+            jiti = createJiti(import.meta.url);
+        }
+        return jiti.import(file);
+    });
 }
-export async function loadModule(module) {
-    if (module.endsWith('.ts')) {
-        return importTypeScript(module);
-    }
-    const fileUrl = pathToFileURL(module);
-    const mdl = await import(fileUrl.href);
-    if (mdl.default?.default) {
-        return mdl.default;
-    }
-    return mdl;
+export function loadModule(module) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        if (module.endsWith('.ts')) {
+            return importTypeScript(module);
+        }
+        const fileUrl = pathToFileURL(module);
+        const mdl = yield import(fileUrl.href);
+        if ((_a = mdl.default) === null || _a === void 0 ? void 0 : _a.default) {
+            return mdl.default;
+        }
+        return mdl;
+    });
 }

package/dist/utils/prepareDir.js

@@ -1,12 +1,23 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 import { mkdir, rm } from 'fs/promises';
 import { existsSync } from 'fs';
-export async function prepareDir(path, emptyDir) {
-    const exists = existsSync(path);
-    if (emptyDir && exists) {
-        await rm(path, { recursive: true });
-    }
-    if (!exists || emptyDir) {
-        // Create the directory
-        await mkdir(path, { recursive: true });
-    }
+export function prepareDir(path, emptyDir) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const exists = existsSync(path);
+        if (emptyDir && exists) {
+            yield rm(path, { recursive: true });
+        }
+        if (!exists || emptyDir) {
+            // Create the directory
+            yield mkdir(path, { recursive: true });
+        }
+    });
 }

package/dist/utils/valueToArray.js

@@ -0,0 +1,8 @@
+export function valueToArray(value) {
+    if (Array.isArray(value) || value === undefined || value == null) {
+        return value;
+    }
+    else {
+        return [value];
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tolgee/cli",
-  "version": "2.8.4",
+  "version": "2.10.0",
   "type": "module",
   "description": "A tool to interact with the Tolgee Platform through CLI",
   "repository": {
@@ -37,7 +37,7 @@
     "json5": "^2.2.3",
     "jsonschema": "^1.4.1",
     "openapi-fetch": "0.13.1",
-    "tinyglobby": "^0.2.10",
+    "tinyglobby": "^0.2.12",
     "unescape-js": "^1.1.4",
     "vscode-oniguruma": "^2.0.1",
     "vscode-textmate": "^9.1.0",

package/schema.json

@@ -42,8 +42,20 @@
     "push": {
       "type": "object",
       "properties": {
+        "filesTemplate": {
+          "description": "A template that describes the structure of the local files and their location with file [structure template format](https://docs.tolgee.io/tolgee-cli/push-pull-strings#file-structure-template-format).\n\nExample: `./public/{namespace}/{languageTag}.json`",
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": { "type": "string" }
+            }
+          ]
+        },
         "files": {
-          "description": "Define, which files should be pushed and attach language/namespace to them. By default Tolgee pushes all files specified here, you can filter them by languages and namespaces properties.",
+          "description": "More explicit alternative to `filesTemplate`. Define, which files should be pushed and attach language/namespace to them. By default Tolgee pushes all files specified here, you can filter them by languages and namespaces properties.",
           "type": "array",
           "items": { "$ref": "#/$defs/fileMatch" }
         },
@@ -128,7 +140,7 @@
           "type": "boolean"
         },
         "fileStructureTemplate": {
-          "description": "Defines exported file structure: https://tolgee.io/tolgee-cli/push-pull-strings#file-structure-template-format",
+          "description": "Defines exported file structure: https://docs.tolgee.io/tolgee-cli/push-pull-strings#file-structure-template-format",
           "type": "string"
         },
         "emptyDir": {
@@ -219,10 +231,13 @@
       "type": "object",
       "properties": {
         "path": { "$ref": "#/$defs/path" },
-        "language": { "type": "string" },
+        "language": {
+          "description": "Explicitly map file to language.\n\nIf not provided, backend will try to detect language from language name or it's content.",
+          "type": "string"
+        },
         "namespace": { "type": "string" }
       },
-      "required": ["path", "language"]
+      "required": ["path"]
     },
     "forceMode": {
       "description": "Specifies how to solve potential conflicts in the pushed data.\n\nOptions:\n\n  `OVERRIDE` - update everything according to local files\n  `KEEP` - create only non-existent strings, don't touch existing ones\n  `NO_FORCE` - throw an error, if there are any conflict",
@@ -251,6 +266,7 @@
         "PO_PYTHON",
         "APPLE_STRINGS",
         "APPLE_XLIFF",
+        "APPLE_XCSTRINGS",
         "PROPERTIES_ICU",
         "PROPERTIES_JAVA",
         "ANDROID_XML",