@tolgee/cli 1.1.0 → 1.1.2

package/README.md

@@ -1,22 +1,25 @@
 # Tolgee CLI 🐁
 
-An experimental 🧪 command line tool to interact with Tolgee directly from your terminal.
+A CLI tool to interact with Tolgee directly from your terminal.
 
-The CLI lets you pull strings from the Tolgee platform into your projects, push local strings to the Tolgee platform,
+The Tolgee CLI lets you pull strings from the Tolgee platform into your projects, push local strings to the Tolgee platform,
 extract strings from your code, and much more!
 
-- Pull requests welcome! 🤩
+![Tolgee CLI screenshot](tolgee-cli-screenshot.png)
 
 ## Installation
 The Tolgee CLI is published as a NPM package. You simply need to install it, and you're good to go!
+
 ```sh
+# npm
 npm i --global @tolgee/cli
-```
 
-> **Warning**: The Tolgee CLI is currently experimental and subject to bugs. Breaking changes may happen before stable release!
->
-> Help us reach stable version faster by reporting any bug you encounter on the [issue tracker](https://github.com/tolgee/tolgee-cli/issues/new?labels=bug).
-> Feedback is also greatly appreciated!
+# Yarn
+yarn global add @tolgee/cli
+
+# pnpm
+pnpm add --global @tolgee/cli
+```
 
 See our [documentation](https://tolgee.io/tolgee-cli/installation) for more information.
 

package/dist/client/errors.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpError = void 0;
-class HttpError extends Error {
+export class HttpError extends Error {
     request;
     response;
     constructor(request, response, options) {
@@ -33,4 +30,3 @@ class HttpError extends Error {
         return `Unknown error (HTTP ${this.response.status})`;
     }
 }
-exports.HttpError = HttpError;

package/dist/client/export.js

@@ -1,6 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class ExportClient {
+export default class ExportClient {
     requester;
     constructor(requester) {
         this.requester = requester;
@@ -20,4 +18,3 @@ class ExportClient {
         });
     }
 }
-exports.default = ExportClient;

package/dist/client/import.js

@@ -1,17 +1,12 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const form_data_1 = __importDefault(require("form-data"));
-const errors_1 = require("./errors");
-class ImportClient {
+import FormData from 'form-data';
+import { HttpError } from './errors.js';
+export default class ImportClient {
     requester;
     constructor(requester) {
         this.requester = requester;
     }
     async addFiles(req) {
-        const body = new form_data_1.default();
+        const body = new FormData();
         for (const file of req.files) {
             body.append('files', file.data, { filepath: file.name });
         }
@@ -52,10 +47,9 @@ class ImportClient {
             await this.deleteImport();
         }
         catch (e) {
-            if (e instanceof errors_1.HttpError && e.response.status === 404)
+            if (e instanceof HttpError && e.response.status === 404)
                 return;
             throw e;
         }
     }
 }
-exports.default = ImportClient;

package/dist/client/index.js

@@ -1,16 +1,11 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const base32_decode_1 = __importDefault(require("base32-decode"));
-const requester_1 = __importDefault(require("./internal/requester"));
-const project_1 = __importDefault(require("./project"));
-const languages_1 = __importDefault(require("./languages"));
-const import_1 = __importDefault(require("./import"));
-const export_1 = __importDefault(require("./export"));
-const constants_1 = require("../constants");
-class RestClient {
+import base32Decode from 'base32-decode';
+import Requester from './internal/requester.js';
+import ProjectClient from './project.js';
+import LanguagesClient from './languages.js';
+import ImportClient from './import.js';
+import ExportClient from './export.js';
+import { API_KEY_PAK_PREFIX } from '../constants.js';
+export default class RestClient {
     params;
     requester;
     project;
@@ -19,11 +14,11 @@ class RestClient {
     export;
     constructor(params) {
         this.params = params;
-        this.requester = new requester_1.default(params);
-        this.project = new project_1.default(this.requester);
-        this.languages = new languages_1.default(this.requester);
-        this.import = new import_1.default(this.requester);
-        this.export = new export_1.default(this.requester);
+        this.requester = new Requester(params);
+        this.project = new ProjectClient(this.requester);
+        this.languages = new LanguagesClient(this.requester);
+        this.import = new ImportClient(this.requester);
+        this.export = new ExportClient(this.requester);
     }
     async getProjectApiKeyInformation() {
         return this.requester.requestJson({
@@ -35,24 +30,24 @@ class RestClient {
         return this.params.projectId;
     }
     static projectIdFromKey(key) {
-        const keyBuffer = (0, base32_decode_1.default)(key.slice(constants_1.API_KEY_PAK_PREFIX.length).toUpperCase(), 'RFC4648');
+        const keyBuffer = base32Decode(key.slice(API_KEY_PAK_PREFIX.length).toUpperCase(), 'RFC4648');
         const decoded = Buffer.from(keyBuffer).toString('utf8');
         return Number(decoded.split('_')[0]);
     }
     static getProjectApiKeyInformation(api, key) {
-        return new requester_1.default({ apiUrl: api, apiKey: key }).requestJson({
+        return new Requester({ apiUrl: api, apiKey: key }).requestJson({
             path: '/v2/api-keys/current',
             method: 'GET',
         });
     }
     static getPersonalAccessTokenInformation(api, key) {
-        return new requester_1.default({ apiUrl: api, apiKey: key }).requestJson({
+        return new Requester({ apiUrl: api, apiKey: key }).requestJson({
             path: '/v2/pats/current',
             method: 'GET',
         });
     }
     static async getApiKeyInformation(api, key) {
-        if (key.startsWith(constants_1.API_KEY_PAK_PREFIX)) {
+        if (key.startsWith(API_KEY_PAK_PREFIX)) {
             const info = await RestClient.getProjectApiKeyInformation(api, key);
             const username = info.userFullName || info.username || '<unknown user>';
             return {
@@ -76,4 +71,3 @@ class RestClient {
         };
     }
 }
-exports.default = RestClient;

package/dist/client/internal/requester.js

@@ -1,15 +1,10 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const undici_1 = require("undici");
-const undici_2 = require("undici");
-const form_data_1 = __importDefault(require("form-data"));
-const errors_1 = require("../errors");
-const logger_1 = require("../../utils/logger");
-const constants_1 = require("../../constants");
-class Requester {
+import { Request } from 'undici';
+import { fetch } from 'undici';
+import FormData from 'form-data';
+import { HttpError } from '../errors.js';
+import { debug } from '../../utils/logger.js';
+import { USER_AGENT } from '../../constants.js';
+export default class Requester {
     params;
     constructor(params) {
         this.params = params;
@@ -44,12 +39,12 @@ class Requester {
         }
         const headers = {
             ...(req.headers || {}),
-            'user-agent': constants_1.USER_AGENT,
+            'user-agent': USER_AGENT,
             'x-api-key': this.params.apiKey,
         };
         let body = undefined;
         if (req.body) {
-            if (req.body instanceof form_data_1.default) {
+            if (req.body instanceof FormData) {
                 const header = `multipart/form-data; boundary=${req.body.getBoundary()}`;
                 headers['content-type'] = header;
                 body = req.body.getBuffer();
@@ -59,16 +54,16 @@ class Requester {
                 body = JSON.stringify(req.body);
             }
         }
-        const request = new undici_1.Request(url, {
+        const request = new Request(url, {
             method: req.method,
             headers: headers,
             body: body,
         });
-        (0, logger_1.debug)(`[HTTP] Requesting: ${request.method} ${request.url}`);
-        const response = await (0, undici_2.fetch)(request);
-        (0, logger_1.debug)(`[HTTP] ${request.method} ${request.url} -> ${response.status} ${response.statusText}`);
+        debug(`[HTTP] Requesting: ${request.method} ${request.url}`);
+        const response = await fetch(request);
+        debug(`[HTTP] ${request.method} ${request.url} -> ${response.status} ${response.statusText}`);
         if (!response.ok)
-            throw new errors_1.HttpError(request, response);
+            throw new HttpError(request, response);
         return response;
     }
     /**
@@ -142,4 +137,3 @@ class Requester {
         return view;
     }
 }
-exports.default = Requester;

package/dist/client/internal/schema.generated.js

@@ -1,6 +1,5 @@
-"use strict";
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/dist/client/internal/schema.utils.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/dist/client/languages.js

@@ -1,6 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class LanguagesClient {
+export default class LanguagesClient {
     requester;
     constructor(requester) {
         this.requester = requester;
@@ -13,4 +11,3 @@ class LanguagesClient {
         });
     }
 }
-exports.default = LanguagesClient;

package/dist/client/project.js

@@ -1,6 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class ProjectClient {
+export default class ProjectClient {
     requester;
     constructor(requester) {
         this.requester = requester;
@@ -41,4 +39,3 @@ class ProjectClient {
         });
     }
 }
-exports.default = ProjectClient;

package/dist/commands/extract/check.js

@@ -1,30 +1,28 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = require("path");
-const commander_1 = require("commander");
-const runner_1 = require("../../extractor/runner");
-const warnings_1 = require("../../extractor/warnings");
-const logger_1 = require("../../utils/logger");
+import { relative } from 'path';
+import { Command } from 'commander';
+import { extractKeysOfFiles } from '../../extractor/runner.js';
+import { WarningMessages, emitGitHubWarning, } from '../../extractor/warnings.js';
+import { loading } from '../../utils/logger.js';
 async function lintHandler(filesPattern) {
     const opts = this.optsWithGlobals();
-    const extracted = await (0, logger_1.loading)('Analyzing code...', (0, runner_1.extractKeysOfFiles)(filesPattern, opts.extractor));
+    const extracted = await loading('Analyzing code...', extractKeysOfFiles(filesPattern, opts.extractor));
     let warningCount = 0;
     let filesCount = 0;
     for (const [file, { warnings }] of extracted) {
         if (warnings.length) {
             warningCount += warnings.length;
             filesCount++;
-            const relFile = (0, path_1.relative)(process.cwd(), file);
+            const relFile = relative(process.cwd(), file);
             console.log('%s:', relFile);
             for (const warning of warnings) {
-                if (warning.warning in warnings_1.WarningMessages) {
-                    const { name } = warnings_1.WarningMessages[warning.warning];
+                if (warning.warning in WarningMessages) {
+                    const { name } = WarningMessages[warning.warning];
                     console.log('\tline %d: %s', warning.line, name);
                 }
                 else {
                     console.log('\tline %d: %s', warning.line, warning.warning);
                 }
-                (0, warnings_1.emitGitHubWarning)(warning.warning, file, warning.line);
+                emitGitHubWarning(warning.warning, file, warning.line);
             }
         }
     }
@@ -35,7 +33,7 @@ async function lintHandler(filesPattern) {
     }
     console.log('No issues found.');
 }
-exports.default = new commander_1.Command('check')
+export default new Command('check')
     .description('Checks if the keys can be extracted automatically, and reports problems if any')
     .argument('<pattern>', 'File pattern to include (hint: make sure to escape it in quotes, or your shell might attempt to unroll some tokens like *)')
     .action(lintHandler);

package/dist/commands/extract/print.js

@@ -1,18 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = require("path");
-const commander_1 = require("commander");
-const runner_1 = require("../../extractor/runner");
-const warnings_1 = require("../../extractor/warnings");
-const logger_1 = require("../../utils/logger");
+import { relative } from 'path';
+import { Command } from 'commander';
+import { extractKeysOfFiles } from '../../extractor/runner.js';
+import { WarningMessages } from '../../extractor/warnings.js';
+import { loading } from '../../utils/logger.js';
 async function printHandler(filesPattern) {
     const opts = this.optsWithGlobals();
-    const extracted = await (0, logger_1.loading)('Analyzing code...', (0, runner_1.extractKeysOfFiles)(filesPattern, opts.extractor));
+    const extracted = await loading('Analyzing code...', extractKeysOfFiles(filesPattern, opts.extractor));
     let warningCount = 0;
     const keySet = new Set();
     for (const [file, { keys, warnings }] of extracted) {
         if (keys.length) {
-            const relFile = (0, path_1.relative)(process.cwd(), file);
+            const relFile = relative(process.cwd(), file);
             console.log('%d key%s found in %s:', keys.length, keys.length !== 1 ? 's' : '', relFile);
             for (const key of keys) {
                 keySet.add(key);
@@ -29,8 +27,8 @@ async function printHandler(filesPattern) {
             warningCount += warnings.length;
             console.log('%d warning%s %s emitted during extraction:', warnings.length, warnings.length !== 1 ? 's' : '', warnings.length !== 1 ? 'were' : 'was');
             for (const warning of warnings) {
-                if (warning.warning in warnings_1.WarningMessages) {
-                    const { name } = warnings_1.WarningMessages[warning.warning];
+                if (warning.warning in WarningMessages) {
+                    const { name } = WarningMessages[warning.warning];
                     console.log('\tline %d: %s', warning.line, name);
                 }
                 else {
@@ -45,7 +43,7 @@ async function printHandler(filesPattern) {
     console.log('Total unique keys found: %d', keySet.size);
     console.log('Total warnings: %d', warningCount);
 }
-exports.default = new commander_1.Command('print')
+export default new Command('print')
     .description('Prints extracted data to the console')
     .argument('<pattern>', 'File glob pattern to include (hint: make sure to escape it in quotes, or your shell might attempt to unroll some tokens like *)')
     .action(printHandler);

package/dist/commands/extract.js

@@ -1,14 +1,9 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const print_1 = __importDefault(require("./extract/print"));
-const check_1 = __importDefault(require("./extract/check"));
-const options_1 = require("../options");
-exports.default = new commander_1.Command('extract')
+import { Command } from 'commander';
+import extractPrint from './extract/print.js';
+import extractCheck from './extract/check.js';
+import { EXTRACTOR } from '../options.js';
+export default new Command('extract')
     .description('Extracts strings from your projects')
-    .addOption(options_1.EXTRACTOR)
-    .addCommand(print_1.default)
-    .addCommand(check_1.default);
+    .addOption(EXTRACTOR)
+    .addCommand(extractPrint)
+    .addCommand(extractCheck);

package/dist/commands/login.js

@@ -1,48 +1,42 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Logout = exports.Login = void 0;
-const commander_1 = require("commander");
-const client_1 = __importDefault(require("../client"));
-const errors_1 = require("../client/errors");
-const credentials_1 = require("../config/credentials");
-const logger_1 = require("../utils/logger");
+import { Command } from 'commander';
+import RestClient from '../client/index.js';
+import { HttpError } from '../client/errors.js';
+import { saveApiKey, removeApiKeys, clearAuthStore, } from '../config/credentials.js';
+import { success, error } from '../utils/logger.js';
 async function loginHandler(key) {
     const opts = this.optsWithGlobals();
     let keyInfo;
     try {
-        keyInfo = await client_1.default.getApiKeyInformation(opts.apiUrl, key);
+        keyInfo = await RestClient.getApiKeyInformation(opts.apiUrl, key);
     }
     catch (e) {
-        if (e instanceof errors_1.HttpError && e.response.status === 403) {
-            (0, logger_1.error)("Couldn't log in: the API key you provided is invalid.");
+        if (e instanceof HttpError && e.response.status === 403) {
+            error("Couldn't log in: the API key you provided is invalid.");
             process.exit(1);
         }
         throw e;
     }
-    await (0, credentials_1.saveApiKey)(opts.apiUrl, keyInfo);
-    (0, logger_1.success)(keyInfo.type === 'PAK'
+    await saveApiKey(opts.apiUrl, keyInfo);
+    success(keyInfo.type === 'PAK'
         ? `Logged in as ${keyInfo.username} on ${opts.apiUrl.hostname} for project ${keyInfo.project.name} (#${keyInfo.project.id}). Welcome back!`
         : `Logged in as ${keyInfo.username} on ${opts.apiUrl.hostname}. Welcome back!`);
 }
 async function logoutHandler() {
     const opts = this.optsWithGlobals();
     if (opts.all) {
-        await (0, credentials_1.clearAuthStore)();
-        (0, logger_1.success)("You've been logged out of all Tolgee instances you were logged in.");
+        await clearAuthStore();
+        success("You've been logged out of all Tolgee instances you were logged in.");
         return;
     }
-    await (0, credentials_1.removeApiKeys)(opts.apiUrl);
-    (0, logger_1.success)(`You're now logged out of ${opts.apiUrl.hostname}.`);
+    await removeApiKeys(opts.apiUrl);
+    success(`You're now logged out of ${opts.apiUrl.hostname}.`);
 }
