i18nexus-cli 3.0.0 → 3.2.0

package/README.md

@@ -4,11 +4,16 @@
 
 ## New to i18nexus?
 
-[i18nexus](https://i18nexus.com) is a translation management web application designed for use with i18next. Learn more with this quick [Next.js walkthrough](https://i18nexus.com/nextjs-tutorial) or this [React.js walkthrough](https://i18nexus.com/react-tutorial).
+[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)
 
 ## 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 such as [next-i18next](https://github.com/isaachinman/next-i18next)).
+- 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 wish to add, edit, or delete strings in their i18nexus project from the command line.
 
 ## Installation
@@ -19,7 +24,7 @@ npm install -g i18nexus-cli
 
 ## Environment Variables
 
-The commands below have options that can be set with environment variables. Since the majority of our users are using this package in the context of their web or mobile application, this package will load the `.env` file in the current working directory to check for i18nexus variables. If you would prefer not to load your `.env` file, you can run `export I18NEXUS_NO_DOT_ENV=true`.
+The commands below have options that can be set with environment variables. Since the majority of our users are using this package in the context of their web application, this package will load the `.env` file in the current working directory to check for i18nexus variables. If you would prefer not to load your `.env` file, you can run `export I18NEXUS_NO_DOT_ENV=true`.
 
 ## Downloading your translations
 
@@ -27,7 +32,9 @@ The commands below have options that can be set with environment variables. Sinc
 i18nexus pull -k <PROJECT_API_KEY>
 ```
 
-The above snippet will download all of your latest translations to your current directory in the following structure:
+The above snippet will download all of your latest translations to your current directory. Your translation files will be downloaded in a file structure based on the convention of your i18n library:
+
+If your i18nexus project is set to `i18next`:
 
 ```
 .
@@ -39,7 +46,26 @@ The above snippet will download all of your latest translations to your current
             └── common.json
 ```
 
-This structure is i18next convention, and will work by default with [next-i18next](https://github.com/isaachinman/next-i18next).
+If your i18nexus project is set to `next-intl`:
+
+```
+.
+└── messages
+    └── en.json
+    └── de.json
+```
+
+If your i18nexus project is set to `react-intl`:
+
+```
+.
+└── messages
+    └── locales
+        ├── en
+        |   └── common.json
+        └── de
+            └── common.json
+```
 
 If you wish to download your files to a different directory, you can use the `--path` option to specify your download destination. See all options below:
 
@@ -225,3 +251,28 @@ A personal access token that you have generated in your i18nexus account (Can al
 
 `--overwrite`
 If any keys already exist in the target namespace, overwrite the values with the imported values.
+
+## Adding new namespaces
+
+`i18nexus add-namespace <namespaceTitle>`
+
+```sh
+i18nexus add-namespace common -k <PROJECT_API_KEY> -t <YOUR_PERSONAL_ACCESS_TOKEN>
+```
+
+The above snippet will create a new namespace in your i18nexus project with the title `common`.
+
+### Options
+
+| Option              | Required? |
+| ------------------- | --------- |
+| `--api-key` or `-k` | &#10004;  |
+| `--pat` or `-t`     | &#10004;  |
+
+### Notes
+
+`--api-key`
+Your project API key (Can also be set using environment variable `I18NEXUS_API_KEY`)
+
+`--pat`
+A personal access token that you have generated in your i18nexus account (Can also be set using environment variable `I18NEXUS_PERSONAL_ACCESS_TOKEN`)

package/bin/index.js

@@ -7,6 +7,7 @@ const addString = require('../commands/addString');
 const updateString = require('../commands/updateString');
 const deleteString = require('../commands/deleteString');
 const importJson = require('../commands/importJson');
+const addNamespace = require('../commands/addNamespace');
 
 // Using Next's env variable loader because
 // Next supports more than just one .env file
@@ -31,10 +32,9 @@ program
     'The version of the translations to be downloaded.',
     process.env.I18NEXUS_VERSION || 'latest'
   )
-  .requiredOption(
+  .option(
     '-p, --path <path>',
-    'The path to the destination folder in which translation files will be downloaded',
-    `${process.cwd()}/public/locales`
+    'The path to the destination folder in which translation files will be downloaded'
   )
   .option(
     '--clean',
@@ -193,4 +193,26 @@ program
     });
   });
 
+program
+  .command('add-namespace <namespaceTitle>')
+  .alias('a-ns')
+  .description('Add a new namespace to your project')
+  .requiredOption(
+    '-k, --api-key <apiKey>',
+    'The API key for your project',
+    process.env.I18NEXUS_API_KEY
+  )
+  .requiredOption(
+    '-t, --pat <personalAccessToken>',
+    'A personal access token generated for your account in i18nexus',
+    process.env.I18NEXUS_PERSONAL_ACCESS_TOKEN
+  )
+  .action((namespaceTitle, options) => {
+    addNamespace({
+      title: namespaceTitle,
+      apiKey: options.apiKey,
+      pat: options.pat
+    });
+  });
+
 program.parse(process.argv);

package/commands/addNamespace.js

@@ -0,0 +1,31 @@
+const colors = require('colors');
+const handleError = require('../handleError');
+const handleFetch = require('../handleFetch');
+const baseUrl = require('../baseUrl');
+
+const addNamespace = async opt => {
+  let url = `${baseUrl}/project_resources/namespaces.json`;
+
+  url += `?api_key=${opt.apiKey}`;
+
+  const response = await handleFetch(url, {
+    method: 'POST',
+    body: JSON.stringify({
+      title: opt.title
+    }),
+    headers: {
+      Authorization: `Bearer ${opt.pat}`,
+      'Content-Type': 'application/json'
+    }
+  });
+
+  if (response.status !== 200) {
+    return handleError(response);
+  }
+
+  await response.json();
+
+  console.log(colors.green(`New namespace added: "${opt.title}"`));
+};
+
+module.exports = addNamespace;

package/commands/pull.js

@@ -3,6 +3,7 @@ const colors = require('colors');
 const handleError = require('../handleError');
 const handleFetch = require('../handleFetch');
 const baseUrl = require('../baseUrl');
+const getProject = require('../getProject');
 
 const cleanDirectory = path => {
   if (!fs.existsSync(path)) {
@@ -22,9 +23,30 @@ const cleanDirectory = path => {
 };
 
 const pull = async opt => {
-  const usingVersion = opt.version !== 'latest';
+  let path = opt.path;
+
+  const project = await getProject(opt.apiKey);
+
+  const projectLibrary = project.library;
 
-  console.log(baseUrl);
+  if (!path) {
+    if (!projectLibrary) {
+      console.log(
+        colors.red(
+          'There was a problem fetching your translations. Please try again in a moment.'
+        )
+      );
+      return process.exit(1);
+    }
+
+    if (projectLibrary === 'i18next') {
+      path = `${process.cwd()}/public/locales`;
+    } else {
+      path = `${process.cwd()}/messages`;
+    }
+  }
+
+  const usingVersion = opt.version !== 'latest';
 
   let url = usingVersion
     ? `https://cdn.i18nexus.com/versions/${opt.version}/translations.json`
@@ -32,7 +54,7 @@ const pull = async opt => {
 
   url += `?api_key=${opt.apiKey}`;
 
-  console.log(`Downloading translations to ${opt.path}...`);
+  console.log(`Downloading translations to ${path}...`);
 
   const response = await handleFetch(url);
 
@@ -48,19 +70,30 @@ const pull = async opt => {
   const translations = await response.json();
 
   if (opt.clean) {
-    cleanDirectory(opt.path);
+    cleanDirectory(path);
   }
 
-  for (let lng in translations) {
-    const lngFilePath = `${opt.path}/${lng}`;
-    fs.mkdirSync(lngFilePath, { recursive: true });
+  if (projectLibrary === 'next-intl') {
+    for (let lng in translations) {
+      fs.mkdirSync(path, { recursive: true });
 
-    for (let namespace in translations[lng]) {
       fs.writeFileSync(
-        `${lngFilePath}/${namespace}.json`,
-        JSON.stringify(translations[lng][namespace])
+        `${path}/${lng}.json`,
+        JSON.stringify(translations[lng])
       );
     }
+  } else {
+    for (let lng in translations) {
+      const lngFilePath = `${path}/${lng}`;
+      fs.mkdirSync(lngFilePath, { recursive: true });
+
+      for (let namespace in translations[lng]) {
+        fs.writeFileSync(
+          `${lngFilePath}/${namespace}.json`,
+          JSON.stringify(translations[lng][namespace])
+        );
+      }
+    }
   }
 
   console.log(colors.green('Translations downloaded successfully.'));

package/getProject.js

@@ -0,0 +1,20 @@
+const handleError = require('./handleError');
+const handleFetch = require('./handleFetch');
+const baseUrl = require('./baseUrl');
+
+const getProject = async apiKey => {
+  const url = `${baseUrl}/project_resources/project.json?api_key=${apiKey}`;
+
+  const response = await handleFetch(url);
+
+  if (response.status !== 200) {
+    return handleError(
+      response,
+      'There was a problem fetching your translations. Please try again in a moment.'
+    );
+  }
+
+  return response.json();
+};
+
+module.exports = getProject;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "i18nexus-cli",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "Command line interface (CLI) for accessing the i18nexus API",
   "main": "index.js",
   "bin": {