@formatjs/cli 5.0.7 → 5.0.8

package/integration-tests/compile/glob/en.json

@@ -0,0 +1,14 @@
+{
+  "ashd2": {
+    "defaultMessage": "a message",
+    "description": "foo"
+  },
+  "a1dd2": {
+    "defaultMessage": "my name is {name}",
+    "description": "foo"
+  },
+  "a1d12": {
+    "defaultMessage": "I have {count, plural, one{a dog} other{many dogs}}",
+    "description": "foo"
+  }
+}

package/integration-tests/compile/glob/en2.json

@@ -0,0 +1,14 @@
+{
+  "1": {
+    "defaultMessage": "a message",
+    "description": "foo"
+  },
+  "2": {
+    "defaultMessage": "my name is {name}",
+    "description": "foo"
+  },
+  "3": {
+    "defaultMessage": "I have {count, plural, one{a dog} other{many dogs}}",
+    "description": "foo"
+  }
+}

package/integration-tests/compile/glob-conflict/en.json

@@ -0,0 +1,14 @@
+{
+  "ashd2": {
+    "defaultMessage": "a message",
+    "description": "foo"
+  },
+  "a1dd2": {
+    "defaultMessage": "my name is {name}",
+    "description": "foo"
+  },
+  "a1d12": {
+    "defaultMessage": "I have {count, plural, one{a dog} other{many dogs}}",
+    "description": "foo"
+  }
+}

package/integration-tests/compile/glob-conflict/en2.json

@@ -0,0 +1,14 @@
+{
+  "1": {
+    "defaultMessage": "a message",
+    "description": "foo"
+  },
+  "2": {
+    "defaultMessage": "my name is {name}",
+    "description": "foo"
+  },
+  "a1d12": {
+    "defaultMessage": "I have {count, plural, one{a dog} other{many cats}}",
+    "description": "foo"
+  }
+}

package/integration-tests/compile/integration.test.ts

