feat: Convert t tags with ids to new object syntax (#7)

Author: MartijnHols

transforms/__testfixtures__/v2-to-v3/macroWrap.input.js

@@ -2,6 +2,7 @@ import { i18n } from "@lingui/core";
 import { t, plural, select, selectOrdinal } from "@lingui/macro";
 
 i18n._(t`Some input`)
+i18n._(t('my.id')`Some input`)
 i18n._(
   plural({
     value: 1,
@@ -23,4 +24,4 @@ i18n._(
     other: 'SORT_#_RESULT_BY:',
     zero: 'SORT_#_RESULTS_BY:'
   })
-)
+)

transforms/__testfixtures__/v2-to-v3/macroWrap.output.js

@@ -2,6 +2,10 @@ import { i18n } from "@lingui/core";
 import { t, plural, select, selectOrdinal } from "@lingui/macro";
 
 t`Some input`
+t({
+  id: "my.id",
+  message: `Some input`
+})
 plural(1, {
   one: 'SORT_#_RESULT_BY:',
   other: 'SORT_#_RESULT_BY:',
@@ -16,4 +20,4 @@ selectOrdinal({
   one: 'SORT_#_RESULT_BY:',
   other: 'SORT_#_RESULT_BY:',
   zero: 'SORT_#_RESULTS_BY:'
-})
+})

transforms/__testfixtures__/v2-to-v3/t.input.js

@@ -0,0 +1,8 @@
+import { i18n } from "@lingui/core";
+import { t, plural, select, selectOrdinal } from "@lingui/macro";
+
+t`Some input`
+t('my.id')`Some input`
+const value = 1
+t('my.id')`Some value (${value})`
+t('my.id')`Some complex value (${value.toFixed(2)})`

transforms/__testfixtures__/v2-to-v3/t.output.js

@@ -0,0 +1,17 @@
+import { i18n } from "@lingui/core";
+import { t, plural, select, selectOrdinal } from "@lingui/macro";
+
+t`Some input`
+t({
+  id: "my.id",
+  message: `Some input`
+})
+const value = 1
+t({
+  id: "my.id",
+  message: `Some value (${value})`
+})
+t({
+  id: "my.id",
+  message: `Some complex value (${value.toFixed(2)})`
+})

transforms/__tests__/v2-to-v3.test.ts

@@ -28,7 +28,7 @@ describe("Deprecated methods inside @lingui/react moved to @core and @macro tran
 });
 
 
-describe("i18n._(t`name`) is not required, use intead simply t`name`", () => {
+describe("i18n._(t`name`) is not required, use instead simply t`name`", () => {
   defineTest(
     __dirname,
     "v2-to-v3",
@@ -62,4 +62,13 @@ describe("Complete example with all the past actions", () => {
     null,
     "v2-to-v3/complete",
   );
-});
+});
+
+describe("t props changed from an argument, to an object", () => {
+  defineTest(
+      __dirname,
+      "v2-to-v3",
+      null,
+      "v2-to-v3/t",
+  );
+});

transforms/v2-to-v3.ts

@@ -10,6 +10,7 @@ const transform: Transform = (fileInfo, api, options) => {
   changeJsxToCoreDeprecatedFuncs(root, j)
   changeFromMacroToCore(root, j)
   pluralPropsChanges(root, j)
+  tWithIdPropsChanges(root, j)
 
   return root.toSource(options.printOptions);
 };
@@ -235,4 +236,31 @@ function removeMacroWrap(root, j: JSCodeshift) {
       const { node } = nodePath;
       return node.arguments;
     })
-}
+}
+
+/**
+ * t arguments changed. Id needs to be passed as a part of an object.
+ * t('id')'Message') => t({ id: 'id', message: `Message` })
+ * No attempts are made to convert template literal into a regular string; this
+ * is a project-specific codestyle rule that should be fixed with Prettier or
+ * eslint.
+ */
+function tWithIdPropsChanges(root, j: JSCodeshift) {
+  return root
+      .find(j.TaggedTemplateExpression, {
+        tag: {
+          callee: {
+            name: "t"
+          }
+        }
+      })
+      .replaceWith((nodePath) => {
+        const id = nodePath.node.tag.arguments[0].value;
+        return j.callExpression(nodePath.node.tag.callee, [
+          j.objectExpression([
+            j.property("init", j.identifier("id"), j.literal(id)),
+            j.property("init", j.identifier("message"), nodePath.node.quasi)
+          ])
+        ]);
+      })
+}