chore(@formatjs/cli): update CLI docs

Author: Long Ho

packages/babel-plugin-react-intl/test/fixtures/overrideIdFn/actual.js

@@ -1,8 +1,5 @@
 import React, {Component} from 'react';
-import {
-  defineMessages,
-  FormattedMessage,
-} from 'react-intl';
+import {defineMessages, FormattedMessage} from 'react-intl';
 
 const msgs = defineMessages({
   header: {

packages/cli/README.md

@@ -34,7 +34,7 @@ Options:
                                                         (default: false)
   --additional-component-names <comma-separated-names>  Additional component names to extract messages from, e.g:
                                                         `['FormattedFooBarMessage']`. **NOTE**: By default we check for
-                                                        the fact that `FormattedMessage` & `FormattedHTMLMessage` are
+                                                        the fact that `FormattedMessage` are
                                                         imported from `moduleSourceName` to make sure variable alias
                                                         works. This option does not do that so it's less safe.
   --extract-from-format-message-call                    Opt-in to extract from `intl.formatMessage` call with the same

packages/cli/src/cli.ts

@@ -83,8 +83,8 @@ async function main(argv: string[]) {
       '--additional-component-names <comma-separated-names>',
       [
         "Additional component names to extract messages from, e.g: `['FormattedFooBarMessage']`. ",
-        '**NOTE**: By default we check for the fact that `FormattedMessage` & ',
-        '`FormattedHTMLMessage` are imported from `moduleSourceName` to make sure variable alias ',
+        '**NOTE**: By default we check for the fact that `FormattedMessage` ',
+        'is imported from `moduleSourceName` to make sure variable alias ',
         "works. This option does not do that so it's less safe.",
       ].join(''),
       (val: string) => val.split(',')

packages/cli/tests/extract/integration_tests/__snapshots__/index.test.ts.snap

@@ -132,6 +132,7 @@ Options:
   --remove-default-message                              Remove \`defaultMessage\` field in generated js after extraction (default: false)
   --additional-component-names <comma-separated-names>  Additional component names to extract messages from, e.g: \`['FormattedFooBarMessage']\`. **NOTE**: By default we check for the fact that \`FormattedMessage\` & \`FormattedHTMLMessage\` are imported from \`moduleSourceName\` to make sure variable alias works. This option does not do that so it's less safe.
   --extract-from-format-message-call                    Opt-in to extract from \`intl.formatMessage\` call with the same restrictions, e.g: has to be called with object literal such as \`intl.formatMessage({ id: 'foo', defaultMessage: 'bar', description: 'baz'})\` (default: false)
+  --output-empty-json                                   Output file with empty [] if src has no messages. For build systems like bazel that relies on specific output mapping, not writing out a file can cause issues. (default: false)
   --ignore <files>                                      List of glob paths to **not** extract translations from.
   -h, --help                                            output usage information
 "

packages/cli/tests/extract/unit.test.ts

@@ -63,6 +63,7 @@ test('it passes camelCase-converted arguments to babel API', () => {
           require.resolve('babel-plugin-react-intl'),
           {
             ...pluginOptions,
+            outputEmptyJson: false,
             overrideIdFn: expect.any(Function),
           },
         ],
@@ -77,7 +78,11 @@ test('it passes camelCase-converted arguments to babel API', () => {
       plugins: [
         [
           require.resolve('babel-plugin-react-intl'),
-          {...pluginOptions, overrideIdFn: expect.any(Function)},
+          {
+            ...pluginOptions,
+            outputEmptyJson: false,
+            overrideIdFn: expect.any(Function),
+          },
         ],
       ],
     })