Add rewriteImportExtensions option to TS preset (#15913)

* Add `rewriteImportExtensions` option to TS preset * Review * Update snapshot
babel · Sep 24, 2023 · 54d30f2 · 54d30f2
1 parent d11682e
commit 54d30f2
Show file tree

Hide file tree

Showing 7 changed files with 57 additions and 1 deletion.
diff --git a/packages/babel-preset-typescript/src/index.ts b/packages/babel-preset-typescript/src/index.ts
@@ -4,6 +4,7 @@ import syntaxJSX from "@babel/plugin-syntax-jsx";
 import transformModulesCommonJS from "@babel/plugin-transform-modules-commonjs";
 import normalizeOptions from "./normalize-options.ts";
 import type { Options } from "./normalize-options.ts";
+import pluginRewriteTSImports from "./plugin-rewrite-ts-imports.ts";
 
 export default declarePreset((api, opts: Options) => {
   api.assertVersion(7);
@@ -18,6 +19,7 @@ export default declarePreset((api, opts: Options) => {
     jsxPragmaFrag,
     onlyRemoveTypeImports,
     optimizeConstEnums,
+    rewriteImportExtensions,
   } = normalizeOptions(opts);
 
   const pluginOptions = process.env.BABEL_8_BREAKING
@@ -59,6 +61,7 @@ export default declarePreset((api, opts: Options) => {
   const disableExtensionDetect = allExtensions || ignoreExtensions;
 
   return {
+    plugins: rewriteImportExtensions ? [pluginRewriteTSImports] : [],
     overrides: disableExtensionDetect
       ? [{ plugins: getPlugins(isTSX, disallowAmbiguousJSXLike) }]
       : // Only set 'test' if explicitly requested, since it requires that

diff --git a/packages/babel-preset-typescript/src/normalize-options.ts b/packages/babel-preset-typescript/src/normalize-options.ts
@@ -10,6 +10,7 @@ export interface Options {
   jsxPragmaFrag?: string;
   onlyRemoveTypeImports?: boolean;
   optimizeConstEnums?: boolean;
+  rewriteImportExtensions?: boolean;
 
   // TODO: Remove in Babel 8
   allExtensions?: boolean;
@@ -19,14 +20,17 @@ export interface Options {
 export default function normalizeOptions(options: Options = {}) {
   let { allowNamespaces = true, jsxPragma, onlyRemoveTypeImports } = options;
 
-  const TopLevelOptions = {
+  const TopLevelOptions: {
+    [Key in keyof Omit<Options, "allowDeclareFields">]-?: Key;
+  } = {
     ignoreExtensions: "ignoreExtensions",
     allowNamespaces: "allowNamespaces",
     disallowAmbiguousJSXLike: "disallowAmbiguousJSXLike",
     jsxPragma: "jsxPragma",
     jsxPragmaFrag: "jsxPragmaFrag",
     onlyRemoveTypeImports: "onlyRemoveTypeImports",
     optimizeConstEnums: "optimizeConstEnums",
+    rewriteImportExtensions: "rewriteImportExtensions",
 
     // TODO: Remove in Babel 8
     allExtensions: "allExtensions",
@@ -121,6 +125,12 @@ export default function normalizeOptions(options: Options = {}) {
     false,
   );
 
+  const rewriteImportExtensions = v.validateBooleanOption(
+    TopLevelOptions.rewriteImportExtensions,
+    options.rewriteImportExtensions,
+    false,
+  );
+
   const normalized: Options = {
     ignoreExtensions,
     allowNamespaces,
@@ -129,6 +139,7 @@ export default function normalizeOptions(options: Options = {}) {
     jsxPragmaFrag,
     onlyRemoveTypeImports,
     optimizeConstEnums,
+    rewriteImportExtensions,
   };
   if (!process.env.BABEL_8_BREAKING) {
     normalized.allExtensions = allExtensions;

diff --git a/packages/babel-preset-typescript/src/plugin-rewrite-ts-imports.ts b/packages/babel-preset-typescript/src/plugin-rewrite-ts-imports.ts
@@ -0,0 +1,24 @@
+import { declare } from "@babel/helper-plugin-utils";
+import type { types as t } from "@babel/core";
+import type { NodePath } from "@babel/traverse";
+
+export default declare(function ({ types: t }) {
+  return {
+    name: "preset-typescript/plugin-rewrite-ts-imports",
+    visitor: {
+      "ImportDeclaration|ExportAllDeclaration|ExportNamedDeclaration"({
+        node,
+      }: NodePath<
+        t.ImportDeclaration | t.ExportAllDeclaration | t.ExportNamedDeclaration
+      >) {
+        const { source } = node;
+        const kind = t.isImportDeclaration(node)
+          ? node.importKind
+          : node.exportKind;
+        if (kind === "value" && source && /[\\/]/.test(source.value)) {
+          source.value = source.value.replace(/(\.[mc]?)ts$/, "$1js");
+        }
+      },
+    },
+  };
+});
diff --git a/packages/babel-preset-typescript/test/fixtures/opts/rewriteImportExtensions/input.ts b/packages/babel-preset-typescript/test/fixtures/opts/rewriteImportExtensions/input.ts
@@ -0,0 +1,6 @@
+import "./a.ts";
+import "./a.mts";
+import "./a.cts";
+import "a-package/file.ts";
+// Bare import, it's either a node package or remapped by an import map
+import "soundcloud.ts";
diff --git a/packages/babel-preset-typescript/test/fixtures/opts/rewriteImportExtensions/options.json b/packages/babel-preset-typescript/test/fixtures/opts/rewriteImportExtensions/options.json
@@ -0,0 +1,4 @@
+{
+  "sourceType": "module",
+  "presets": [["typescript", { "rewriteImportExtensions": true }]]
+}
diff --git a/packages/babel-preset-typescript/test/fixtures/opts/rewriteImportExtensions/output.mjs b/packages/babel-preset-typescript/test/fixtures/opts/rewriteImportExtensions/output.mjs
@@ -0,0 +1,6 @@
+import "./a.js";
+import "./a.mjs";
+import "./a.cjs";
+import "a-package/file.js";
+// Bare import, it's either a node package or remapped by an import map
+import "soundcloud.ts";
diff --git a/packages/babel-preset-typescript/test/normalize-options.skip-bundled.js b/packages/babel-preset-typescript/test/normalize-options.skip-bundled.js
@@ -48,6 +48,7 @@ describe("normalize options", () => {
           "jsxPragmaFrag": "React.Fragment",
           "onlyRemoveTypeImports": true,
           "optimizeConstEnums": false,
+          "rewriteImportExtensions": false,
         }
       `);
     });
@@ -96,6 +97,7 @@ describe("normalize options", () => {
           "jsxPragmaFrag": "React.Fragment",
           "onlyRemoveTypeImports": undefined,
           "optimizeConstEnums": false,
+          "rewriteImportExtensions": false,
         }
       `);
     });