@tolgee/cli 2.8.4 → 2.10.0

package/dist/commands/sync/compare.js

@@ -1,3 +1,12 @@
+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 { Command } from 'commander';
 import ansi from 'ansi-colors';
 import { compareKeys, printKey } from './syncUtils.js';
@@ -5,39 +14,42 @@ import { extractKeysOfFiles, filterExtractionResult, } from '../../extractor/run
 import { dumpWarnings } from '../../extractor/warnings.js';
 import { loading } from '../../utils/logger.js';
 import { handleLoadableError } from '../../client/TolgeeClient.js';
-const asyncHandler = (config) => async function () {
-    const opts = this.optsWithGlobals();
-    const rawKeys = await loading('Analyzing code...', extractKeysOfFiles(opts));
-    dumpWarnings(rawKeys);
-    const localKeys = filterExtractionResult(rawKeys);
-    const loadable = await opts.client.GET('/v2/projects/{projectId}/all-keys', { params: { path: { projectId: opts.client.getProjectId() } } });
-    handleLoadableError(loadable);
-    const remoteKeys = loadable.data._embedded.keys ?? [];
-    const diff = compareKeys(localKeys, remoteKeys);
-    if (!diff.added.length && !diff.removed.length) {
-        console.log(ansi.green('Your code project is in sync with the associated Tolgee project!'));
-        process.exit(0);
-    }
-    console.log('Your code project and Tolgee project are out of sync.');
-    if (diff.added.length) {
-        const key = diff.added.length === 1 ? 'key' : 'keys';
-        console.log(ansi.green.bold(`${diff.added.length} new ${key} found`));
-        for (const key of diff.added) {
-            printKey(key, false);
+const asyncHandler = (config) => function () {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        const opts = this.optsWithGlobals();
+        const rawKeys = yield loading('Analyzing code...', extractKeysOfFiles(opts));
+        dumpWarnings(rawKeys);
+        const localKeys = filterExtractionResult(rawKeys);
+        const loadable = yield opts.client.GET('/v2/projects/{projectId}/all-keys', { params: { path: { projectId: opts.client.getProjectId() } } });
+        handleLoadableError(loadable);
+        const remoteKeys = (_a = loadable.data._embedded.keys) !== null && _a !== void 0 ? _a : [];
+        const diff = compareKeys(localKeys, remoteKeys);
+        if (!diff.added.length && !diff.removed.length) {
+            console.log(ansi.green('Your code project is in sync with the associated Tolgee project!'));
+            process.exit(0);
+        }
+        console.log('Your code project and Tolgee project are out of sync.');
+        if (diff.added.length) {
+            const key = diff.added.length === 1 ? 'key' : 'keys';
+            console.log(ansi.green.bold(`${diff.added.length} new ${key} found`));
+            for (const key of diff.added) {
+                printKey(key, false);
+            }
+            // Line break
+            console.log('');
         }
-        // Line break
-        console.log('');
-    }
-    if (diff.removed.length) {
-        const key = diff.removed.length === 1 ? 'key' : 'keys';
-        console.log(ansi.red.bold(`${diff.removed.length} unused ${key}`));
-        for (const key of diff.removed) {
-            printKey(key, true);
+        if (diff.removed.length) {
+            const key = diff.removed.length === 1 ? 'key' : 'keys';
+            console.log(ansi.red.bold(`${diff.removed.length} unused ${key}`));
+            for (const key of diff.removed) {
+                printKey(key, true);
+            }
+            // Line break
+            console.log('');
         }
-        // Line break
-        console.log('');
-    }
-    console.log('Run `tolgee sync` to synchronize the projects.');
+        console.log('Run `tolgee sync` to synchronize the projects.');
+    });
 };
 export default (config) => new Command()
     .name('compare')

package/dist/commands/sync/sync.js

@@ -1,3 +1,12 @@
+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 { Command, Option } from 'commander';
 import ansi from 'ansi-colors';
 import { extractKeysOfFiles, filterExtractionResult, } from '../../extractor/runner.js';
@@ -8,114 +17,124 @@ import { unzipBuffer } from '../../utils/zip.js';
 import { askBoolean } from '../../utils/ask.js';
 import { loading, exitWithError } from '../../utils/logger.js';
 import { handleLoadableError, } from '../../client/TolgeeClient.js';
-async function backup(client, dest) {
-    const loadable = await client.export.export({
-        format: 'JSON',
-        supportArrays: false,
-        filterState: ['UNTRANSLATED', 'TRANSLATED', 'REVIEWED'],
-        structureDelimiter: '',
+function backup(client, dest) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const loadable = yield client.export.export({
+            format: 'JSON',
+            supportArrays: false,
+            filterState: ['UNTRANSLATED', 'TRANSLATED', 'REVIEWED'],
+            structureDelimiter: '',
+        });
+        handleLoadableError(loadable);
+        const blob = loadable.data;
+        yield unzipBuffer(blob, dest);
     });
-    handleLoadableError(loadable);
-    const blob = loadable.data;
-    await unzipBuffer(blob, dest);
 }
-async function askForConfirmation(keys, operation) {
-    if (!process.stdout.isTTY) {
-        exitWithError('You must run this command interactively, or specify --yes to proceed.');
-    }
-    const str = `The following keys will be ${operation}:`;
-    console.log(operation === 'created' ? ansi.bold.green(str) : ansi.bold.red(str));
-    keys.forEach((k) => printKey(k, operation === 'deleted'));
-    const shouldContinue = await askBoolean('Does this look correct?', true);
-    if (!shouldContinue) {
-        exitWithError('Aborting.');
-    }
-}
-const syncHandler = (config) => async function () {
-    const opts = this.optsWithGlobals();
-    const rawKeys = await loading('Analyzing code...', extractKeysOfFiles(opts));
-    const warnCount = dumpWarnings(rawKeys);
-    if (!opts.continueOnWarning && warnCount) {
-        console.log(ansi.bold.red('Aborting as warnings have been emitted.'));
-        process.exit(1);
-    }
-    const localKeys = filterExtractionResult(rawKeys);
-    const allKeysLoadable = await opts.client.GET('/v2/projects/{projectId}/all-keys', {
-        params: { path: { projectId: opts.client.getProjectId() } },
-    });
-    handleLoadableError(allKeysLoadable);
-    const remoteKeys = allKeysLoadable.data?._embedded?.keys ?? [];
-    const diff = compareKeys(localKeys, remoteKeys);
-    if (!diff.added.length && !diff.removed.length) {
-        console.log(ansi.green('Your code project is in sync with the associated Tolgee project!'));
-        process.exit(0);
-    }
-    // Load project settings. We're interested in the default locale here.
-    const projectLoadable = await opts.client.GET('/v2/projects/{projectId}', {
-        params: { path: { projectId: opts.client.getProjectId() } },
+function askForConfirmation(keys, operation) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!process.stdout.isTTY) {
+            exitWithError('You must run this command interactively, or specify --yes to proceed.');
+        }
+        const str = `The following keys will be ${operation}:`;
+        console.log(operation === 'created' ? ansi.bold.green(str) : ansi.bold.red(str));
+        keys.forEach((k) => printKey(k, operation === 'deleted'));
+        const shouldContinue = yield askBoolean('Does this look correct?', true);
+        if (!shouldContinue) {
+            exitWithError('Aborting.');
+        }
     });
-    handleLoadableError(projectLoadable);
-    const baseLanguage = projectLoadable.data.baseLanguage;
-    if (!baseLanguage) {
-        // I'm highly unsure how we could reach this state, but this is what the OAI spec tells me ¯\_(ツ)_/¯
-        exitWithError('Your project does not have a base language!');
-    }
-    // Prepare backup
-    if (opts.backup) {
-        await prepareDir(opts.backup, opts.yes);
-        await loading('Backing up Tolgee project', backup(opts.client, opts.backup));
-    }
-    // Create new keys
-    if (diff.added.length) {
-        if (!opts.yes) {
-            await askForConfirmation(diff.added, 'created');
+}
+const syncHandler = (config) => function () {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b, _c;
+        const opts = this.optsWithGlobals();
+        const rawKeys = yield loading('Analyzing code...', extractKeysOfFiles(opts));
+        const warnCount = dumpWarnings(rawKeys);
+        if (!opts.continueOnWarning && warnCount) {
+            console.log(ansi.bold.red('Aborting as warnings have been emitted.'));
+            process.exit(1);
         }
-        const keys = diff.added.map((key) => ({
-            name: key.keyName,
-            namespace: key.namespace,
-            translations: key.defaultValue
-                ? { [baseLanguage.tag]: key.defaultValue }
-                : {},
-            tags: opts.tagNewKeys,
-        }));
-        const loadable = await loading('Creating missing keys...', opts.client.POST('/v2/projects/{projectId}/keys/import', {
+        const localKeys = filterExtractionResult(rawKeys);
+        const allKeysLoadable = yield opts.client.GET('/v2/projects/{projectId}/all-keys', {
             params: { path: { projectId: opts.client.getProjectId() } },
-            body: { keys },
-        }));
-        handleLoadableError(loadable);
-    }
-    if (opts.removeUnused) {
-        // Delete unused keys.
-        if (diff.removed.length) {
+        });
+        handleLoadableError(allKeysLoadable);
+        const remoteKeys = (_c = (_b = (_a = allKeysLoadable.data) === null || _a === void 0 ? void 0 : _a._embedded) === null || _b === void 0 ? void 0 : _b.keys) !== null && _c !== void 0 ? _c : [];
+        const diff = compareKeys(localKeys, remoteKeys);
+        if (!diff.added.length && !diff.removed.length) {
+            console.log(ansi.green('Your code project is in sync with the associated Tolgee project!'));
+            process.exit(0);
+        }
+        // Load project settings. We're interested in the default locale here.
+        const projectLoadable = yield opts.client.GET('/v2/projects/{projectId}', {
+            params: { path: { projectId: opts.client.getProjectId() } },
+        });
+        handleLoadableError(projectLoadable);
+        const baseLanguage = projectLoadable.data.baseLanguage;
+        if (!baseLanguage) {
+            // I'm highly unsure how we could reach this state, but this is what the OAI spec tells me ¯\_(ツ)_/¯
+            exitWithError('Your project does not have a base language!');
+        }
+        // Prepare backup
+        if (opts.backup) {
+            yield prepareDir(opts.backup, opts.yes);
+            yield loading('Backing up Tolgee project', backup(opts.client, opts.backup));
+        }
+        // Create new keys
+        if (diff.added.length) {
             if (!opts.yes) {
-                await askForConfirmation(diff.removed, 'deleted');
+                yield askForConfirmation(diff.added, 'created');
             }
-            const ids = await diff.removed.map((k) => k.id);
-            const loadable = await loading('Deleting unused keys...', opts.client.DELETE('/v2/projects/{projectId}/keys', {
+            const keys = diff.added.map((key) => ({
+                name: key.keyName,
+                namespace: key.namespace,
+                translations: key.defaultValue
+                    ? { [baseLanguage.tag]: key.defaultValue }
+                    : {},
+                tags: opts.tagNewKeys,
+            }));
+            const loadable = yield loading('Creating missing keys...', opts.client.POST('/v2/projects/{projectId}/keys/import', {
                 params: { path: { projectId: opts.client.getProjectId() } },
-                body: { ids },
+                body: { keys },
             }));
             handleLoadableError(loadable);
         }
-    }
-    console.log(ansi.bold.green('Sync complete!'));
-    console.log(ansi.green(`+ ${diff.added.length} string${diff.added.length === 1 ? '' : 's'}`));
-    if (opts.removeUnused) {
-        console.log(ansi.red(`- ${diff.removed.length} string${diff.removed.length === 1 ? '' : 's'}`));
-    }
-    else {
-        console.log(ansi.italic(`${diff.removed.length} unused key${diff.removed.length === 1 ? '' : 's'} could be deleted.`));
-    }
-    if (opts.backup) {
-        console.log(ansi.blueBright(`A backup of the project prior to the synchronization has been dumped in ${opts.backup}.`));
-    }
+        if (opts.removeUnused) {
+            // Delete unused keys.
+            if (diff.removed.length) {
+                if (!opts.yes) {
+                    yield askForConfirmation(diff.removed, 'deleted');
+                }
+                const ids = yield diff.removed.map((k) => k.id);
+                const loadable = yield loading('Deleting unused keys...', opts.client.DELETE('/v2/projects/{projectId}/keys', {
+                    params: { path: { projectId: opts.client.getProjectId() } },
+                    body: { ids },
+                }));
+                handleLoadableError(loadable);
+            }
+        }
+        console.log(ansi.bold.green('Sync complete!'));
+        console.log(ansi.green(`+ ${diff.added.length} string${diff.added.length === 1 ? '' : 's'}`));
+        if (opts.removeUnused) {
+            console.log(ansi.red(`- ${diff.removed.length} string${diff.removed.length === 1 ? '' : 's'}`));
+        }
+        else {
+            console.log(ansi.italic(`${diff.removed.length} unused key${diff.removed.length === 1 ? '' : 's'} could be deleted.`));
+        }
+        if (opts.backup) {
+            console.log(ansi.blueBright(`A backup of the project prior to the synchronization has been dumped in ${opts.backup}.`));
+        }
+    });
+};
+export default (config) => {
+    var _a, _b, _c, _d, _e, _f;
+    return new Command()
+        .name('sync')
+        .description('Synchronizes the keys in your code project and in the Tolgee project, by creating missing keys and optionally deleting unused ones. For a dry-run, use `tolgee compare`.')
+        .addOption(new Option('-B, --backup <path>', 'Store translation files backup (only translation files, not states, comments, tags, etc.). If something goes wrong, the backup can be used to restore the project to its previous state.').default((_b = (_a = config.sync) === null || _a === void 0 ? void 0 : _a.backup) !== null && _b !== void 0 ? _b : false))
+        .addOption(new Option('--continue-on-warning', 'Set this flag to continue the sync if warnings are detected during string extraction. By default, as warnings may indicate an invalid extraction, the CLI will abort the sync.').default((_d = (_c = config.sync) === null || _c === void 0 ? void 0 : _c.continueOnWarning) !== null && _d !== void 0 ? _d : false))
+        .addOption(new Option('-Y, --yes', 'Skip prompts and automatically say yes to them. You will not be asked for confirmation before creating/deleting keys.').default(false))
+        .addOption(new Option('--remove-unused', 'Delete unused keys from the Tolgee project.').default((_f = (_e = config.sync) === null || _e === void 0 ? void 0 : _e.removeUnused) !== null && _f !== void 0 ? _f : false))
+        .option('--tag-new-keys <tags...>', 'Specify tags that will be added to newly created keys.')
+        .action(syncHandler(config));
 };
-export default (config) => new Command()
-    .name('sync')
-    .description('Synchronizes the keys in your code project and in the Tolgee project, by creating missing keys and optionally deleting unused ones. For a dry-run, use `tolgee compare`.')
-    .addOption(new Option('-B, --backup <path>', 'Store translation files backup (only translation files, not states, comments, tags, etc.). If something goes wrong, the backup can be used to restore the project to its previous state.').default(config.sync?.backup ?? false))
-    .addOption(new Option('--continue-on-warning', 'Set this flag to continue the sync if warnings are detected during string extraction. By default, as warnings may indicate an invalid extraction, the CLI will abort the sync.').default(config.sync?.continueOnWarning ?? false))
-    .addOption(new Option('-Y, --yes', 'Skip prompts and automatically say yes to them. You will not be asked for confirmation before creating/deleting keys.').default(false))
-    .addOption(new Option('--remove-unused', 'Delete unused keys from the Tolgee project.').default(config.sync?.removeUnused ?? false))
-    .option('--tag-new-keys <tags...>', 'Specify tags that will be added to newly created keys.')
-    .action(syncHandler(config));

package/dist/commands/sync/syncUtils.js

@@ -26,11 +26,12 @@ export function printKey(key, deletion) {
  * @returns A list of added and removed keys.
  */
 export function compareKeys(local, remote) {
+    var _a;
     const result = { added: [], removed: [] };
     // Deleted keys
     for (const remoteKey of remote) {
         const namespace = remoteKey.namespace || NullNamespace;
-        const keyExists = local[namespace]?.delete(remoteKey.name);
+        const keyExists = (_a = local[namespace]) === null || _a === void 0 ? void 0 : _a.delete(remoteKey.name);
         if (!keyExists) {
             result.removed.push({
                 id: remoteKey.id,

package/dist/commands/tag.js

@@ -1,45 +1,59 @@
+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 { Command, Option } from 'commander';
 import { handleLoadableError } from '../client/TolgeeClient.js';
 import { exitWithError, loading, success } from '../utils/logger.js';
 import { extractKeysOfFiles } from '../extractor/runner.js';
-const tagHandler = (config) => async function () {
-    const opts = this.optsWithGlobals();
-    let extractedKeys;
-    if (opts.filterExtracted || opts.filterNotExtracted) {
-        if (opts.filterExtracted && opts.filterNotExtracted) {
-            exitWithError('Use either "--filter-extracted" or "--filter-not-extracted", not both');
+const tagHandler = (config) => function () {
+    return __awaiter(this, void 0, void 0, function* () {
+        const opts = this.optsWithGlobals();
+        let extractedKeys;
+        if (opts.filterExtracted || opts.filterNotExtracted) {
+            if (opts.filterExtracted && opts.filterNotExtracted) {
+                exitWithError('Use either "--filter-extracted" or "--filter-not-extracted", not both');
+            }
+            const extracted = yield loading('Analyzing code...', extractKeysOfFiles(opts));
+            const keys = [...extracted.values()].flatMap((item) => item.keys);
+            extractedKeys = keys.map((key) => ({
+                name: key.keyName,
+                namespace: key.namespace,
+            }));
         }
-        const extracted = await loading('Analyzing code...', extractKeysOfFiles(opts));
-        const keys = [...extracted.values()].flatMap((item) => item.keys);
-        extractedKeys = keys.map((key) => ({
-            name: key.keyName,
-            namespace: key.namespace,
+        const loadable = yield loading('Tagging...', opts.client.PUT('/v2/projects/{projectId}/tag-complex', {
+            params: { path: { projectId: opts.client.getProjectId() } },
+            body: {
+                filterTag: opts.filterTag,
+                filterTagNot: opts.filterNoTag,
+                tagFiltered: opts.tag,
+                tagOther: opts.tagOther,
+                untagFiltered: opts.untag,
+                untagOther: opts.untagOther,
+                filterKeys: opts.filterExtracted ? extractedKeys : undefined,
+                filterKeysNot: opts.filterNotExtracted ? extractedKeys : undefined,
+            },
         }));
-    }
-    const loadable = await loading('Tagging...', opts.client.PUT('/v2/projects/{projectId}/tag-complex', {
-        params: { path: { projectId: opts.client.getProjectId() } },
-        body: {
-            filterTag: opts.filterTag,
-            filterTagNot: opts.filterNoTag,
-            tagFiltered: opts.tag,
-            tagOther: opts.tagOther,
-            untagFiltered: opts.untag,
-            untagOther: opts.untagOther,
-            filterKeys: opts.filterExtracted ? extractedKeys : undefined,
-            filterKeysNot: opts.filterNotExtracted ? extractedKeys : undefined,
-        },
-    }));
-    handleLoadableError(loadable);
-    success('Done!');
+        handleLoadableError(loadable);
+        success('Done!');
+    });
+};
+export default (config) => {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    return new Command('tag')
+        .description('Update tags in your project.')
+        .addOption(new Option('--filter-extracted', 'Extract keys from code and filter by it.').default((_a = config.tag) === null || _a === void 0 ? void 0 : _a.filterExtracted))
+        .addOption(new Option('--filter-not-extracted', 'Extract keys from code and filter them out.').default((_b = config.tag) === null || _b === void 0 ? void 0 : _b.filterNotExtracted))
+        .addOption(new Option('--filter-tag <tags...>', 'Filter only keys with tag. Use * as a wildcard.').default((_c = config.tag) === null || _c === void 0 ? void 0 : _c.filterTag))
+        .addOption(new Option('--filter-no-tag <tags...>', 'Filter only keys without tag. Use * as a wildcard.').default((_d = config.tag) === null || _d === void 0 ? void 0 : _d.filterNoTag))
+        .addOption(new Option('--tag <tags...>', 'Add tag to filtered keys.').default((_e = config.tag) === null || _e === void 0 ? void 0 : _e.tag))
+        .addOption(new Option('--tag-other <tags...>', 'Tag keys which are not filtered.').default((_f = config.tag) === null || _f === void 0 ? void 0 : _f.tagOther))
+        .addOption(new Option('--untag <tags...>', 'Remove tag from filtered keys. Use * as a wildcard.').default((_g = config.tag) === null || _g === void 0 ? void 0 : _g.untag))
+        .addOption(new Option('--untag-other <tags...>', 'Remove tag from keys which are not filtered. Use * as a wildcard.').default((_h = config.tag) === null || _h === void 0 ? void 0 : _h.untagOther))
+        .action(tagHandler(config));
 };
-export default (config) => new Command('tag')
-    .description('Update tags in your project.')
-    .addOption(new Option('--filter-extracted', 'Extract keys from code and filter by it.').default(config.tag?.filterExtracted))
-    .addOption(new Option('--filter-not-extracted', 'Extract keys from code and filter them out.').default(config.tag?.filterNotExtracted))
-    .addOption(new Option('--filter-tag <tags...>', 'Filter only keys with tag. Use * as a wildcard.').default(config.tag?.filterTag))
-    .addOption(new Option('--filter-no-tag <tags...>', 'Filter only keys without tag. Use * as a wildcard.').default(config.tag?.filterNoTag))
-    .addOption(new Option('--tag <tags...>', 'Add tag to filtered keys.').default(config.tag?.tag))
-    .addOption(new Option('--tag-other <tags...>', 'Tag keys which are not filtered.').default(config.tag?.tagOther))
-    .addOption(new Option('--untag <tags...>', 'Remove tag from filtered keys. Use * as a wildcard.').default(config.tag?.untag))
-    .addOption(new Option('--untag-other <tags...>', 'Remove tag from keys which are not filtered. Use * as a wildcard.').default(config.tag?.untagOther))
-    .action(tagHandler(config));