@@ -0,0 +1,213 @@
+import {exec as nodeExec} from 'child_process'
+import {join, resolve} from 'path'
+import _rimraf from 'rimraf'
+import {promisify} from 'util'
+const exec = promisify(nodeExec)
+const BIN_PATH = require.resolve('@formatjs/cli/bin/formatjs')
+const ARTIFACT_PATH = resolve(__dirname, 'test_artifacts')
+
+test('basic case: help', async () => {
+  await expect(exec(`${BIN_PATH} compile --help`)).resolves.toMatchSnapshot()
+}, 20000)
+
+test('basic case: empty json', async () => {
+  await expect(
+    exec(`${BIN_PATH} compile ${join(__dirname, 'lang/empty.json')}`)
+  ).resolves.toMatchSnapshot()
+}, 20000)
+
+test('normal json', async () => {
+  await expect(
+    exec(`${BIN_PATH} compile ${join(__dirname, 'lang/en.json')}`)
+  ).resolves.toMatchSnapshot()
+}, 20000)
+
+test('xx-LS json', async () => {
+  await expect(
+    exec(
+      `${BIN_PATH} compile --ast --pseudo-locale xx-LS ${join(
+        __dirname,
+        'lang/en.json'
+      )}`
+    )
+  ).resolves.toMatchSnapshot()
+}, 20000)
+
+test('xx-HA json', async () => {
+  await expect(
+    exec(
+      `${BIN_PATH} compile --ast --pseudo-locale xx-HA ${join(
+        __dirname,
+        'lang/en.json'
+      )}`
+    )
+  ).resolves.toMatchSnapshot()
+}, 20000)
+
+test('xx-AC json', async () => {
+  await expect(
+    exec(
+      `${BIN_PATH} compile --ast --pseudo-locale xx-AC ${join(
+        __dirname,
+        'lang/en.json'
+      )}`
+    )
+  ).resolves.toMatchSnapshot()
+}, 20000)
+
+test('en-XA json', async () => {
+  await expect(
+    exec(
+      `${BIN_PATH} compile --ast --pseudo-locale en-XA ${join(
+        __dirname,
+        'lang/en.json'
+      )}`
+    )
+  ).resolves.toMatchSnapshot()
+}, 20000)
+
+test('en-XB json', async () => {
+  await expect(
+    exec(
+      `${BIN_PATH} compile --ast --pseudo-locale en-XB ${join(
+        __dirname,
+        'lang/en.json'
+      )}`
+    )
+  ).resolves.toMatchSnapshot()
+}, 20000)
+
+test('normal json with formatter', async () => {
+  await expect(
+    exec(
+      `${BIN_PATH} compile ${join(
+        __dirname,
+        'lang/en-format.json'
+      )} --format ${join(__dirname, '../formatter.js')}`
+    )
+  ).resolves.toMatchSnapshot()
+}, 20000)
+
+test('normal json with transifex', async () => {
+  await expect(
+    exec(
+      `${BIN_PATH} compile ${join(
+        __dirname,
+        'lang/en-transifex.json'
+      )} --format transifex`
+    )
+  ).resolves.toMatchSnapshot()
+}, 20000)
+
+test('normal json with smartling', async () => {
+  await expect(
+    exec(
+      `${BIN_PATH} compile ${join(
+        __dirname,
+        'lang/en-smartling.json'
+      )} --format smartling`
+    )
+  ).resolves.toMatchSnapshot()
+}, 20000)
+
+test('normal json with simple', async () => {
+  await expect(
+    exec(
+      `${BIN_PATH} compile ${join(
+        __dirname,
+        'lang/en-simple.json'
+      )} --format simple`
+    )
+  ).resolves.toMatchSnapshot()
+}, 20000)
+
+test('normal json with lokalise', async () => {
+  await expect(
+    exec(
+      `${BIN_PATH} compile ${join(
+        __dirname,
+        'lang/en-lokalise.json'
+      )} --format lokalise`
+    )
+  ).resolves.toMatchSnapshot()
+}, 20000)
+
+test('normal json with crowdin', async () => {
+  await expect(
+    exec(
+      `${BIN_PATH} compile ${join(
+        __dirname,
+        'lang/en-crowdin.json'
+      )} --format crowdin`
+    )
+  ).resolves.toMatchSnapshot()
+}, 20000)
+
+test('malformed ICU message json', async () => {
+  await expect(
+    exec(
+      `${BIN_PATH} compile ${join(__dirname, 'lang/malformed-messages.json')}`
+    )
+  ).rejects.toThrowError('SyntaxError: EXPECT_ARGUMENT_CLOSING_BRACE')
+}, 20000)
+
+test('skipped malformed ICU message json', async () => {
+  await expect(
+    exec(
+      `${BIN_PATH} compile  --skip-errors ${join(
+        __dirname,
+        'lang/malformed-messages.json'
+      )}`
+    )
+  ).resolves.toMatchSnapshot({
+    stderr: expect.stringMatching(
+      /^\[@formatjs\/cli\] \[WARN\] Error validating message "my name is {name" with ID "a1dd2" in file .*\/packages\/cli\/integration-tests\/compile\/lang\/malformed-messages.json/
+    ),
+  } as Partial<any>)
+}, 20000)
+
+test('AST', async () => {
+  await expect(
+    exec(`${BIN_PATH} compile --ast ${join(__dirname, 'lang/en.json')}`)
+  ).resolves.toMatchSnapshot()
+}, 20000)
+
+test('out-file', async () => {
+  const outFilePath = join(ARTIFACT_PATH, 'en.json')
+  await expect(
+    exec(
+      `${BIN_PATH} compile ${join(
+        __dirname,
+        'lang/en.json'
+      )} --out-file ${outFilePath}`
+    )
+  ).resolves.toMatchSnapshot()
+  expect(require(outFilePath)).toMatchSnapshot()
+}, 20000)
+
+test('out-file --ast', async () => {
+  const outFilePath = join(ARTIFACT_PATH, 'ast.json')
+  await expect(
+    exec(
+      `${BIN_PATH} compile --ast ${join(
+        __dirname,
+        'lang/en.json'
+      )} --out-file ${outFilePath}`
+    )
+  ).resolves.toMatchSnapshot()
+  expect(require(outFilePath)).toMatchSnapshot()
+}, 20000)
+
+test('compile glob', async () => {
+  await expect(
+    exec(`${BIN_PATH} compile "${join(__dirname, 'glob/*.json')}"`)
+  ).resolves.toMatchSnapshot()
+})
+
+test('compile glob with conflict', async () => {
+  await expect(
+    exec(`${BIN_PATH} compile "${join(__dirname, 'glob-conflict/*.json')}"`)
+  ).rejects.toThrowError(
+    'Conflicting ID "a1d12" with different translation found in these 2 files'
+  )
+})

