i18nexus-cli 3.6.1 → 3.8.0

package/README.md

@@ -92,6 +92,7 @@ If you wish to download your files to a different directory, you can use the `--
 | `--ver` or `-v`     | `latest`      |
 | `--confirmed`       | `false`       |
 | `--clean`           | `false`       |
+| `--compact`         | `false`       |
 
 ### Notes
 
@@ -110,6 +111,9 @@ Downloads only translations that have been confirmed in i18nexus
 `--clean`
 Before download, clears your destination folder specified in --path. As a safety precaution, this only deletes folders with names that match a simple language code regex. You should still ensure you are not storing any files in your destination folder that you do not want deleted.
 
+`--compact`
+Output JSON without extra whitespace (default is pretty-printed)
+
 ## Personal Access Tokens
 
 The following commands require a Personal Access Token (PAT) because they write data to your i18nexus project. PATs are created in your i18nexus account dashboard.
@@ -315,9 +319,20 @@ A personal access token that you have generated in your i18nexus account (Can al
 i18nexus listen -k <PROJECT_API_KEY>
 ```
 
-This command starts a tunnel to your local development server using [localtunnel](https://www.npmjs.com/package/localtunnel), allowing i18nexus to send real-time webhooks for translation updates.
+This command opens a WebSocket connection from your local environment to the i18nexus servers to receive real-time updates whenever strings are added, updated, or deleted in your project.
+
+When changes occur, your local JSON files are automatically refreshed to stay in sync.
+
+Many developers prefer to run this automatically alongside their development server. For example, in a Next.js project, you can do the following in your `package.json` using [concurrently](https://www.npmjs.com/package/concurrently):
 
-When a string is added, updated, or deleted in your project, a webhook is sent to your local server, automatically updating your local JSON files.
+```json
+"scripts": {
+    "dev": "concurrently --raw \"next dev --turbo\" \"i18nexus listen\"",
+    "build": "i18nexus pull && next build",
+    "start": "i18nexus pull && next start",
+    "lint": "next lint"
+}
+```
 
 ### Options
 
@@ -325,14 +340,15 @@ When a string is added, updated, or deleted in your project, a webhook is sent t
 | ------------------- | --------- | ----------------------- |
 | `--api-key` or `-k` | &#10004;  |                         |
 | `--path` or `-p`    |           | See `pull` default path |
-| `--port`            |           | '3002'                  |
+| `--compact`         |           | `false`                 |
 
 ### Notes
 
 `--api-key`  
 Your project API key (Can also be set using environment variable `I18NEXUS_API_KEY`)
 
-`--port`  
-The local port your server will listen on to receive incoming webhook requests from i18nexus. Defaults to `3002`.
+`--path`
+The path to the destination folder in which translation files will be downloaded
 
-The tunnel will remain active as long as the CLI is running. Press `Ctrl+C` to stop listening.
+`--compact`
+Output JSON without extra whitespace (default is pretty-printed)

package/bin/index.js

@@ -47,12 +47,17 @@ program
     'Removes and rebuilds destination folder before download',
     false
   )
+  .option(
+    '--compact',
+    'Output JSON without extra whitespace (default is pretty-printed)'
+  )
   .action(options => {
     pull({
       apiKey: options.apiKey,
       version: options.ver,
       path: options.path,
       clean: options.clean,
+      compact: options.compact,
       confirmed: options.confirmed
     });
   });
@@ -268,12 +273,15 @@ program
     '-p, --path <path>',
     'The path to the destination folder in which translation files will be downloaded'
   )
-  .option('--port <port>', 'Port your local dev server runs on', '3002')
+  .option(
+    '--compact',
+    'Output JSON without extra whitespace (default is pretty-printed)'
+  )
   .action(options => {
     listen({
       apiKey: options.apiKey,
-      port: options.port,
-      path: options.path
+      path: options.path,
+      compact: options.compact
     });
   });
 

package/commands/listen.js

@@ -1,30 +1,19 @@
 #!/usr/bin/env node
-/* commands/listen.js */
-
-const http = require('http');
-const localtunnel = require('localtunnel');
+const WebSocket = require('ws');
 const colors = require('colors');
-const handleFetch = require('../handleFetch');
-const baseUrl = require('../baseUrl');
 const pull = require('../commands/pull');
+const baseUrl = require('../baseUrl');
+const { URL } = require('url');
 
