feat: Expose FbtCommonConstants as a babel-plugin-fbt option

Summary: Enable providing common strings in babel-plugin-fbt as an option Reviewed By: fantazic Differential Revision: D18672440 fbshipit-source-id: 160a489d5207ed8e907fb50c61dfe47499caaf23
facebook · Nov 25, 2019 · 26c5cd8 · 26c5cd8
1 parent 0f68f7f
commit 26c5cd8
Show file tree

Hide file tree

Showing 10 changed files with 74 additions and 225 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -64,6 +64,9 @@ We haven't had the best track record of code/feature changes before this date, b
 
   </details>
 
+- 0.12.0:
+  - Support common strings as plugin option
+
 - 0.11.1:
   - Remove #!shebang from bin scripts and point to wrappers in `node_modules/.bin` shortcut paths
 

diff --git a/packages/babel-plugin-fbt/FbtCommon.js b/packages/babel-plugin-fbt/FbtCommon.js
@@ -0,0 +1,35 @@
+/**
+ * Copyright 2004-present Facebook. All Rights Reserved.
+ *
+ * @flow
+ */
+
+'use strict';
+
+/*::
+type FbtCommonMap = {
+  [text: string]: string
+}
+*/
+
+const textToDesc /*: FbtCommonMap*/ = {};
+
+const FbtCommon = {
+  init(
+    opts /*: {fbtCommon?: FbtCommonMap, fbtCommonPath?: string} */ = {},
+  ) /*: void */ {
+    if (opts.fbtCommon) {
+      Object.assign(textToDesc, opts.fbtCommon);
+    }
+    if (opts.fbtCommonPath != null) {
+      // $FlowFixMe - dynamic require
+      Object.assign(textToDesc, require(opts.fbtCommonPath));
+    }
+  },
+
+  getDesc(text /*: string */) /*: ?string */ {
+    return textToDesc[text];
+  }
+};
+
+module.exports = FbtCommon;
diff --git a/packages/babel-plugin-fbt/FbtCommonConstants.js b/packages/babel-plugin-fbt/FbtCommonConstants.js
diff --git a/packages/babel-plugin-fbt/__tests__/fbs-test.js b/packages/babel-plugin-fbt/__tests__/fbs-test.js
@@ -46,6 +46,11 @@ describe('Test declarative (jsx) <fbs> syntax translation', () => {
         withFbsRequireStatement(`
           const fbsCommonElem = <fbs common={true}>Post</fbs>;
         `),
+        {
+          fbtCommon: {
+            Post: 'Button to post a comment',
+          },
+        },
       ),
     ).toMatchSnapshot();
   });

diff --git a/packages/babel-plugin-fbt/bin/FbtCollector.js b/packages/babel-plugin-fbt/bin/FbtCollector.js
@@ -40,6 +40,7 @@ export type TransformOptions = {|
   filename?: string,
   extraOptions?: mixed,
   fbtEnumManifest?: FbtEnumManifest,
+  fbtCommonPath?: string,
   auxiliaryTexts?: boolean,
   reactNativeMode?: boolean,
 |}
