feat(@formatjs/cli): Add option to ignore a glob of files (#564)

Co-authored-by: Donovan Hiland <[email protected]>

Author: longlho

.all-contributorsrc

@@ -26,6 +26,16 @@
         "test",
         "code"
       ]
+    },
+    {
+      "login": "donovanhiland",
+      "name": "Donovan Hiland",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/17991396?v=4",
+      "profile": "https://github.com/donovanhiland",
+      "contributions": [
+        "code",
+        "test",
+      ]
     }
   ],
   "contributorsPerLine": 7,

README.md

@@ -2,7 +2,7 @@
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 
-[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
 
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
@@ -62,6 +62,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
   <tr>
     <td align="center"><a href="https://github.com/pyrocat101"><img src="https://avatars0.githubusercontent.com/u/541540?v=4" width="100px;" alt=""/><br /><sub><b>Linjie Ding</b></sub></a><br /><a href="#infra-pyrocat101" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/formatjs/formatjs/commits?author=pyrocat101" title="Tests">⚠️</a> <a href="https://github.com/formatjs/formatjs/commits?author=pyrocat101" title="Code">💻</a></td>
     <td align="center"><a href="https://medium.com/@longho"><img src="https://avatars1.githubusercontent.com/u/198255?v=4" width="100px;" alt=""/><br /><sub><b>Long Ho</b></sub></a><br /><a href="#infra-longlho" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/formatjs/formatjs/commits?author=longlho" title="Tests">⚠️</a> <a href="https://github.com/formatjs/formatjs/commits?author=longlho" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/donovanhiland"><img src="https://avatars2.githubusercontent.com/u/17991396?v=4" width="100px;" alt=""/><br /><sub><b>Donovan Hiland</b></sub></a><br /><a href="https://github.com/formatjs/formatjs/commits?author=donovanhiland" title="Code">💻</a><a href="https://github.com/formatjs/formatjs/commits?author=longlho" title="Tests">⚠️</a></td>
   </tr>
 </table>
 

packages/cli/README.md

@@ -41,5 +41,6 @@ Options:
                                                         restrictions, e.g: has to be called with object literal such as
                                                         `intl.formatMessage({ id: 'foo', defaultMessage: 'bar',
                                                         description: 'baz'})` (default: false)
+  --ignore                                              List of glob paths to **not** extract translations from.
   -h, --help                                            output usage information
 ```

packages/cli/src/cli.ts

@@ -98,17 +98,21 @@ async function main(argv: string[]) {
       ].join(''),
       false
     )
+    .option(
+      '--ignore <files>',
+      'List of glob paths to **not** extract translations from.'
+    )
     .action(async (files: readonly string[], cmdObj: ExtractCLIOptions) => {
-      files = files.reduce(
-        (all: string[], f) =>
-          all.concat(
-            globSync(f, {
-              cwd: process.cwd(),
-            })
-          ),
-        []
-      );
-      await extract(files, {
+      const processedFiles = [];
+      for (const f of files) {
+        processedFiles.push(
+          ...globSync(f, {
+            cwd: process.cwd(),
+            ignore: cmdObj.ignore,
+          })
+        );
+      }
+      await extract(processedFiles, {
         outFile: cmdObj.outFile,
         idInterpolationPattern:
           cmdObj.idInterpolationPattern || '[contenthash:5]',

packages/cli/src/extract.ts

@@ -5,10 +5,12 @@ import {warn, getStdinAsString} from './console_utils';
 import keyBy from 'lodash/keyBy';
 import {outputJSONSync} from 'fs-extra';
 import {interpolateName} from 'loader-utils';
+import {IOptions as GlobOptions} from 'glob';
 
 export type ExtractCLIOptions = Omit<OptionsSchema, 'overrideIdFn'> & {
   outFile?: string;
   idInterpolationPattern?: string;
+  ignore?: GlobOptions['ignore'];
 };
 
 function getBabelConfig(

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

@@ -2,6 +2,10 @@
 
 exports[`[glob] basic case: defineMessages -> stdout 1`] = `
 Array [
+  Object {
+    "defaultMessage": "ignore",
+    "id": "ignore",
+  },
   Object {
     "defaultMessage": "Hello World!",
     "description": "The default message",
@@ -128,10 +132,90 @@ 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)
+  --ignore <files>                                      List of glob paths to **not** extract translations from.
   -h, --help                                            output usage information
 "
 `;
 
+exports[`ignore -> stdout 1`] = `
+Array [
+  Object {
+    "defaultMessage": "Hello World!",
+    "description": "The default message",
+    "id": "foo.bar.baz",
+  },
+  Object {
+    "defaultMessage": "Hello Nurse!",
+    "description": "Another message",
+    "id": "foo.bar.biff",
+  },
+  Object {
+    "defaultMessage": "{count, plural, =0 {😭} one {# kitten} other {# kittens}}",
+    "description": "Counts kittens",
+    "id": "app.home.kittens",
+  },
+  Object {
+    "defaultMessage": "   Some whitespace   ",
+    "description": "Whitespace",
+    "id": "trailing.ws",
+  },
+  Object {
+    "defaultMessage": "A quoted value ''{value}'",
+    "description": "Escaped apostrophe",
+    "id": "escaped.apostrophe",
+  },
+  Object {
+    "defaultMessage": "No ID",
+    "description": "no ID",
+    "id": "ae494",
+  },
+  Object {
+    "defaultMessage": "formatted message",
+    "description": "foo",
+    "id": "inline",
+  },
+]
+`;
+
+exports[`ignore -> stdout 2`] = `
+Array [
+  Object {
+    "defaultMessage": "ignore",
+    "id": "ignore",
+  },
+  Object {
+    "defaultMessage": "Hello World!",
+    "description": "The default message",
+    "id": "foo.bar.baz",
+  },
+  Object {
+    "defaultMessage": "Hello Nurse!",
+    "description": "Another message",
+    "id": "foo.bar.biff",
+  },
+  Object {
+    "defaultMessage": "{count, plural, =0 {😭} one {# kitten} other {# kittens}}",
+    "description": "Counts kittens",
+    "id": "app.home.kittens",
+  },
+  Object {
+    "defaultMessage": "   Some whitespace   ",
+    "description": "Whitespace",
+    "id": "trailing.ws",
+  },
+  Object {
+    "defaultMessage": "A quoted value ''{value}'",
+    "description": "Escaped apostrophe",
+    "id": "escaped.apostrophe",
+  },
+  Object {
+    "defaultMessage": "No ID",
+    "description": "no ID",
+    "id": "ae494",
+  },
+]
+`;
+
 exports[`typescript -> stdout 1`] = `
 Array [
   Object {

packages/cli/tests/extract/integration_tests/defineMessages/actual.ignore.js

@@ -0,0 +1,21 @@
+import React, {Component} from 'react';
+import {defineMessages, FormattedMessage} from 'react-intl';
+
+const msgs = defineMessages({
+  test: {
+    id: 'ignore',
+    defaultMessage: 'ignore',
+  },
+});
+
+export default class Foo extends Component {
+  render() {
+    return (
+      <div>
+        <h1>
+          <FormattedMessage {...msgs.test} />
+        </h1>
+      </div>
+    );
+  }
+}

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

@@ -59,3 +59,25 @@ test('typescript -> stdout', async () => {
   expect(JSON.parse(stdout)).toMatchSnapshot();
   expect(stderr).toBe('');
 }, 10000);
+
+test('ignore -> stdout', async () => {
+  const ignore = "--ignore '*.ignore.*'";
+
+  const tsResult = await exec(
+    `${BIN_PATH} extract ${path.join(
+      __dirname,
+      'typescript/actual.tsx'
+    )} ${ignore}`
+  );
+  expect(JSON.parse(tsResult.stdout)).toMatchSnapshot();
+  expect(tsResult.stderr).toBe('');
+
+  const jsResult = await exec(
+    `${BIN_PATH} extract ${path.join(
+      __dirname,
+      'defineMessages/*.js'
+    )} ${ignore}`
+  );
+  expect(JSON.parse(jsResult.stdout)).toMatchSnapshot();
+  expect(jsResult.stderr).toBe('');
+}, 10000);

packages/cli/tests/extract/integration_tests/typescript/actual.ignore.tsx

@@ -0,0 +1,21 @@
+import React, {Component} from 'react';
+import {defineMessages, FormattedMessage} from 'react-intl';
+
+const msgs = defineMessages({
+  test: {
+    id: 'ignore',
+    defaultMessage: 'ignore',
+  },
+});
+
+export default class Foo extends Component {
+  render() {
+    return (
+      <div>
+        <h1>
+          <FormattedMessage {...msgs.test} />
+        </h1>
+      </div>
+    );
+  }
+}

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

@@ -1,5 +1,7 @@
 import cliMain from '../../src/cli';
 import {OptionsSchema} from 'babel-plugin-react-intl/dist/options';
+const glob = require('glob');
+const babel = require('@babel/core');
 
 jest.mock('@babel/core', () => {
   const mockBabelResult = {
@@ -13,13 +15,12 @@ jest.mock('@babel/core', () => {
     transformFileSync: jest.fn().mockReturnValue(mockBabelResult),
   };
 });
-const babel = require('@babel/core');
 
 // Commander.js will call this.
 jest.spyOn(process, 'exit').mockImplementation((() => null) as any);
 
 jest.mock('glob', () => ({
-  sync: (p: string) => [p],
+  sync: jest.fn((p: string) => [p]),
 }));
 
 beforeEach(() => {
@@ -38,6 +39,7 @@ test('it passes camelCase-converted arguments to babel API', () => {
     '--extract-from-format-message-call',
     '--additional-component-names',
     'Foo,Bar',
+    '--ignore=file3.ts',
     'file1.js',
     'file2.tsx',
   ]);
@@ -81,3 +83,20 @@ test('it passes camelCase-converted arguments to babel API', () => {
     })
   );
 });
+
+test('it passes ignore argument to glob sync', () => {
+  cliMain([
+    'node',
+    'path/to/formatjs-cli',
+    'extract',
+    '--ignore=ignore-1.ts',
+    'include-1.js',
+  ]);
+
+  expect(glob.sync).toHaveBeenCalled();
+  expect(glob.sync).toHaveBeenNthCalledWith(
+    1,
+    'include-1.js',
+    expect.objectContaining({ignore: 'ignore-1.ts'})
+  );
+});