-const LISTEN_PATH = '/webhook'; // fixed internal path
-
-const listen = async ({ apiKey, port, path }) => {
-  port = Number(port);
-
-  if (!Number.isInteger(port) || port <= 0) {
-    console.log(colors.red('Invalid port'));
-    return process.exit(1);
-  }
-
+const listen = async ({ apiKey, path, compact = false }) => {
   await pull(
     {
       apiKey,
       version: 'latest',
-      path: path,
+      path,
       clean: false,
-      confirmed: false
+      confirmed: false,
+      compact
     },
     {
       logging: false,
@@ -32,105 +21,68 @@ const listen = async ({ apiKey, port, path }) => {
     }
   );
 
-  /* ────────────── 1. start local HTTP listener ────────────── */
-  const server = http.createServer(async (req, res) => {
-    if (req.method !== 'POST' || req.url !== LISTEN_PATH) {
-      res.writeHead(404).end();
-      return;
+  const wsUrl = new URL(`${baseUrl.replace(/^http/, 'ws')}/cable`);
+  wsUrl.searchParams.set('api_key', apiKey);
+
+  const ws = new WebSocket(wsUrl.toString(), {
+    headers: {
+      Origin: 'http://cli.i18nexus.com'
     }
+  });
+
+  ws.on('open', () => {
+    console.log(colors.green('Listening for i18nexus string updates...'));
 
-    let body = '';
-    req.on('data', chunk => (body += chunk));
-    req.on('end', async () => {
-      try {
+    ws.send(
+      JSON.stringify({
+        command: 'subscribe',
+        identifier: JSON.stringify({ channel: 'CliListenChannel' })
+      })
+    );
+  });
+
+  ws.on('message', async message => {
+    try {
+      const data = JSON.parse(message);
+      const payload = data.message;
+
+      if (payload?.event === 'strings.changed') {
         await pull(
           {
             apiKey,
             version: 'latest',
-            path: path,
+            path,
             clean: false,
-            confirmed: false
+            confirmed: false,
+            compact
           },
           {
             logging: false,
             successLog: '  ✔ Translations updated'
           }
         );
-
-        res.writeHead(200).end('ok');
-      } catch (e) {
-        console.error(colors.red('Failed to download translations:'), e);
-        res.writeHead(500).end('error');
       }
-    });
+    } catch (e) {
+      console.error(colors.red('i18nexus Sync Failed'));
+    }
   });
 
-  /* ────────────── 2. start tunnel ────────────── */
-  const tunnel = await new Promise(res => {
-    server.listen(port, async () => {
-      res(await localtunnel({ port }));
-    });
+  ws.on('close', () => {
+    process.exit(1);
   });
 
-  const publicUrl = `${tunnel.url}${LISTEN_PATH}`;
-
-  /* ────────────── 3. register dev webhook with i18nexus ────────────── */
-  const createRes = await handleFetch(
-    `${baseUrl}/project_resources/dev_webhooks`,
-    {
-      method: 'POST',
-      headers: { 'Content-Type': 'application/json' },
-      body: JSON.stringify({ api_key: apiKey, url: publicUrl })
-    }
-  );
-
-  let closing = false;
-
-  /* ────────────── graceful shutdown ────────────── */
-  const cleanUp = async (exitCode = 0) => {
-    if (closing) {
-      return;
-    }
-
-    closing = true;
-
-    try {
-      const { collection } = await createRes.json();
-      const webhookId = collection[0].id;
+  ws.on('error', err => {
+    console.error(colors.red('i18nexus Connection Error'));
+    process.exit(1);
+  });
 
-      await handleFetch(`${baseUrl}/project_resources/dev_webhooks`, {
-        method: 'DELETE',
-        headers: { 'Content-Type': 'application/json' },
-        body: JSON.stringify({ api_key: apiKey, id: webhookId })
-      });
-    } catch (e) {}
-    tunnel.close();
-    server.close();
-    process.exit(exitCode);
+  const cleanUp = () => {
+    ws.close();
+    process.exit(0);
   };
 
-  if (createRes.status !== 200) {
-    console.log(colors.red('Failed to register webhook with i18nexus'));
-    cleanUp(1);
-    return;
-  }
-
-  console.log(colors.green('Listening for i18nexus updates…'));
-
-  process.on('SIGINT', () => cleanUp());
-  process.on('SIGTERM', () => cleanUp());
-
-  let connectionLost = false;
-  tunnel.on('error', () => {
-    if (connectionLost) {
-      return;
-    }
-    connectionLost = true;
-
-    console.error(colors.red('i18nexus listener connection lost'));
-
-    cleanUp(1);
-  });
+  process.on('SIGINT', cleanUp);
+  process.on('SIGTERM', cleanUp);
 };
 
 module.exports = listen;

package/commands/pull.js

@@ -127,13 +127,15 @@ const pull = async (opt, internalOptions = {}) => {
     cleanDirectory(path);
   }
 
+  const spacing = opt.compact ? 0 : 2;
+
   if (projectLibrary === 'next-intl') {
     for (let lng in translations) {
       fs.mkdirSync(path, { recursive: true });
 
       fs.writeFileSync(
         `${path}/${lng}.json`,
-        JSON.stringify(translations[lng])
+        JSON.stringify(translations[lng], null, spacing)
       );
     }
   } else {
@@ -144,7 +146,7 @@ const pull = async (opt, internalOptions = {}) => {
       for (let namespace in translations[lng]) {
         fs.writeFileSync(
           `${lngFilePath}/${namespace}.json`,
-          JSON.stringify(translations[lng][namespace])
+          JSON.stringify(translations[lng][namespace], null, spacing)
         );
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "i18nexus-cli",
-  "version": "3.6.1",
+  "version": "3.8.0",
   "description": "Command line interface (CLI) for accessing the i18nexus API",
   "main": "index.js",
   "bin": {
@@ -20,7 +20,7 @@
     "colors": "^1.4.0",
     "commander": "^7.2.0",
     "https-proxy-agent": "^5.0.0",
-    "localtunnel": "^2.0.2",
-    "node-fetch": "^2.6.7"
+    "node-fetch": "^2.6.7",
+    "ws": "^8.18.3"
   }
 }