@tolgee/cli 1.0.1 → 1.1.0

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 (namespace in local && local[namespace].size) {
-            for (const [keyName, defaultValue] of local[namespace].entries()) {
+            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/extractor.js

@@ -0,0 +1,65 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+const xstate_1 = require("xstate");
+const react_1 = __importDefault(require("./machines/react"));
+const svelte_1 = __importDefault(require("./machines/svelte"));
+const comments_1 = __importDefault(require("./machines/comments"));
+const tokenizer_1 = __importDefault(require("./tokenizer"));
+const REACT_EXTS = [
+    '.js',
+    '.mjs',
+    '.cjs',
+    '.ts',
+    '.mts',
+    '.cts',
+    '.jsx',
+    '.tsx',
+];
+const ALL_EXTS = [
+    '.js',
+    '.mjs',
+    '.cjs',
+    '.ts',
+    '.mts',
+    '.cts',
+    '.jsx',
+    '.tsx',
+    '.svelte',
+];
+function pickMachine(code, fileName) {
+    const ext = (0, path_1.extname)(fileName);
+    if (REACT_EXTS.includes(ext) && code.includes('@tolgee/react')) {
+        return react_1.default;
+    }
+    if (ext === '.svelte' && code.includes('@tolgee/svelte')) {
+        return svelte_1.default;
+    }
+    if (ALL_EXTS.includes(ext) &&
+        (code.includes('@tolgee-key') || code.includes('@tolgee-ignore'))) {
+        return comments_1.default;
+    }
+    return null;
+}
+async function extractor(code, fileName) {
+    const machineSpec = pickMachine(code, fileName);
+    if (!machineSpec) {
+        return { warnings: [], keys: [] };
+    }
+    const tokens = await (0, tokenizer_1.default)(code, fileName);
+    // @ts-ignore -- Types are whacky, complains about withConfig but it's not a problem here.
+    const machine = (0, xstate_1.interpret)(machineSpec);
+    machine.start();
+    for (const token of tokens) {
+        machine.send(token);
+    }
+    const snapshot = machine.getSnapshot();
+    return {
+        warnings: snapshot.context.warnings,
+        keys: snapshot.context.keys,
+    };
+}
+exports.default = extractor;

package/dist/extractor/machines/comments.js

@@ -0,0 +1,83 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const xstate_1 = require("xstate");
+const comments_1 = __importDefault(require("./shared/comments"));
+exports.default = (0, xstate_1.createMachine)({
+    predictableActionArguments: true,
+    id: 'commentsExtractor',
+    context: {
+        keys: [],
+        warnings: [],
+    },
+    invoke: {
+        id: 'comments',
+        src: () => comments_1.default,
+    },
+    on: {
+        // Service messages
+        MAGIC_COMMENT: [
+            {
+                actions: 'warnUnusedIgnore',
+                cond: (_ctx, evt) => evt.kind === 'ignore',
+            },
+            {
+                actions: 'pushKey',
+                cond: (_ctx, evt) => evt.kind === 'key',
+            },
+        ],
+        WARNING: {
+            actions: 'pushWarning',
+        },
+        // Code messages
+        'comment.line.double-slash.ts': {
+            actions: (0, xstate_1.send)((_ctx, evt) => ({
+                type: 'COMMENT',
+                data: evt.token,
+                line: evt.line,
+            }), { to: 'comments' }),
+        },
+        'comment.block.ts': {
+            actions: (0, xstate_1.send)((_ctx, evt) => ({
+                type: 'COMMENT',
+                data: evt.token,
+                line: evt.line,
+            }), { to: 'comments' }),
+        },
+        'comment.block.svelte': {
+            actions: (0, xstate_1.send)((_ctx, evt) => ({
+                type: 'COMMENT',
+                data: evt.token,
+                line: evt.line,
+            }), { to: 'comments' }),
+        },
+    },
+}, {
+    actions: {
+        warnUnusedIgnore: (0, xstate_1.assign)({
+            warnings: (ctx, evt) => [
+                ...ctx.warnings,
+                { warning: 'W_UNUSED_IGNORE', line: evt.line },
+            ],
+        }),
+        pushKey: (0, xstate_1.assign)({
+            keys: (ctx, evt) => [
+                ...ctx.keys,
+                {
+                    keyName: evt.keyName,
+                    namespace: evt.namespace,
+                    defaultValue: evt.defaultValue,
+                    line: evt.line,
+                },
+            ],
+        }),
+        pushWarning: (0, xstate_1.assign)({
+            warnings: (ctx, evt) => [
+                ...ctx.warnings,
+                { warning: evt.kind, line: evt.line },
+            ],
+        }),
+    },
+});

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'],
@@ -648,7 +672,7 @@ exports.default = (0, xstate_1.createMachine)({
                 ...ctx.key,
                 namespace: ctx.hooks.length
                     ? ctx.hooks[ctx.hooks.length - 1].namespace
-                    : void 0,
+                    : undefined,
             }),
         }),
         dynamicKeyName: (0, xstate_1.assign)({

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

@@ -42,6 +42,13 @@ exports.default = (0, xstate_1.createMachine)({
                     target: 'value',
                     actions: 'markAsStatic',
                 },
+                // Svelte
+                'entity.other.attribute-name.svelte': {
+                    actions: ['markPropertyAsDynamic', 'storePropertyType'],
+                },
+                'punctuation.separator.key-value.svelte': {
+                    target: 'value',
+                },
             },
         },
         complex_key: {
@@ -69,6 +76,8 @@ exports.default = (0, xstate_1.createMachine)({
                 // Extract strings
                 'punctuation.definition.string.begin.ts': 'value_string',
                 'punctuation.definition.string.template.begin.ts': 'value_string',
+                'punctuation.definition.string.begin.svelte': 'value_string',
+                'punctuation.definition.string.template.begin.svelte': 'value_string',
                 // Variable
                 'variable.other.readwrite.ts': {
                     target: 'idle',
@@ -82,6 +91,15 @@ exports.default = (0, xstate_1.createMachine)({
                 'punctuation.section.embedded.begin.tsx': {
                     actions: 'unmarkAsStatic',
                 },
+                // Svelte
+                'string.unquoted.svelte': {
+                    target: 'idle',
+                    actions: [
+                        'storePropertyValue',
+                        'clearPropertyType',
+                        'unmarkAsStatic',
+                    ],
+                },
                 // Value end
                 'punctuation.separator.comma.ts': {
                     target: 'idle',
@@ -113,6 +131,14 @@ exports.default = (0, xstate_1.createMachine)({
                     target: 'idle',
                     actions: ['storeEmptyPropertyValue', 'clearPropertyType'],
                 },
+                'punctuation.definition.string.end.svelte': {
+                    target: 'idle',
+                    actions: ['storeEmptyPropertyValue', 'clearPropertyType'],
+                },
+                'punctuation.definition.string.template.end.svelte': {
+                    target: 'idle',
+                    actions: ['storeEmptyPropertyValue', 'clearPropertyType'],
+                },
                 '*': [
                     {
                         target: 'idle',
@@ -149,6 +175,19 @@ exports.default = (0, xstate_1.createMachine)({
                     target: 'idle',
                     actions: 'clearPropertyType',
                 },
+                // Svelte
+                'punctuation.section.embedded.begin.svelte': {
+                    target: 'idle',
+                    actions: ['markPropertyAsDynamic', 'clearPropertyType'],
+                },
+                'punctuation.definition.string.end.svelte': {
+                    target: 'idle',
+                    actions: 'clearPropertyType',
+                },
+                'punctuation.section.embedded.end.svelte': {
+                    target: 'idle',
+                    actions: 'clearPropertyType',
+                },
             },
         },
         end: {
@@ -180,13 +219,19 @@ exports.default = (0, xstate_1.createMachine)({
             target: 'end',
             actions: 'markPropertyAsDynamic',
         },
+        'punctuation.definition.tag.end.svelte': {
+            target: 'end',
+            actions: 'markPropertyAsDynamic',
+        },
     },
 }, {
     guards: {
         isOpenCurly: (_ctx, evt) => evt.token === '{' &&
-            !evt.scopes.includes('meta.embedded.expression.tsx'),
+            !evt.scopes.includes('meta.embedded.expression.tsx') &&
+            !evt.scopes.includes('meta.embedded.expression.svelte'),
         isCloseCurly: (_ctx, evt) => evt.token === '}' &&
-            !evt.scopes.includes('meta.embedded.expression.tsx'),
+            !evt.scopes.includes('meta.embedded.expression.tsx') &&
+            !evt.scopes.includes('meta.embedded.expression.svelte'),
         isFinalCloseCurly: (ctx, evt) => evt.token === '}' && ctx.depth === 1,
         isOpenSquare: (_ctx, evt) => evt.token === '[',
         isCloseSquare: (_ctx, evt) => evt.token === ']',