@tolgee/cli 1.0.0 → 1.0.2

package/dist/commands/sync/compare.js

@@ -23,17 +23,19 @@ async function compareHandler(pattern) {
     }
     console.log('Your code project and Tolgee project are out of sync.');
     if (diff.added.length) {
-        console.log(ansi_colors_1.default.green.bold(`${diff.added.length} new strings`));
+        const key = diff.added.length === 1 ? 'key' : 'keys';
+        console.log(ansi_colors_1.default.green.bold(`${diff.added.length} new ${key} found`));
         for (const key of diff.added) {
-            (0, syncUtils_1.printKey)(key, 'added');
+            (0, syncUtils_1.printKey)(key, false);
         }
         // Line break
         console.log('');
     }
     if (diff.removed.length) {
-        console.log(ansi_colors_1.default.red.bold(`${diff.removed.length} removed strings`));
+        const key = diff.removed.length === 1 ? 'key' : 'keys';
+        console.log(ansi_colors_1.default.red.bold(`${diff.removed.length} unused ${key}`));
         for (const key of diff.removed) {
-            (0, syncUtils_1.printKey)(key, 'removed');
+            (0, syncUtils_1.printKey)(key, true);
         }
         // Line break
         console.log('');

package/dist/commands/sync/sync.js

@@ -27,8 +27,8 @@ async function askForConfirmation(keys, operation) {
         process.exit(1);
     }
     const str = `The following keys will be ${operation}:`;
-    console.log(operation === 'added' ? ansi_colors_1.default.bold.green(str) : ansi_colors_1.default.bold.red(str));
-    keys.forEach((k) => (0, syncUtils_1.printKey)(k, operation));
+    console.log(operation === 'created' ? ansi_colors_1.default.bold.green(str) : ansi_colors_1.default.bold.red(str));
+    keys.forEach((k) => (0, syncUtils_1.printKey)(k, operation === 'deleted'));
     const shouldContinue = await (0, ask_1.askBoolean)('Does this look correct?', true);
     if (!shouldContinue) {
         (0, logger_1.error)('Aborting.');
@@ -65,7 +65,7 @@ async function syncHandler(pattern) {
     // Create new keys
     if (diff.added.length) {
         if (!opts.yes) {
-            await askForConfirmation(diff.added, 'added');
+            await askForConfirmation(diff.added, 'created');
         }
         const keys = diff.added.map((key) => ({
             name: key.keyName,
@@ -80,7 +80,7 @@ async function syncHandler(pattern) {
         // Delete unused keys.
         if (diff.removed.length) {
             if (!opts.yes) {
-                await askForConfirmation(diff.removed, 'removed');
+                await askForConfirmation(diff.removed, 'deleted');
             }
             const ids = await diff.removed.map((k) => k.id);
             await (0, logger_1.loading)('Deleting unused keys...', opts.client.project.deleteBulkKeys(ids));

package/dist/commands/sync/syncUtils.js

@@ -10,17 +10,17 @@ const ansi_colors_1 = __importDefault(require("ansi-colors"));
  * Prints information about a key, with coloring and formatting.
  *
  * @param key The key to print.
- * @param type Whether this is an addition or a removal.
+ * @param deletion True if the key is about to be deleted.
  */
-function printKey(key, type) {
+function printKey(key, deletion) {
     const namespace = key.namespace
         ? ` ${ansi_colors_1.default.italic(`(namespace: ${key.namespace})`)}`
         : '';
-    if (type === 'added') {
-        console.log(`${ansi_colors_1.default.green(`+ ${key.keyName}`)}${namespace}`);
+    if (deletion) {
+        console.log(`${ansi_colors_1.default.red(`- ${key.keyName}`)}${namespace}`);
     }
     else {
-        console.log(`${ansi_colors_1.default.red(`- ${key.keyName}`)}${namespace}`);
+        console.log(`${ansi_colors_1.default.green(`+ ${key.keyName}`)}${namespace}`);
     }
 }
 exports.printKey = printKey;
@@ -47,18 +47,36 @@ function compareKeys(local, remote) {
         }
     }
     // Added keys
-    const namespaces = [...Object.keys(local), runner_1.NullNamespace];
+    const namespaces = [runner_1.NullNamespace, ...Object.keys(local).sort()];
     for (const namespace of namespaces) {
-        if (local[namespace].size) {
-            for (const [keyName, defaultValue] of local[namespace].entries()) {
+        if (namespace in local && local[namespace].size) {
+            const keys = local[namespace];
+            const keyNames = Array.from(local[namespace].keys()).sort();
+            for (const keyName of keyNames) {
                 result.added.push({
                     keyName: keyName,
                     namespace: namespace === runner_1.NullNamespace ? undefined : namespace,
-                    defaultValue: defaultValue || undefined,
+                    defaultValue: keys.get(keyName) || undefined,
                 });
             }
         }
     }
+    // Sort keys
+    // This is only necessary for unused keys, because the added keys are sorted directly as they're added.
+    result.removed.sort((a, b) => {
+        if (a.namespace === b.namespace) {
+            return a.keyName > b.keyName ? 1 : a.keyName < b.keyName ? -1 : 0;
+        }
+        if (!a.namespace && b.namespace)
+            return -1;
+        if (a.namespace && !b.namespace)
+            return 1;
+        return a.namespace > b.namespace
+            ? 1
+            : a.namespace < b.namespace
+                ? -1
+                : 0;
+    });
     return result;
 }
 exports.compareKeys = compareKeys;

package/dist/config/tolgeerc.js

@@ -26,10 +26,10 @@ function parseConfig(rc) {
         }
     }
     if ('projectId' in rc) {
-        if (typeof rc.projectId !== 'number') {
-            throw new Error('Invalid config: projectId is not a number');
+        cfg.projectId = Number(rc.projectId); // Number("") returns 0
+        if (!Number.isInteger(cfg.projectId) || cfg.projectId <= 0) {
+            throw new Error('Invalid config: projectId should be an integer representing your project Id');
         }
-        cfg.projectId = rc.projectId;
     }
     if ('sdk' in rc) {
         if (!constants_1.SDKS.includes(rc.sdk)) {

package/dist/extractor/machines/react.js

@@ -393,6 +393,30 @@ exports.default = (0, xstate_1.createMachine)({
                             target: 'idle',
                             actions: ['dynamicChildren', 'pushKey'],
                         },
+                        'variable.other.object.ts': {
+                            target: 'idle',
+                            actions: ['dynamicChildren', 'pushKey'],
+                        },
+                        'entity.name.function.ts': {
+                            target: 'idle',
+                            actions: ['dynamicChildren', 'pushKey'],
+                        },
+                        'storage.type.function.ts': {
+                            target: 'idle',
+                            actions: ['dynamicChildren', 'pushKey'],
+                        },
+                        'storage.type.class.ts': {
+                            target: 'idle',
+                            actions: ['dynamicChildren', 'pushKey'],
+                        },
+                        'keyword.operator.new.ts': {
+                            target: 'idle',
+                            actions: ['dynamicChildren', 'pushKey'],
+                        },
+                        'punctuation.definition.block.ts': {
+                            target: 'idle',
+                            actions: ['dynamicChildren', 'pushKey'],
+                        },
                         'punctuation.definition.template-expression.begin.ts': {
                             target: 'idle',
                             actions: ['dynamicChildren', 'pushKey'],
@@ -600,7 +624,9 @@ exports.default = (0, xstate_1.createMachine)({
                 // But we DO want the namespace to be overridable
                 keyName: ctx.key.keyName || evt.data.keyName,
                 defaultValue: ctx.key.defaultValue || evt.data.defaultValue || undefined,
-                namespace: evt.data.namespace ?? ctx.key.namespace,
+                namespace: evt.data.namespace === ''
+                    ? undefined
+                    : evt.data.namespace ?? ctx.key.namespace,
                 line: ctx.line,
             }),
             warnings: (ctx, evt) => {

package/dist/extractor/machines/shared/properties.js

@@ -105,6 +105,14 @@ exports.default = (0, xstate_1.createMachine)({
         },
         value_string: {
             on: {
+                'punctuation.definition.string.end.ts': {
+                    target: 'idle',
+                    actions: ['storeEmptyPropertyValue', 'clearPropertyType'],
+                },
+                'punctuation.definition.string.template.end.ts': {
+                    target: 'idle',
+                    actions: ['storeEmptyPropertyValue', 'clearPropertyType'],
+                },
                 '*': [
                     {
                         target: 'idle',
@@ -198,6 +206,13 @@ exports.default = (0, xstate_1.createMachine)({
             defaultValue: (ctx, evt) => ctx.property === 'defaultValue' ? evt.token : ctx.defaultValue,
             namespace: (ctx, evt) => ctx.property === 'ns' ? evt.token : ctx.namespace,
         }),
+        storeEmptyPropertyValue: (0, xstate_1.assign)({
+            keyName: (ctx) => ctx.property === 'key' || ctx.property === 'keyName'
+                ? ''
+                : ctx.keyName,
+            defaultValue: (ctx) => ctx.property === 'defaultValue' ? '' : ctx.defaultValue,
+            namespace: (ctx) => (ctx.property === 'ns' ? '' : ctx.namespace),
+        }),
         markPropertyAsDynamic: (0, xstate_1.assign)({
             keyName: (ctx, _evt) => ctx.property === 'key' || ctx.property === 'keyName'
                 ? false

package/dist/index.js

@@ -26,36 +26,31 @@ function topLevelName(command) {
         ? topLevelName(command.parent)
         : command.name();
 }
-async function validateApiKey(cmd) {
+async function loadApiKey(cmd) {
     const opts = cmd.optsWithGlobals();
-    if (!opts.apiKey) {
-        // Attempt to load --api-key from config store if not specified
-        // This is not done as part of the init routine or via the mandatory flag, as this is dependent on the API URL.
-        const key = await (0, credentials_1.getApiKey)(opts.apiUrl, opts.projectId);
-        if (!key) {
-            (0, logger_1.error)('No API key has been provided. You must either provide one via --api-key, or login via `tolgee login`.');
-            process.exit(1);
+    // API Key is already loaded
+    if (opts.apiKey)
+        return;
+    // Attempt to load --api-key from config store if not specified
+    // This is not done as part of the init routine or via the mandatory flag, as this is dependent on the API URL.
+    const key = await (0, credentials_1.getApiKey)(opts.apiUrl, opts.projectId);
+    // No key in store, stop here.
+    if (!key)
+        return;
+    cmd.setOptionValue('apiKey', key);
+    program.setOptionValue('_removeApiKeyFromStore', () => {
+        if (key.startsWith(constants_1.API_KEY_PAT_PREFIX)) {
+            (0, credentials_1.savePat)(opts.apiUrl);
         }
-        cmd.setOptionValue('apiKey', key);
-        program.setOptionValue('_removeApiKeyFromStore', () => {
-            if (key.startsWith(constants_1.API_KEY_PAT_PREFIX)) {
-                (0, credentials_1.savePat)(opts.apiUrl);
-            }
-            else {
-                (0, credentials_1.savePak)(opts.apiUrl, opts.projectId);
-            }
-        });
-    }
+        else {
+            (0, credentials_1.savePak)(opts.apiUrl, opts.projectId);
+        }
+    });
 }
-function validateProjectId(cmd) {
+function loadProjectId(cmd) {
     const opts = cmd.optsWithGlobals();
-    // Validate --project-id is present when using Project API keys
-    if (opts.projectId === -1 && opts.apiKey.startsWith(constants_1.API_KEY_PAT_PREFIX)) {
-        (0, logger_1.error)('You must specify a Project ID.');
-        process.exit(1);
-    }
     if (opts.apiKey.startsWith(constants_1.API_KEY_PAK_PREFIX)) {
-        // Parse the key to ensure we can access the specified Project ID
+        // Parse the key and ensure we can access the specified Project ID
         const projectId = client_1.default.projectIdFromKey(opts.apiKey);
         program.setOptionValue('projectId', projectId);
         if (opts.projectId !== -1 && opts.projectId !== projectId) {
@@ -66,10 +61,23 @@ function validateProjectId(cmd) {
         }
     }
 }
+function validateOptions(cmd) {
+    const opts = cmd.optsWithGlobals();
+    if (opts.projectId === -1) {
+        (0, logger_1.error)('No Project ID have been specified. You must either provide one via --project-ir, or by setting up a `.tolgeerc` file.');
+        (0, logger_1.info)('Learn more about configuring the CLI here: https://tolgee.io/tolgee-cli/project-configuration');
+        process.exit(1);
+    }
+    if (!opts.apiKey) {
+        (0, logger_1.error)('No API key has been provided. You must either provide one via --api-key, or login via `tolgee login`.');
+        process.exit(1);
+    }
+}
 async function preHandler(prog, cmd) {
     if (!NO_KEY_COMMANDS.includes(topLevelName(cmd))) {
-        await validateApiKey(cmd);
-        await validateProjectId(cmd);
+        await loadApiKey(cmd);
+        loadProjectId(cmd);
+        validateOptions(cmd);
         const opts = cmd.optsWithGlobals();
         const client = new client_1.default({
             apiUrl: opts.apiUrl,

package/dist/options.js

@@ -7,7 +7,7 @@ const commander_1 = require("commander");
 const constants_1 = require("./constants");
 function parseProjectId(v) {
     const val = Number(v);
-    if (isNaN(val) || val < 1) {
+    if (!Number.isInteger(val) || val < 1) {
         throw new commander_1.InvalidArgumentError('Not a valid project ID.');
     }
     return val;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tolgee/cli",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "commonjs",
   "description": "A tool to interact with the Tolgee Platform through CLI",
   "bin": {