package/integration-tests/compile/lang/empty.json

@@ -0,0 +1 @@
+{}

package/integration-tests/compile/lang/en-crowdin.json

@@ -0,0 +1,14 @@
+{
+  "ashd2": {
+    "message": "a message",
+    "description": "foo"
+  },
+  "a1dd2": {
+    "message": "my name is {name}",
+    "description": "foo"
+  },
+  "a1d12": {
+    "message": "I have {count, plural, one{a dog} other{many dogs}}",
+    "description": "foo"
+  }
+}

package/integration-tests/compile/lang/en-format.json

@@ -0,0 +1,14 @@
+{
+  "ashd2": {
+    "string": "a message",
+    "comment": "foo"
+  },
+  "a1dd2": {
+    "string": "my name is {name}",
+    "comment": "foo"
+  },
+  "a1d12": {
+    "string": "I have {count, plural, one{a dog} other{many dogs}}",
+    "comment": "foo"
+  }
+}

package/integration-tests/compile/lang/en-lokalise.json

@@ -0,0 +1,14 @@
+{
+  "ashd2": {
+    "translation": "a message",
+    "notes": "foo"
+  },
+  "a1dd2": {
+    "translation": "my name is {name}",
+    "notes": "foo"
+  },
+  "a1d12": {
+    "translation": "I have {count, plural, one{a dog} other{many dogs}}",
+    "notes": "foo"
+  }
+}

package/integration-tests/compile/lang/en-simple.json

@@ -0,0 +1,5 @@
+{
+  "ashd2": "a message",
+  "a1dd2": "my name is {name}",
+  "a1d12": "I have {count, plural, one{a dog} other{many dogs}}"
+}

package/integration-tests/compile/lang/en-smartling.json

@@ -0,0 +1,24 @@
+{
+  "smartling": {
+    "translate_paths": [
+      {
+        "path": "*/message",
+        "key": "{*}/message",
+        "instruction": "*/description"
+      }
+    ],
+    "variants_enabled": true
+  },
+  "ashd2": {
+    "message": "a message",
+    "description": "foo"
+  },
+  "a1dd2": {
+    "message": "my name is {name}",
+    "description": "foo"
+  },
+  "a1d12": {
+    "message": "I have {count, plural, one{a dog} other{many dogs}}",
+    "description": "foo"
+  }
+}

package/integration-tests/compile/lang/en-transifex.json

@@ -0,0 +1,14 @@
+{
+  "ashd2": {
+    "string": "a message",
+    "comment": "foo"
+  },
+  "a1dd2": {
+    "string": "my name is {name}",
+    "comment": "foo"
+  },
+  "a1d12": {
+    "string": "I have {count, plural, one{a dog} other{many dogs}}",
+    "comment": "foo"
+  }
+}

package/integration-tests/compile/lang/en.json

@@ -0,0 +1,22 @@
+{
+  "ashd2": {
+    "defaultMessage": "a message",
+    "description": "foo"
+  },
+  "a1dd2": {
+    "defaultMessage": "my name is {name}",
+    "description": "foo"
+  },
+  "a1d12": {
+    "defaultMessage": "I have {count, plural, one{a dog} other{many dogs}}",
+    "description": "foo"
+  },
+  "a1d13": {
+    "defaultMessage": "I have {count, plural, one{<b>a dog</b>} other{many dogs}}",
+    "description": "foo"
+  },
+  "a1d14": {
+    "defaultMessage": "I have {count, plural, one{<b>a <i>dog</i></b>} other{many dogs}}",
+    "description": "foo"
+  }
+}

package/integration-tests/compile/lang/malformed-messages.json

