Refactor updating imports

Author: sam-b-rose

polaris-migrator/src/migrations/replace-text-component/replace-text-component.ts

@@ -7,7 +7,7 @@ import {replaceOther} from './steps/replace-other';
 import {replaceTextStyle} from './steps/replace-text-style';
 
 export interface MigrationOptions extends Options {
-  relative: string;
+  relative: boolean;
 }
 
 export default function replaceTextComponent(

polaris-migrator/src/migrations/replace-text-component/steps/replace-display-text.ts

@@ -7,13 +7,9 @@ import {
   insertJSXAttribute,
 } from '../../../utilities/jsx';
 import {
-  renameImportSpecifier,
   getImportSpecifierName,
-  hasImportSpecifier,
-  removeImportSpecifier,
-  getImportSourcePaths,
-  renameImportDeclaration,
-  removeImportDeclaration,
+  normalizeImportSourcePaths,
+  updateImports,
 } from '../../../utilities/imports';
 import type {MigrationOptions} from '../replace-text-component';
 
@@ -32,10 +28,10 @@ export function replaceDisplayText<NodeType = ASTNode>(
   source: Collection<NodeType>,
   options: MigrationOptions,
 ) {
-  const sourcePaths = getImportSourcePaths(j, source, {
-    relative: Boolean(options.relative),
-    currentFileName: 'DisplayText',
-    nextFileName: 'Text',
+  const sourcePaths = normalizeImportSourcePaths(j, source, {
+    relative: options.relative,
+    from: 'DisplayText',
+    to: 'Text',
   });
 
   if (!sourcePaths) return;
@@ -44,18 +40,12 @@ export function replaceDisplayText<NodeType = ASTNode>(
     getImportSpecifierName(j, source, 'DisplayText', sourcePaths.current) ||
     'DisplayText';
 
-  if (hasImportSpecifier(j, source, 'Text', sourcePaths.next)) {
-    if (options.relative) {
-      removeImportDeclaration(j, source, sourcePaths.current);
-    } else {
-      removeImportSpecifier(j, source, 'DisplayText', sourcePaths.current);
-    }
-  } else {
-    if (options.relative) {
-      renameImportDeclaration(j, source, sourcePaths.current, sourcePaths.next);
-    }
-    renameImportSpecifier(j, source, 'DisplayText', 'Text', sourcePaths.next);
-  }
+  updateImports(j, source, {
+    fromSpecifier: 'DisplayText',
+    toSpecifier: 'Text',
+    fromSourcePath: sourcePaths.from,
+    toSourcePath: sourcePaths.to,
+  });
 
   source.findJSXElements(localElementName).forEach((element) => {
     replaceJSXElement(j, element, 'Text');

polaris-migrator/src/migrations/replace-text-component/steps/replace-other.ts

@@ -7,13 +7,9 @@ import {
   insertJSXAttribute,
 } from '../../../utilities/jsx';
 import {
-  renameImportSpecifier,
   getImportSpecifierName,
-  hasImportSpecifier,
-  removeImportSpecifier,
-  getImportSourcePaths,
-  removeImportDeclaration,
-  renameImportDeclaration,
+  normalizeImportSourcePaths,
+  updateImports,
 } from '../../../utilities/imports';
 import type {MigrationOptions} from '../replace-text-component';
 
@@ -44,38 +40,27 @@ export function replaceOther<NodeType = ASTNode>(
   source: Collection<NodeType>,
   options: MigrationOptions,
 ) {
-  const relative = Boolean(options.relative);
+  const relative = options.relative;
 
   Object.entries(components).forEach(([componentName, {variant, as}]) => {
-    const sourcePaths = getImportSourcePaths(j, source, {
+    const sourcePaths = normalizeImportSourcePaths(j, source, {
       relative,
-      currentFileName: componentName,
-      nextFileName: 'Text',
+      from: componentName,
+      to: 'Text',
     });
 
     if (!sourcePaths) return;
 
     const localElementName =
-      getImportSpecifierName(j, source, componentName, sourcePaths.current) ||
+      getImportSpecifierName(j, source, componentName, sourcePaths.from) ||
       componentName;
 
-    if (hasImportSpecifier(j, source, 'Text', sourcePaths.next)) {
-      if (options.relative) {
-        removeImportDeclaration(j, source, sourcePaths.current);
-      } else {
-        removeImportSpecifier(j, source, componentName, sourcePaths.current);
-      }
-    } else {
-      if (options.relative) {
-        renameImportDeclaration(
-          j,
-          source,
-          sourcePaths.current,
-          sourcePaths.next,
-        );
-      }
-      renameImportSpecifier(j, source, componentName, 'Text', sourcePaths.next);
-    }
+    updateImports(j, source, {
+      fromSpecifier: componentName,
+      toSpecifier: 'Text',
+      fromSourcePath: sourcePaths.from,
+      toSourcePath: sourcePaths.to,
+    });
 
     source.findJSXElements(localElementName).forEach((element) => {
       replaceJSXElement(j, element, 'Text');

polaris-migrator/src/migrations/replace-text-component/steps/replace-text-style.ts

@@ -10,14 +10,11 @@ import {
 } from '../../../utilities/jsx';
 import {
   insertImportSpecifier,
-  renameImportSpecifier,
   getImportSpecifierName,
   hasImportSpecifier,
-  removeImportSpecifier,
-  getImportSourcePaths,
-  renameImportDeclaration,
-  removeImportDeclaration,
   insertImportDeclaration,
+  normalizeImportSourcePaths,
+  updateImports,
 } from '../../../utilities/imports';
 import type {MigrationOptions} from '../replace-text-component';
 
@@ -38,30 +35,24 @@ export function replaceTextStyle<NodeType = ASTNode>(
   source: Collection<NodeType>,
   options: MigrationOptions,
 ) {
-  const sourcePaths = getImportSourcePaths(j, source, {
-    relative: Boolean(options.relative),
-    currentFileName: 'TextStyle',
-    nextFileName: 'Text',
+  const sourcePaths = normalizeImportSourcePaths(j, source, {
+    relative: options.relative,
+    from: 'TextStyle',
+    to: 'Text',
   });
 
   if (!sourcePaths) return;
 
   const localElementName =
-    getImportSpecifierName(j, source, 'TextStyle', sourcePaths.current) ||
+    getImportSpecifierName(j, source, 'TextStyle', sourcePaths.from) ||
     'TextStyle';
 
-  if (hasImportSpecifier(j, source, 'Text', sourcePaths.next)) {
-    if (options.relative) {
-      removeImportDeclaration(j, source, sourcePaths.current);
-    } else {
-      removeImportSpecifier(j, source, 'TextStyle', sourcePaths.current);
-    }
-  } else {
-    if (options.relative) {
-      renameImportDeclaration(j, source, sourcePaths.current, sourcePaths.next);
-    }
-    renameImportSpecifier(j, source, 'TextStyle', 'Text', sourcePaths.next);
-  }
+  updateImports(j, source, {
+    fromSpecifier: 'TextStyle',
+    toSpecifier: 'Text',
+    fromSourcePath: sourcePaths.from,
+    toSourcePath: sourcePaths.to,
+  });
 
   source.findJSXElements(localElementName).forEach((element) => {
     replaceJSXElement(j, element, 'Text');
@@ -72,7 +63,7 @@ export function replaceTextStyle<NodeType = ASTNode>(
         const currentValue = literal.node.value as keyof typeof variationMap;
         if (currentValue === 'code') {
           const inlineTextSourcePath = options.relative
-            ? sourcePaths.current.replace('TextStyle', 'InlineCode')
+            ? sourcePaths.from.replace('TextStyle', 'InlineCode')
             : '@shopify/polaris';
 
           if (
@@ -84,7 +75,7 @@ export function replaceTextStyle<NodeType = ASTNode>(
                 source,
                 'InlineCode',
                 inlineTextSourcePath,
-                sourcePaths.next,
+                sourcePaths.to,
               );
             } else {
               insertImportSpecifier(

polaris-migrator/src/utilities/imports.ts

@@ -76,41 +76,17 @@ export function insertImportDeclaration(
   sourcePath: string,
   afterSourcePath: string,
 ) {
-  getImportDeclaration(j, source, afterSourcePath).insertAfter(
-    j.importDeclaration.from({
-      source: j.literal(sourcePath),
-      specifiers: [j.importSpecifier(j.identifier(importSpecifier))],
-    }),
-  );
-}
-
-export function getImportSourcePaths(
-  j: core.JSCodeshift,
-  source: Collection<any>,
-  options = {
-    relative: false,
-    currentFileName: '',
-    nextFileName: '',
-  },
-) {
-  const {relative, currentFileName, nextFileName} = options;
-  const sourcePaths = {
-    current: '@shopify/polaris',
-    next: '@shopify/polaris',
-  };
-
-  if (relative) {
-    sourcePaths.current =
-      getRelativeImportDeclarationValue(j, source, currentFileName) || '';
-
-    if (!sourcePaths.current) return null;
-
-    sourcePaths.next =
-      getRelativeImportDeclarationValue(j, source, nextFileName) ||
-      sourcePaths.current.replace(currentFileName, nextFileName);
+  const isSameModuleSpecifier = sourcePath === afterSourcePath;
+  if (isSameModuleSpecifier) {
+    insertImportSpecifier(j, source, sourcePath, importSpecifier);
+  } else {
+    getImportDeclaration(j, source, afterSourcePath).insertAfter(
+      j.importDeclaration.from({
+        source: j.literal(sourcePath),
+        specifiers: [j.importSpecifier(j.identifier(importSpecifier))],
+      }),
+    );
   }
-
-  return sourcePaths;
 }
 
 export function getDefaultImportSpecifier(
@@ -152,17 +128,26 @@ export function hasDefaultImportSpecifier(
   return Boolean(getDefaultImportSpecifier(j, source, sourcePath).length);
 }
 
-export function getImportSpecifier(
+export function getImportAllSpecifiers(
   j: core.JSCodeshift,
   source: Collection<any>,
-  specifier: string,
   sourcePath: string,
 ) {
   return source
     .find(j.ImportDeclaration)
     .filter((path) => path.node.source.value === sourcePath)
-    .find(j.ImportSpecifier)
-    .filter((path) => path.value.imported.name === specifier);
+    .find(j.ImportSpecifier);
+}
+
+export function getImportSpecifier(
+  j: core.JSCodeshift,
+  source: Collection<any>,
+  specifier: string,
+  sourcePath: string,
+) {
+  return getImportAllSpecifiers(j, source, sourcePath).filter(
+    (path) => path.value.imported.name === specifier,
+  );
 }
 
 export function getImportSpecifierName(
@@ -176,6 +161,14 @@ export function getImportSpecifierName(
   return specifiers.length > 0 ? specifiers.nodes()[0]!.local!.name : null;
 }
 
+export function hasImportSpecifiers(
+  j: core.JSCodeshift,
+  source: Collection<any>,
+  sourcePath: string,
+) {
+  return Boolean(getImportAllSpecifiers(j, source, sourcePath)?.length);
+}
+
 export function hasImportSpecifier(
   j: core.JSCodeshift,
   source: Collection<any>,
@@ -225,3 +218,66 @@ export function removeImportSpecifier(
 ) {
   getImportSpecifier(j, source, specifier, sourcePath).remove();
 }
+
+export function normalizeImportSourcePaths(
+  j: core.JSCodeshift,
+  source: Collection<any>,
+  options = {
+    relative: false,
+    from: '',
+    to: '',
+  },
+) {
+  const {relative, from, to} = options;
+  const sourcePaths = {
+    from: '@shopify/polaris',
+    to: '@shopify/polaris',
+  };
+
+  if (relative) {
+    sourcePaths.from = getRelativeImportDeclarationValue(j, source, from) || '';
+
+    if (!sourcePaths.from) return null;
+
+    sourcePaths.to =
+      getRelativeImportDeclarationValue(j, source, to) ||
+      sourcePaths.from.replace(from, to);
+  }
+
+  return sourcePaths;
+}
+
+export function updateImports(
+  j: core.JSCodeshift,
+  source: Collection<any>,
+  options: {
+    fromSpecifier: string;
+    toSpecifier: string;
+    fromSourcePath: string;
+    toSourcePath: string;
+  },
+) {
+  const {fromSpecifier, toSpecifier, fromSourcePath, toSourcePath} = options;
+
+  // Insert new import
+  if (!hasImportDeclaration(j, source, toSourcePath)) {
+    insertImportDeclaration(
+      j,
+      source,
+      toSpecifier,
+      toSourcePath,
+      fromSourcePath,
+    );
+  }
+  if (!hasImportSpecifier(j, source, toSpecifier, toSourcePath)) {
+    insertImportSpecifier(j, source, toSpecifier, toSourcePath);
+  }
+
+  // Remove old import
+  if (hasImportSpecifier(j, source, fromSpecifier, fromSourcePath)) {
+    removeImportSpecifier(j, source, fromSpecifier, fromSourcePath);
+  }
+  if (!hasImportSpecifiers(j, source, fromSourcePath)) {
+    removeImportDeclaration(j, source, fromSourcePath);
+  }
+}