@@ -85,6 +86,7 @@ class FbtCollector {
       fbtEnumManifest,
       auxiliaryTexts: this._config.auxiliaryTexts,
       reactNativeMode: this._config.reactNativeMode,
+      fbtCommonPath: this._config.fbtCommonPath,
     };
     if (filename != null) {
       options.filename = filename;

diff --git a/packages/babel-plugin-fbt/bin/__tests__/FbtCommonForTests.json b/packages/babel-plugin-fbt/bin/__tests__/FbtCommonForTests.json
@@ -0,0 +1,3 @@
+{
+  "Required": "Indicates an editor field is required."
+}
diff --git a/packages/babel-plugin-fbt/bin/__tests__/collectFBT-test.js b/packages/babel-plugin-fbt/bin/__tests__/collectFBT-test.js
@@ -14,14 +14,22 @@
  */
 'use strict';
 
-var childProcess = require('child_process');
+const childProcess = require('child_process');
+const path = require('path');
+
+const commonPath = path.resolve(__dirname, 'FbtCommonForTests.json');
 
 describe('collectFBT', () => {
   function collect(source, options = {}) {
-    var collectOptions = [require.resolve('../collectFBT'), '--packager=none'];
+    var collectOptions = [
+      require.resolve('../collectFBT'),
+      '--packager=none',
+      '--fbt-common-path=' + commonPath,
+    ];
     if (options.react_native_mode || false) {
-      collectOptions = collectOptions.concat('--react-native-mode');
+      collectOptions.push('--react-native-mode');
     }
+
     var child = childProcess.spawnSync(
       process.env.NODE_BINARY || 'node',
       collectOptions,

diff --git a/packages/babel-plugin-fbt/bin/collectFBT.js b/packages/babel-plugin-fbt/bin/collectFBT.js
@@ -27,6 +27,7 @@ const yargs = require('yargs');
 
 const args = {
   AUXILIARY_TEXTS: 'auxiliary-texts',
+  COMMON_STRINGS: 'fbt-common-path',
   HASH: 'hash-module',
   HELP: 'h',
   MANIFEST: 'manifest',
@@ -93,6 +94,13 @@ const argv = yargs
     'Interpret stdin as JSON map of {<enum-manifest-file>: ' +
       '[<source_file1>, ...]}. Otherwise stdin itself will be parsed',
   )
+  .string(args.COMMON_STRINGS)
+  .default(args.COMMON_STRINGS, null)
+  .describe(
+    args.COMMON_STRINGS,
+    'Optional path to the common strings module. ' +
+      'This is a map from {[text]: [description]}.',
+  )
   .boolean(args.PRETTY)
   .default(args.PRETTY, false)
   .describe(args.PRETTY, 'Pretty-print the JSON output')
@@ -140,6 +148,7 @@ const fbtCollector = new FbtCollector(
     auxiliaryTexts: argv[args.AUXILIARY_TEXTS],
     plugins: argv[args.PLUGINS],
     reactNativeMode: argv[args.REACT_NATIVE_MODE],
+    fbtCommonPath: argv[args.COMMON_STRINGS],
   },
   extraOptions,
 );

diff --git a/packages/babel-plugin-fbt/index.js b/packages/babel-plugin-fbt/index.js
@@ -16,7 +16,7 @@
 'use strict';
 
 const FbtAutoWrap = require('./FbtAutoWrap');
-const FbtCommonConstants = require('./FbtCommonConstants');
+const FbtCommon = require('./FbtCommon');
 const {
   FbtBooleanOptions,
   FbtRequiredAttributes,
@@ -80,6 +80,7 @@ function BabelPluginFbt(babel) {
       this.opts.fbtSentinel = this.opts.fbtSentinel || '__FBT__';
       this.opts.fbtBase64 = this.opts.fbtBase64;
 
+      FbtCommon.init(this.opts);
       FbtMethodCallVisitors.setEnumManifest(getEnumManifest(this.opts));
       initExtraOptions(this);
       initDefaultOptions(this);
@@ -126,7 +127,7 @@ function BabelPluginFbt(babel) {
           const textValue = normalizeSpaces(
             expandStringConcat(moduleName, t, text).value.trim(),
           );
-          const descValue = FbtCommonConstants[textValue];
+          const descValue = FbtCommon.getDesc(textValue);
           if (!descValue) {
             throwAt(
               path.node,
@@ -537,17 +538,15 @@ function BabelPluginFbt(babel) {
     if (path.node.arguments.length !== 1) {
       throwAt(
         path.node,
-        `Expected ${moduleName}.c to have exactly 1 argument. ${
-          path.node.arguments.length
-        } was given.`,
+        `Expected ${moduleName}.c to have exactly 1 argument. ${path.node.arguments.length} was given.`,
       );
     }
 
     const text = normalizeSpaces(
       expandStringConcat(moduleName, t, path.node.arguments[0]).value,
     ).trim();
 
-    const desc = FbtCommonConstants[text];
+    const desc = FbtCommon.getDesc(text);
     if (!desc) {
       throwAt(path.node, getUnknownCommonStringErrorMessage(moduleName, text));
     }