-exports.Login = new commander_1.Command()
+export const Login = new Command()
     .name('login')
     .description('Login to Tolgee with an API key. You can be logged into multiple Tolgee instances at the same time by using --api-url')
     .argument('<API Key>', 'The API key. Can be either a personal access token, or a project key')
     .action(loginHandler);
-exports.Logout = new commander_1.Command()
+export const Logout = new Command()
     .name('logout')
     .description('Logs out of Tolgee')
     .option('--all', "Log out of *ALL* Tolgee instances you're logged into")

package/dist/commands/pull.js

@@ -1,9 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const zip_1 = require("../utils/zip");
-const overwriteDir_1 = require("../utils/overwriteDir");
-const logger_1 = require("../utils/logger");
+import { Command, Option } from 'commander';
+import { unzipBuffer } from '../utils/zip.js';
+import { overwriteDir } from '../utils/overwriteDir.js';
+import { loading, success } from '../utils/logger.js';
 async function fetchZipBlob(opts) {
     return opts.client.export.export({
         format: opts.format,
@@ -14,24 +12,24 @@ async function fetchZipBlob(opts) {
 }
 async function pullHandler(path) {
     const opts = this.optsWithGlobals();
-    await (0, overwriteDir_1.overwriteDir)(path, opts.overwrite);
-    const zipBlob = await (0, logger_1.loading)('Fetching strings from Tolgee...', fetchZipBlob(opts));
-    await (0, logger_1.loading)('Extracting strings...', (0, zip_1.unzipBuffer)(zipBlob, path));
-    (0, logger_1.success)('Done!');
+    await overwriteDir(path, opts.overwrite);
+    const zipBlob = await loading('Fetching strings from Tolgee...', fetchZipBlob(opts));
+    await loading('Extracting strings...', unzipBuffer(zipBlob, path));
+    success('Done!');
 }
-exports.default = new commander_1.Command()
+export default new Command()
     .name('pull')
     .description('Pulls translations to Tolgee')
     .argument('<path>', 'Destination path where translation files will be stored in')
-    .addOption(new commander_1.Option('-f, --format <format>', 'Format of the exported files')
+    .addOption(new Option('-f, --format <format>', 'Format of the exported files')
     .choices(['JSON', 'XLIFF'])
     .default('JSON')
     .argParser((v) => v.toUpperCase()))
     .option('-l, --languages <languages...>', 'List of languages to pull. Leave unspecified to export them all')
-    .addOption(new commander_1.Option('-s, --states <states...>', 'List of translation states to include. Defaults all except untranslated')
+    .addOption(new Option('-s, --states <states...>', 'List of translation states to include. Defaults all except untranslated')
     .choices(['UNTRANSLATED', 'TRANSLATED', 'REVIEWED'])
     .argParser((v, a) => [v.toUpperCase(), ...(a || [])]))
-    .addOption(new commander_1.Option('-d, --delimiter', 'Structure delimiter to use. By default, Tolgee interprets `.` as a nested structure. You can change the delimiter, or disable structure formatting by not specifying any value to the option')
+    .addOption(new Option('-d, --delimiter', 'Structure delimiter to use. By default, Tolgee interprets `.` as a nested structure. You can change the delimiter, or disable structure formatting by not specifying any value to the option')
     .default('.')
     .argParser((v) => v || ''))
     .option('-o, --overwrite', 'Whether to automatically overwrite existing files. BE CAREFUL, THIS WILL WIPE *ALL* THE CONTENTS OF THE TARGET FOLDER. If unspecified, the user will be prompted interactively, or the command will fail when in non-interactive')