@@ -0,0 +1,14 @@
+{
+  "ashd2": {
+    "defaultMessage": "a message",
+    "description": "foo"
+  },
+  "a1dd2": {
+    "defaultMessage": "my name is {name",
+    "description": "foo"
+  },
+  "a1d12": {
+    "defaultMessage": "I have {count, plural, one{a dog} other{many dogs}}",
+    "description": "foo"
+  }
+}

package/integration-tests/compile_folder/__snapshots__/integration.test.ts.snap

@@ -0,0 +1,44 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`basic case 1`] = `
+Array [
+  Object {},
+  Object {
+    "a1d12": "I have {count, plural, one{a dog} other{many dogs}}",
+    "a1dd2": "my name is {name}",
+    "ashd2": "a message",
+  },
+  Object {
+    "1": "another message",
+    "2": "my name is {foo}",
+    "3": "I have {count, plural, one{a cat} other{many cats}}",
+  },
+]
+`;
+
+exports[`basic case: help 1`] = `
+Object {
+  "stderr": "",
+  "stdout": "Usage: formatjs compile-folder [options] <folder> <outFolder>
+
+Batch compile all extracted translation JSON files in <folder> to <outFolder> containing
+react-intl consumable JSON. We also verify that the messages are 
+valid ICU and not malformed.
+
+Options:
+  --format <path>  Path to a formatter file that converts JSON files in \`<folder>\` to \`Record<string, string>\`
+  so we can compile. The file must export a function named \`compile\` with the signature:
+  \`\`\`
+  type CompileFn = <T = Record<string, MessageDescriptor>>(
+    msgs: T
+  ) => Record<string, string>;
+  \`\`\`
+  This is especially useful to convert from a TMS-specific format back to react-intl format
+  
+  --ast            Whether to compile to AST. See
+                   https://formatjs.io/docs/guides/advanced-usage#pre-parsing-messages
+                   for more information
+  -h, --help       display help for command
+",
+}
+`;

package/integration-tests/compile_folder/integration.test.ts

@@ -0,0 +1,33 @@
+import {exec as nodeExec} from 'child_process'
+import {join} from 'path'
+import _rimraf from 'rimraf'
+import {promisify} from 'util'
+import {sync as globSync} from 'fast-glob'
+import {basename} from 'path'
+import {mkdtempSync} from 'fs'
+import {readJSON} from 'fs-extra'
+const exec = promisify(nodeExec)
+const BIN_PATH = require.resolve('@formatjs/cli/bin/formatjs')
+
+test('basic case: help', async () => {
+  await expect(
+    exec(`${BIN_PATH} compile-folder --help`)
+  ).resolves.toMatchSnapshot()
+}, 20000)
+
+test('basic case', async () => {
+  const inputFiles = globSync(`${__dirname}/lang/*.json`)
+  const outFolder = mkdtempSync('formatjs-cli')
+  await exec(
+    `${BIN_PATH} compile-folder ${join(__dirname, 'lang')} ${outFolder}`
+  )
+
+  const outputFiles = globSync(`${outFolder}/*.json`)
+  expect(outputFiles.map(f => basename(f))).toEqual(
+    inputFiles.map(f => basename(f))
+  )
+
+  await expect(
+    Promise.all(outputFiles.map(f => readJSON(f)))
+  ).resolves.toMatchSnapshot()
+}, 20000)

package/integration-tests/compile_folder/lang/empty.json

@@ -0,0 +1 @@
+{}

package/integration-tests/compile_folder/lang/en.json

@@ -0,0 +1,14 @@
+{
+  "ashd2": {
+    "defaultMessage": "a message",
+    "description": "foo"
+  },
+  "a1dd2": {
+    "defaultMessage": "my name is {name}",
+    "description": "foo"
+  },
+  "a1d12": {
+    "defaultMessage": "I have {count, plural, one{a dog} other{many dogs}}",
+    "description": "foo"
+  }
+}

package/integration-tests/compile_folder/lang/en2.json

@@ -0,0 +1,14 @@
+{
+  "1": {
+    "defaultMessage": "another message",
+    "description": "foo"
+  },
+  "2": {
+    "defaultMessage": "my name is {foo}",
+    "description": "foo"
+  },
+  "3": {
+    "defaultMessage": "I have {count, plural, one{a cat} other{many cats}}",
+    "description": "foo"
+  }
+}