@transifex/cli 1.0.5 → 2.0.0-rc1

package/README.md

@@ -6,6 +6,10 @@ Related packages:
 * [@transifex/native](https://www.npmjs.com/package/@transifex/native)
 * [@transifex/react](https://www.npmjs.com/package/@transifex/react)
 
+# Upgrade to v2
+
+If you are upgrading from the `1.x.x` version, please read this [migration guide](https://github.com/transifex/transifex-javascript/blob/HEAD/UPGRADE_TO_V2.md), as there are breaking changes in place.
+
 # Usage
 
 ## Global installation
@@ -85,6 +89,8 @@ OPTIONS
   --append-tags=append-tags              append tags to strings
   --cds-host=cds-host                    CDS host URL
   --dry-run                              dry run, do not push to Transifex
+  --key-generator=source|hash            [default: source] use hashed or source based keys
+  --no-wait                              disable polling for upload results
   --purge                                purge content on Transifex
   --secret=secret                        native project secret
   --token=token                          native project public token
@@ -92,7 +98,7 @@ OPTIONS
   --without-tags-only=without-tags-only  push strings without specific tags
 
 DESCRIPTION
-  Parse .js, .ts, .jsx and .tsx files and detect phrases marked for
+  Parse .js, .ts, .jsx, .tsx and .html files and detect phrases marked for
   translation by Transifex Native toolkit for Javascript and
   upload them to Transifex for translation.
 
@@ -112,6 +118,7 @@ DESCRIPTION
   txjs-cli push "*.js"
   txjs-cli push --dry-run
   txjs-cli push --no-wait
+  txjs-cli push --key-generator=hash
   txjs-cli push --append-tags="master,release:2.5"
   txjs-cli push --with-tags-only="home,error"
   txjs-cli push --without-tags-only="custom"

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.0.5","commands":{"invalidate":{"id":"invalidate","description":"invalidate and refresh CDS cache\nContent for delivery is cached in CDS and refreshed automatically every hour.\nThis command triggers a refresh of cached content on the fly.\n\nBy default, invalidation does not remove existing cached content, but\nstarts the process of updating with latest translations from Transifex.\n\nPassing the --purge option, cached content will be forced to be deleted,\nhowever use that with caution, as it may introduce downtime of\ntranslation delivery to the apps until fresh content is cached in the CDS.\n\nTo invalidate translations some environment variables must be set:\nTRANSIFEX_TOKEN=<Transifex Native Project Token>\nTRANSIFEX_SECRET=<Transifex Native Project Secret>\n(optional) TRANSIFEX_CDS_HOST=<CDS HOST>\n\nor passed as --token=<TOKEN> --secret=<SECRET> parameters\n\nDefault CDS Host is https://cds.svc.transifex.net\n\nExamples:\ntxjs-cli invalidate\ntxjs-cli invalidate --purge\ntxjs-cli invalidate --token=mytoken --secret=mysecret\nTRANSIFEX_TOKEN=mytoken TRANSIFEX_SECRET=mysecret txjs-cli invalidate\n","pluginName":"@transifex/cli","pluginType":"core","aliases":[],"flags":{"purge":{"name":"purge","type":"boolean","description":"force delete CDS cached content","allowNo":false},"token":{"name":"token","type":"option","description":"native project public token","default":""},"secret":{"name":"secret","type":"option","description":"native project secret","default":""},"cds-host":{"name":"cds-host","type":"option","description":"CDS host URL","default":""}},"args":[]},"push":{"id":"push","description":"detect and push source content to Transifex\nParse .js, .ts, .jsx, .tsx and .html files and detect phrases marked for\ntranslation by Transifex Native toolkit for Javascript and\nupload them to Transifex for translation.\n\nTo push content some environment variables must be set:\nTRANSIFEX_TOKEN=<Transifex Native Project Token>\nTRANSIFEX_SECRET=<Transifex Native Project Secret>\n(optional) TRANSIFEX_CDS_HOST=<CDS HOST>\n\nor passed as --token=<TOKEN> --secret=<SECRET> parameters\n\nDefault CDS Host is https://cds.svc.transifex.net\n\nExamples:\ntxjs-cli push -v\ntxjs-cli push src/\ntxjs-cli push /home/repo/src\ntxjs-cli push \"*.js\"\ntxjs-cli push --dry-run\ntxjs-cli push --no-wait\ntxjs-cli push --append-tags=\"master,release:2.5\"\ntxjs-cli push --with-tags-only=\"home,error\"\ntxjs-cli push --without-tags-only=\"custom\"\ntxjs-cli push --token=mytoken --secret=mysecret\nTRANSIFEX_TOKEN=mytoken TRANSIFEX_SECRET=mysecret txjs-cli push\n","pluginName":"@transifex/cli","pluginType":"core","aliases":[],"flags":{"dry-run":{"name":"dry-run","type":"boolean","description":"dry run, do not push to Transifex","allowNo":false},"verbose":{"name":"verbose","type":"boolean","char":"v","description":"verbose output","allowNo":false},"purge":{"name":"purge","type":"boolean","description":"purge content on Transifex","allowNo":false},"no-wait":{"name":"no-wait","type":"boolean","description":"disable polling for upload results","allowNo":false},"token":{"name":"token","type":"option","description":"native project public token","default":""},"secret":{"name":"secret","type":"option","description":"native project secret","default":""},"append-tags":{"name":"append-tags","type":"option","description":"append tags to strings","default":""},"with-tags-only":{"name":"with-tags-only","type":"option","description":"push strings with specific tags","default":""},"without-tags-only":{"name":"without-tags-only","type":"option","description":"push strings without specific tags","default":""},"cds-host":{"name":"cds-host","type":"option","description":"CDS host URL","default":""}},"args":[{"name":"pattern","description":"file pattern to scan for strings","required":false,"default":"**/*.{js,jsx,ts,tsx}"}]}}}
+{"version":"2.0.0-rc1","commands":{"invalidate":{"id":"invalidate","description":"invalidate and refresh CDS cache\nContent for delivery is cached in CDS and refreshed automatically every hour.\nThis command triggers a refresh of cached content on the fly.\n\nBy default, invalidation does not remove existing cached content, but\nstarts the process of updating with latest translations from Transifex.\n\nPassing the --purge option, cached content will be forced to be deleted,\nhowever use that with caution, as it may introduce downtime of\ntranslation delivery to the apps until fresh content is cached in the CDS.\n\nTo invalidate translations some environment variables must be set:\nTRANSIFEX_TOKEN=<Transifex Native Project Token>\nTRANSIFEX_SECRET=<Transifex Native Project Secret>\n(optional) TRANSIFEX_CDS_HOST=<CDS HOST>\n\nor passed as --token=<TOKEN> --secret=<SECRET> parameters\n\nDefault CDS Host is https://cds.svc.transifex.net\n\nExamples:\ntxjs-cli invalidate\ntxjs-cli invalidate --purge\ntxjs-cli invalidate --token=mytoken --secret=mysecret\nTRANSIFEX_TOKEN=mytoken TRANSIFEX_SECRET=mysecret txjs-cli invalidate\n","pluginName":"@transifex/cli","pluginType":"core","aliases":[],"flags":{"purge":{"name":"purge","type":"boolean","description":"force delete CDS cached content","allowNo":false},"token":{"name":"token","type":"option","description":"native project public token","default":""},"secret":{"name":"secret","type":"option","description":"native project secret","default":""},"cds-host":{"name":"cds-host","type":"option","description":"CDS host URL","default":""}},"args":[]},"push":{"id":"push","description":"detect and push source content to Transifex\nParse .js, .ts, .jsx, .tsx and .html files and detect phrases marked for\ntranslation by Transifex Native toolkit for Javascript and\nupload them to Transifex for translation.\n\nTo push content some environment variables must be set:\nTRANSIFEX_TOKEN=<Transifex Native Project Token>\nTRANSIFEX_SECRET=<Transifex Native Project Secret>\n(optional) TRANSIFEX_CDS_HOST=<CDS HOST>\n\nor passed as --token=<TOKEN> --secret=<SECRET> parameters\n\nDefault CDS Host is https://cds.svc.transifex.net\n\nExamples:\ntxjs-cli push -v\ntxjs-cli push src/\ntxjs-cli push /home/repo/src\ntxjs-cli push \"*.js\"\ntxjs-cli push --dry-run\ntxjs-cli push --no-wait\ntxjs-cli push --key-generator=hash\ntxjs-cli push --append-tags=\"master,release:2.5\"\ntxjs-cli push --with-tags-only=\"home,error\"\ntxjs-cli push --without-tags-only=\"custom\"\ntxjs-cli push --token=mytoken --secret=mysecret\nTRANSIFEX_TOKEN=mytoken TRANSIFEX_SECRET=mysecret txjs-cli push\n","pluginName":"@transifex/cli","pluginType":"core","aliases":[],"flags":{"dry-run":{"name":"dry-run","type":"boolean","description":"dry run, do not push to Transifex","allowNo":false},"verbose":{"name":"verbose","type":"boolean","char":"v","description":"verbose output","allowNo":false},"purge":{"name":"purge","type":"boolean","description":"purge content on Transifex","allowNo":false},"no-wait":{"name":"no-wait","type":"boolean","description":"disable polling for upload results","allowNo":false},"token":{"name":"token","type":"option","description":"native project public token","default":""},"secret":{"name":"secret","type":"option","description":"native project secret","default":""},"append-tags":{"name":"append-tags","type":"option","description":"append tags to strings","default":""},"with-tags-only":{"name":"with-tags-only","type":"option","description":"push strings with specific tags","default":""},"without-tags-only":{"name":"without-tags-only","type":"option","description":"push strings without specific tags","default":""},"cds-host":{"name":"cds-host","type":"option","description":"CDS host URL","default":""},"key-generator":{"name":"key-generator","type":"option","description":"use hashed or source based keys","options":["source","hash"],"default":"source"}},"args":[{"name":"pattern","description":"file pattern to scan for strings","required":false,"default":"**/*.{js,jsx,ts,tsx}"}]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@transifex/cli",
   "description": "Transifex Native CLI",
-  "version": "1.0.5",
+  "version": "2.0.0-rc1",
   "author": "Transifex",
   "keywords": [
     "transifex",
@@ -27,9 +27,9 @@
     "@oclif/config": "^1.17.0",
     "@oclif/errors": "^1.3.4",
     "@oclif/plugin-help": "^3.2.1",
-    "@transifex/native": "^1.0.5",
+    "@transifex/native": "^2.0.0-rc1",
     "angular-html-parser": "^1.7.1",
-    "axios": "^0.21.1",
+    "axios": "^0.24.0",
     "cli-ux": "^5.5.1",
     "colors": "^1.4.0",
     "glob": "^7.1.6",
@@ -44,12 +44,12 @@
     "eslint-config-airbnb-base": "^14.2.1",
     "eslint-plugin-import": "^2.22.1",
     "globby": "^11.0.1",
-    "mocha": "^8.3.1",
+    "mocha": "^9.1.3",
     "nock": "^13.0.11",
     "nyc": "^15.1.0"
   },
   "engines": {
-    "node": ">=10.0.0"
+    "node": ">=12.0.0"
   },
   "files": [
     "/bin",

package/src/api/extract.js

@@ -6,7 +6,7 @@ const babelParser = require('@babel/parser');
 const babelTraverse = require('@babel/traverse').default;
 const _ = require('lodash');
 const path = require('path');
-const { generateKey } = require('@transifex/native');
+const { generateKey, generateHashedKey } = require('@transifex/native');
 
 const { mergePayload } = require('./merge');
 const { stringToArray, mergeArrays } = require('./utils');
@@ -21,27 +21,21 @@ const { stringToArray, mergeArrays } = require('./utils');
  * @param {Number} params._charlimit
  * @param {Number} params._tags
  * @param {String} occurence
- * @param {String[]} appendTags
- * @returns {Object} Payload
- * @returns {String} Payload.string
- * @returns {String} Payload.key
- * @returns {String} Payload.meta.context
- * @returns {String} Payload.meta.developer_comment
- * @returns {Number} Payload.meta.character_limit
- * @returns {String[]} Payload.meta.tags
- * @returns {String[]} Payload.meta.occurrences
+ * @param {Object} options
  */
-function createPayload(string, params, occurence, appendTags) {
+function createPayload(string, params, occurence, options = {}) {
   return {
     string,
-    key: generateKey(string, params),
+    key: options.useHashedKeys
+      ? generateHashedKey(string, params)
+      : generateKey(string, params),
     meta: _.omitBy({
       context: stringToArray(params._context || params.context),
       developer_comment: params._comment || params.comment,
       character_limit: params._charlimit || params.charlimit
         ? parseInt(params._charlimit || params.charlimit, 10)
         : undefined,
-      tags: mergeArrays(stringToArray(params._tags || params.tags), appendTags),
+      tags: mergeArrays(stringToArray(params._tags || params.tags), options.appendTags),
       occurrences: [occurence],
     }, _.isNil),
   };
@@ -132,8 +126,7 @@ function looseJsonParse(obj) {
  * @param {Object} options
  * @returns void
  */
-function parseHTMLTemplateFile(HASHES, filename, relativeFile,
-  appendTags, options) {
+function parseHTMLTemplateFile(HASHES, filename, relativeFile, options) {
   const TXComponents = [];
   const TXTemplateStrings = [];
 
@@ -228,7 +221,7 @@ function parseHTMLTemplateFile(HASHES, filename, relativeFile,
       });
     }
     if (string) {
-      const partial = createPayload(string, params, relativeFile, appendTags);
+      const partial = createPayload(string, params, relativeFile, options);
       if (!isPayloadValid(partial, options)) return;
 
       mergePayload(HASHES, {
@@ -247,7 +240,7 @@ function parseHTMLTemplateFile(HASHES, filename, relativeFile,
       key = txStr.params.key;
     }
 
-    const partial = createPayload(txStr.string, txStr.params, relativeFile, appendTags);
+    const partial = createPayload(txStr.string, txStr.params, relativeFile, options);
     if (!isPayloadValid(partial, options)) return;
 
     mergePayload(HASHES, {
@@ -374,10 +367,10 @@ function findDeclaredValue(scope, init) {
  * @param {String[]} options.appendTags
  * @param {String[]} options.filterWithTags
  * @param {String[]} options.filterWithoutTags
+ * @param {Boolean} options.useHashedKeys
  * @returns {Object}
  */
 function extractPhrases(file, relativeFile, options = {}) {
-  const { appendTags } = options;
   const HASHES = {};
   const source = fs.readFileSync(file, 'utf8');
   if (path.extname(file) !== '.html') {
@@ -410,7 +403,7 @@ function extractPhrases(file, relativeFile, options = {}) {
           });
         }
 
-        const partial = createPayload(string, params, relativeFile, appendTags);
+        const partial = createPayload(string, params, relativeFile, options);
         if (!isPayloadValid(partial, options)) return;
 
         mergePayload(HASHES, {
@@ -446,7 +439,7 @@ function extractPhrases(file, relativeFile, options = {}) {
         });
 
         if (string) {
-          const partial = createPayload(string, params, relativeFile, appendTags);
+          const partial = createPayload(string, params, relativeFile, options);
           if (!isPayloadValid(partial, options)) return;
 
           mergePayload(HASHES, {
@@ -483,7 +476,7 @@ function extractPhrases(file, relativeFile, options = {}) {
 
         if (!string) return;
 
-        const partial = createPayload(string, params, relativeFile, appendTags);
+        const partial = createPayload(string, params, relativeFile, options);
         if (!isPayloadValid(partial, options)) return;
 
         mergePayload(HASHES, {
@@ -495,7 +488,7 @@ function extractPhrases(file, relativeFile, options = {}) {
       },
     });
   } else if (path.extname(file) === '.html') {
-    parseHTMLTemplateFile(HASHES, file, relativeFile, appendTags, options);
+    parseHTMLTemplateFile(HASHES, file, relativeFile, options);
   }
 
   return HASHES;

package/src/commands/push.js

@@ -44,6 +44,7 @@ class PushCommand extends Command {
     const appendTags = stringToArray(flags['append-tags']);
     const filterWithTags = stringToArray(flags['with-tags-only']);
     const filterWithoutTags = stringToArray(flags['without-tags-only']);
+    const useHashedKeys = flags['key-generator'] === 'hash';
 
     this.log('Parsing all files to detect translatable content...');
 
@@ -71,6 +72,7 @@ class PushCommand extends Command {
       appendTags,
       filterWithTags,
       filterWithoutTags,
+      useHashedKeys,
     };
 
     _.each(allFiles, (file) => {
@@ -244,6 +246,7 @@ txjs-cli push /home/repo/src
 txjs-cli push "*.js"
 txjs-cli push --dry-run
 txjs-cli push --no-wait
+txjs-cli push --key-generator=hash
 txjs-cli push --append-tags="master,release:2.5"
 txjs-cli push --with-tags-only="home,error"
 txjs-cli push --without-tags-only="custom"
@@ -300,6 +303,11 @@ PushCommand.flags = {
     description: 'CDS host URL',
     default: '',
   }),
+  'key-generator': flags.string({
+    description: 'use hashed or source based keys',
+    default: 'source',
+    options: ['source', 'hash'],
+  }),
 };
 
 module.exports = PushCommand;