feat(babel-plugin-react-intl): add filename as param to overrideIdFn

fix #495
close #496

Author: Long Ho

packages/babel-plugin-react-intl/src/index.ts

@@ -182,6 +182,7 @@ function createMessageDescriptor(
 function evaluateMessageDescriptor(
   descriptorPath: MessageDescriptorPath,
   isJSXSource = false,
+  filename: string,
   overrideIdFn?: OptionsSchema['overrideIdFn']
 ) {
   let id = getMessageDescriptorValue(descriptorPath.id);
@@ -191,7 +192,7 @@ function evaluateMessageDescriptor(
   const description = getMessageDescriptorValue(descriptorPath.description);
 
   if (overrideIdFn) {
-    id = overrideIdFn(id, defaultMessage, description);
+    id = overrideIdFn(id, defaultMessage, description, filename);
   }
   const descriptor: MessageDescriptor = {
     id,
@@ -433,6 +434,7 @@ export default declare((api: any, options: OptionsSchema) => {
             const descriptor = evaluateMessageDescriptor(
               descriptorPath,
               true,
+              filename,
               overrideIdFn
             );
 
@@ -537,6 +539,7 @@ export default declare((api: any, options: OptionsSchema) => {
           const descriptor = evaluateMessageDescriptor(
             descriptorPath,
             false,
+            filename,
             overrideIdFn
           );
           storeMessage(descriptor, messageDescriptor, opts, filename, messages);

packages/babel-plugin-react-intl/src/options.schema.json

@@ -6,7 +6,7 @@
     "messagesDir": {"type": "string"},
     "overrideIdFn": {
       "instanceof": "Function",
-      "tsType": "(id: string, defaultMessage: string, descriptor: string) => string"
+      "tsType": "(id: string, defaultMessage: string, descriptor: string, filePath: string) => string"
     },
     "removeDefaultMessage": {"type": "boolean"},
     "extractFromFormatMessageCall": {"type": "boolean"},

packages/babel-plugin-react-intl/src/options.ts

@@ -9,7 +9,7 @@ export interface OptionsSchema {
   moduleSourceName?: string;
   extractSourceLocation?: boolean;
   messagesDir?: string;
-  overrideIdFn?: (id: string, defaultMessage: string, descriptor: string) => string;
+  overrideIdFn?: (id: string, defaultMessage: string, descriptor: string, filePath: string) => string;
   removeDefaultMessage?: boolean;
   extractFromFormatMessageCall?: boolean;
   additionalComponentNames?: string[];

packages/babel-plugin-react-intl/test/__snapshots__/index.test.ts.snap

@@ -485,25 +485,25 @@ function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj;
 
 const msgs = (0, _reactIntl.defineMessages)({
   header: {
-    \\"id\\": \\"HELLO.foo.bar.baz.12.string\\",
+    \\"id\\": \\"actual.js.foo.bar.baz.12.string\\",
     \\"defaultMessage\\": \\"Hello World!\\"
   },
   content: {
-    \\"id\\": \\"HELLO.foo.bar.biff.12.object\\",
+    \\"id\\": \\"actual.js.foo.bar.biff.12.object\\",
     \\"defaultMessage\\": \\"Hello Nurse!\\"
   }
 });
 
 class Foo extends _react.Component {
   render() {
     return _react.default.createElement(\\"div\\", null, _react.default.createElement(\\"h1\\", null, _react.default.createElement(_reactIntl.FormattedMessage, msgs.header)), _react.default.createElement(\\"p\\", null, _react.default.createElement(_reactIntl.FormattedMessage, msgs.content)), _react.default.createElement(_reactIntl.FormattedMessage, {
-      id: \\"HELLO.foo.bar.zoo.12.object\\",
+      id: \\"actual.js.foo.bar.zoo.12.object\\",
       defaultMessage: \\"Hello World!\\"
     }), _react.default.createElement(_reactIntl.FormattedMessage, {
       id: \\"HELLO..5.object\\",
       defaultMessage: \\"NO ID\\"
     }), _react.default.createElement(_reactIntl.FormattedHTMLMessage, {
-      id: \\"HELLO.foo.bar.delta.21.string\\",
+      id: \\"actual.js.foo.bar.delta.21.string\\",
       defaultMessage: \\"<h1>Hello World!</h1>\\"
     }));
   }
@@ -518,23 +518,23 @@ Array [
   Object {
     "defaultMessage": "Hello World!",
     "description": "The default message",
-    "id": "HELLO.foo.bar.baz.12.string",
+    "id": "actual.js.foo.bar.baz.12.string",
   },
   Object {
     "defaultMessage": "Hello Nurse!",
     "description": Object {
       "metadata": "Additional metadata content.",
       "text": "Something for the translator.",
     },
-    "id": "HELLO.foo.bar.biff.12.object",
+    "id": "actual.js.foo.bar.biff.12.object",
   },
   Object {
     "defaultMessage": "Hello World!",
     "description": Object {
       "metadata": "Additional metadata content.",
       "text": "Something for the translator. Another description",
     },
-    "id": "HELLO.foo.bar.zoo.12.object",
+    "id": "actual.js.foo.bar.zoo.12.object",
   },
   Object {
     "defaultMessage": "NO ID",
@@ -547,7 +547,7 @@ Array [
   Object {
     "defaultMessage": "<h1>Hello World!</h1>",
     "description": "The default message.",
-    "id": "HELLO.foo.bar.delta.21.string",
+    "id": "actual.js.foo.bar.delta.21.string",
   },
 ]
 `;

packages/babel-plugin-react-intl/test/index.test.ts

@@ -1,4 +1,4 @@
-import {join} from 'path';
+import {join, basename} from 'path';
 import * as fs from 'fs';
 import {transformFileSync} from '@babel/core';
 import plugin from '../src';
@@ -69,9 +69,13 @@ describe('options', () => {
       overrideIdFn: (
         id: string,
         defaultMessage: string,
-        description: string
+        description: string,
+        filePath: string
       ) => {
-        return `HELLO.${id}.${defaultMessage.length}.${typeof description}`;
+        const filename = basename(filePath);
+        return `${filename}.${id}.${
+          defaultMessage.length
+        }.${typeof description}`;
       },
     })!.code;