i18nexus-cli 3.3.1 → 3.5.0

package/README.md

@@ -6,14 +6,15 @@
 
 [i18nexus](https://i18nexus.com) is a translation management web application designed for use with i18next, next-intl, and react-intl. Learn more with these quick tutorials:
 
-- [next-i18next Walkthrough](https://i18nexus.com/tutorials/nextjs/next-i18next)
-- [next-intl Walkthrough](https://i18nexus.com/tutorials/nextjs/next-intl)
 - [react-i18next Walkthrough](https://i18nexus.com/tutorials/react/react-i18next)
 - [react-intl Walkthrough](https://i18nexus.com/tutorials/react/react-intl)
+- [next-intl for Next.js App Router Walkthrough](https://i18nexus.com/tutorials/nextjs/next-intl)
+- [react-i18next for Next.js App Router Walkthrough](https://i18nexus.com/tutorials/nextjs/react-i18next)
+- [next-i18next for Next.js Pages Router Walkthrough](https://i18nexus.com/tutorials/nextjs/next-i18next)
 
 ## Who is this CLI meant for?
 
-- Developers who prefer to download and bundle their translation files with their app (especially useful for those who use SSR/SSG and libraries like Next.js).
+- Developers who prefer to download and bundle their translation files with their app (especially useful for those who use SSR/SSG frameworks such as Next.js).
 - Developers who wish to add, edit, or delete strings in their i18nexus project from the command line.
 
 ## Installation
@@ -89,6 +90,7 @@ If you wish to download your files to a different directory, you can use the `--
 | `--api-key` or `-k` |               |
 | `--path` or `-p`    | (See above)   |
 | `--ver` or `-v`     | `latest`      |
+| `--confirmed`       | `false`       |
 | `--clean`           | `false`       |
 
 ### Notes
@@ -102,6 +104,9 @@ The path to the destination folder in which translation files will be downloaded
 `--ver`
 The version of your project's translations to be downloaded (Can also be set using environment variable `I18NEXUS_VERSION`)
 
+`--confirmed`
+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.
 
@@ -125,14 +130,15 @@ Translations for the string will be automatically generated and machine translat
 
 ### Options
 
-| Option                 | Required? |
-| ---------------------- | --------- |
-| `--api-key` or `-k`    | ✔  |
-| `--pat` or `-t`        | ✔  |
-| `--namespace` or `-ns` | ✔  |
-| `--key` or `-K`        | ✔  |
-| `--value` or `-v`      | ✔  |
-| `--details` or `-d`    |           |
+| Option                       | Required? |
+| ---------------------------- | --------- |
+| `--api-key` or `-k`          | ✔  |
+| `--pat` or `-t`              | ✔  |
+| `--namespace` or `-ns`       | ✔  |
+| `--key` or `-K`              | ✔  |
+| `--value` or `-v`            | ✔  |
+| `--details` or `-d`          |           |
+| `--ai-instructions` or `-ai` |           |
 
 ### Notes
 
@@ -154,6 +160,9 @@ The value of the string to create
 `--details`
 The details of the string to create (optional)
 
+`--ai-instructions`
+Instructions or context for AI machine translator (optional)
+
 ## Updating existing strings
 
 `i18nexus update-string <namespace> <key>` or `i18nexus u <namespace> <key>`
@@ -170,16 +179,17 @@ You can then update the key, value, details, and/or namespace by using the comma
 
 ### Options
 
-| Option                 | Required? |
-| ---------------------- | --------- |
-| `--api-key` or `-k`    | &#10004;  |
-| `--pat` or `-t`        | &#10004;  |
-| `--namespace` or `-ns` |           |
-| `--key` or `-K`        |           |
-| `--value` or `-v`      |           |
-| `--details` or `-d`    |           |
-| `--reset-confirmed`    |           |
-| `--retain-confirmed`   |           |
+| Option                       | Required? |
+| ---------------------------- | --------- |
+| `--api-key` or `-k`          | &#10004;  |
+| `--pat` or `-t`              | &#10004;  |
+| `--namespace` or `-ns`       |           |
+| `--key` or `-K`              |           |
+| `--value` or `-v`            |           |
+| `--details` or `-d`          |           |
+| `--ai-instructions` or `-ai` |           |
+| `--reset-confirmed`          |           |
+| `--retain-confirmed`         |           |
 
 ### Notes
 
@@ -201,6 +211,9 @@ The new value of the string
 `--details`
 The new details of the string
 
+`--ai-instructions`
+Instructions or context for AI machine translator
+
 #### If you are updating the value of a string that contains translations that have been marked confirmed in i18nexus, you will be required to include one of the following options to your command:
 
 `--reset-confirmed`

package/bin/index.js

@@ -36,6 +36,11 @@ program
     '-p, --path <path>',
     'The path to the destination folder in which translation files will be downloaded'
   )
+  .option(
+    '--confirmed',
+    'Only downloads confirmed translations (Cannot be used with `version`)',
+    false
+  )
   .option(
     '--clean',
     'Removes and rebuilds destination folder before download',
@@ -46,7 +51,8 @@ program
       apiKey: options.apiKey,
       version: options.ver,
       path: options.path,
-      clean: options.clean
+      clean: options.clean,
+      confirmed: options.confirmed
     });
   });
 
@@ -77,6 +83,10 @@ program
     '-d, --details <stringDetails>',
     'The details of the string to create (optional)'
   )
+  .option(
+    '-ai, --ai-instructions <stringAiInstructions>',
+    'Instructions/Context for AI machine translator (optional)'
+  )
   .action(options => {
     addString({
       key: options.key,
@@ -84,7 +94,8 @@ program
       details: options.details,
       namespace: options.namespace,
       apiKey: options.apiKey,
-      pat: options.pat
+      pat: options.pat,
+      aiInstructions: options.aiInstructions
     });
   });
 
@@ -109,6 +120,10 @@ program
     'The new namespace of the string'
   )
   .option('-d, --details <stringDetails>', 'The new details of the string')
+  .option(
+    '-ai, --ai-instructions <stringAiInstructions>',
+    'Instructions/Context for AI machine translator (optional)'
+  )
   .option(
     '--reset-confirmed',
     'Reset confirmed translations of this string with machine translations.'
@@ -126,6 +141,7 @@ program
       key: options.key,
       value: options.value,
       details: options.details,
+      aiInstructions: options.aiInstructions,
       namespace: options.namespace,
       apiKey: options.apiKey,
       pat: options.pat,

package/commands/addString.js

@@ -14,7 +14,8 @@ const addString = async opt => {
       key: opt.key,
       value: opt.value,
       namespace: opt.namespace,
-      description: opt.details
+      description: opt.details,
+      ai_instructions: opt.aiInstructions
     }),
     headers: {
       Authorization: `Bearer ${opt.pat}`,

package/commands/pull.js

@@ -17,7 +17,7 @@ const cleanDirectory = path => {
 
   contents.forEach(name => {
     if (regex.test(name)) {
-      fs.rmdirSync(`${path}/${name}`, { recursive: true });
+      fs.rmSync(`${path}/${name}`, { recursive: true });
     }
   });
 };
@@ -61,6 +61,11 @@ const pull = async opt => {
 
   const usingVersion = opt.version !== 'latest';
 
+  if (usingVersion && opt.confirmed) {
+    console.log(colors.red('The --confirmed flag cannot be used with version'));
+    return process.exit(1);
+  }
+
   console.log(`Downloading translations to ${path}...`);
 
   const lngResponse = await handleFetch(
@@ -91,6 +96,10 @@ const pull = async opt => {
 
     url += `?api_key=${opt.apiKey}`;
 
+    if (opt.confirmed) {
+      url += '&confirmed=true';
+    }
+
     const response = await handleFetch(url);
 
     if (response.status !== 200) {

package/commands/updateString.js

@@ -29,6 +29,7 @@ const addString = async opt => {
       value: opt.value,
       namespace: opt.namespace,
       description: opt.details,
+      ai_instructions: opt.aiInstructions,
       reset_confirmed: resetConfirmed
     }),
     headers: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "i18nexus-cli",
-  "version": "3.3.1",
+  "version": "3.5.0",
   "description": "Command line interface (CLI) for accessing the i18nexus API",
   "main": "index.js",
   "bin": {
@@ -9,7 +9,9 @@
   "keywords": [
     "i18nexus",
     "cli",
-    "i18next"
+    "react-intl",
+    "i18next",
+    "next-intl"
   ],
   "author": "i18nexus",
   "license": "MIT",