@atlaskit/codemod-utils 4.0.0 → 4.1.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/codemod-utils
 
+## 4.1.0
+
+### Minor Changes
+
+- [`e4624adcb2f`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e4624adcb2f) - ED-14608: Update codemod-utils to support type import entry point changes in changeImportEntryPoint, remove adf-utils from repo stricter lint exclusion lists
+
+## 4.0.2
+
+### Patch Changes
+
+- [`9358d42eeaa`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9358d42eeaa) - NO-ISSUE: fixed codemod utils tryCreateImport() and addToImport() causing multiple insert in certain scenarios
+
+## 4.0.1
+
+### Patch Changes
+
+- [`cb2392f6d33`](https://bitbucket.org/atlassian/atlassian-frontend/commits/cb2392f6d33) - Upgrade to TypeScript 4.2.4
+
 ## 4.0.0
 
 ### Major Changes

package/dist/cjs/utils/index.js

@@ -275,7 +275,7 @@ var renameNamedImportWithAliasName = function renameNamedImportWithAliasName(com
 
 exports.renameNamedImportWithAliasName = renameNamedImportWithAliasName;
 
-var changeImportEntryPoint = function changeImportEntryPoint(oldPackageName, importToConvert, newPackageName) {
+var changeImportEntryPoint = function changeImportEntryPoint(oldPackageName, importToConvert, newPackageName, shouldBeTypeImport) {
   return function (j, root) {
     root.find(j.ImportDeclaration, {
       source: {
@@ -300,7 +300,7 @@ var changeImportEntryPoint = function changeImportEntryPoint(oldPackageName, imp
       var localSpecifierName = (_currentImportSpecifi = currentImportSpecifier.local) === null || _currentImportSpecifi === void 0 ? void 0 : _currentImportSpecifi.name;
       var newIdentifier = j.importSpecifier(j.identifier(importedSpecifierName), localSpecifierName ? j.identifier(localSpecifierName) : undefined); // check if new import exists, if not create it
 
-      (0, _support.tryCreateImport)(j, root, oldPackageName, newPackageName); // remove the old import specifier, but NOT the whole package
+      (0, _support.tryCreateImport)(j, root, oldPackageName, newPackageName, shouldBeTypeImport); // remove the old import specifier, but NOT the whole package
 
       root.find(j.ImportDeclaration, {
         source: {

package/dist/cjs/utils/support.js

@@ -286,27 +286,56 @@ function removeImport(j, base, packageName) {
   }).remove();
 }
 
-function tryCreateImport(j, base, relativeToPackage, packageName) {
-  var exists = base.find(j.ImportDeclaration).filter(function (path) {
+function tryCreateImport(j, base, relativeToPackage, packageName, shouldBeTypeImport) {
+  var matches = base.find(j.ImportDeclaration).filter(function (path) {
     return path.value.source.value === packageName;
-  }).length > 0;
+  });
+  var exists = matches.length > 0;
 
   if (exists) {
+    if (shouldBeTypeImport) {
+      // if the matched import declarations are not type imports
+      // but should be, we update them accordingly
+      var isTypeImports = matches.every(function (path) {
+        return path.value.importKind === 'type';
+      });
+
+      if (!isTypeImports) {
+        matches.filter(function (path) {
+          return path.value.importKind !== 'type';
+        }).forEach(function (path) {
+          path.value.importKind = 'type';
+        });
+        return;
+      }
+    }
+
     return;
+  } // we dynamically build up importDeclaration args, so that if shouldBeTypeImport
+  // is falsy, it is never passed explicitly as an importKind parameter (avoiding
+  // runtime exceptions during transform runs when importKind is undefined)
+
+
+  var importDeclarationArgs = [[], j.literal(packageName)];
+
+  if (shouldBeTypeImport) {
+    importDeclarationArgs.push('type');
   }
 
   base.find(j.ImportDeclaration).filter(function (path) {
     return path.value.source.value === relativeToPackage;
-  }).insertBefore(j.importDeclaration([], j.literal(packageName)));
+  }) // we only take the first matching path, to avoid duplicate inserts
+  // if the source contains the same import declaration more than once
+  .paths()[0].insertBefore(j.importDeclaration.apply(j, importDeclarationArgs));
 }
 
 function addToImport(j, base, importSpecifier, packageName) {
   base.find(j.ImportDeclaration).filter(function (path) {
     return path.value.source.value === packageName;
-  }).replaceWith(function (declaration) {
+  }).at(0).replaceWith(function (declaration) {
     return j.importDeclaration([].concat((0, _toConsumableArray2.default)((declaration.value.specifiers || []).filter(function (item) {
       return item.type === 'ImportSpecifier' && item.imported != null;
-    })), [importSpecifier]), j.literal(packageName));
+    })), [importSpecifier]), j.literal(packageName), declaration.value.importKind);
   });
 }
 

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/codemod-utils",
-	"version": "4.0.0",
+	"version": "4.1.0",
 	"sideEffects": false
 }

package/dist/es2019/utils/index.js

@@ -200,7 +200,7 @@ const renameNamedImportWithAliasName = (component, from, to) => (j, source) => {
   });
 };
 
-const changeImportEntryPoint = (oldPackageName, importToConvert, newPackageName) => (j, root) => {
+const changeImportEntryPoint = (oldPackageName, importToConvert, newPackageName, shouldBeTypeImport) => (j, root) => {
   root.find(j.ImportDeclaration, {
     source: {
       value: oldPackageName
@@ -224,7 +224,7 @@ const changeImportEntryPoint = (oldPackageName, importToConvert, newPackageName)
     const localSpecifierName = (_currentImportSpecifi = currentImportSpecifier.local) === null || _currentImportSpecifi === void 0 ? void 0 : _currentImportSpecifi.name;
     const newIdentifier = j.importSpecifier(j.identifier(importedSpecifierName), localSpecifierName ? j.identifier(localSpecifierName) : undefined); // check if new import exists, if not create it
 
-    tryCreateImport(j, root, oldPackageName, newPackageName); // remove the old import specifier, but NOT the whole package
+    tryCreateImport(j, root, oldPackageName, newPackageName, shouldBeTypeImport); // remove the old import specifier, but NOT the whole package
 
     root.find(j.ImportDeclaration, {
       source: {

package/dist/es2019/utils/support.js

@@ -215,22 +215,47 @@ function removeImport(j, base, packageName) {
   base.find(j.ImportDeclaration).filter(path => path.node.source.value === packageName).remove();
 }
 
-function tryCreateImport(j, base, relativeToPackage, packageName) {
-  const exists = base.find(j.ImportDeclaration).filter(path => path.value.source.value === packageName).length > 0;
+function tryCreateImport(j, base, relativeToPackage, packageName, shouldBeTypeImport) {
+  const matches = base.find(j.ImportDeclaration).filter(path => path.value.source.value === packageName);
+  const exists = matches.length > 0;
 
   if (exists) {
+    if (shouldBeTypeImport) {
+      // if the matched import declarations are not type imports
+      // but should be, we update them accordingly
+      const isTypeImports = matches.every(path => path.value.importKind === 'type');
+
+      if (!isTypeImports) {
+        matches.filter(path => path.value.importKind !== 'type').forEach(path => {
+          path.value.importKind = 'type';
+        });
+        return;
+      }
+    }
+
     return;
+  } // we dynamically build up importDeclaration args, so that if shouldBeTypeImport
+  // is falsy, it is never passed explicitly as an importKind parameter (avoiding
+  // runtime exceptions during transform runs when importKind is undefined)
+
+
+  const importDeclarationArgs = [[], j.literal(packageName)];
+
+  if (shouldBeTypeImport) {
+    importDeclarationArgs.push('type');
   }
 
-  base.find(j.ImportDeclaration).filter(path => path.value.source.value === relativeToPackage).insertBefore(j.importDeclaration([], j.literal(packageName)));
+  base.find(j.ImportDeclaration).filter(path => path.value.source.value === relativeToPackage) // we only take the first matching path, to avoid duplicate inserts
+  // if the source contains the same import declaration more than once
+  .paths()[0].insertBefore(j.importDeclaration(...importDeclarationArgs));
 }
 
 function addToImport(j, base, importSpecifier, packageName) {
-  base.find(j.ImportDeclaration).filter(path => path.value.source.value === packageName).replaceWith(declaration => {
+  base.find(j.ImportDeclaration).filter(path => path.value.source.value === packageName).at(0).replaceWith(declaration => {
     return j.importDeclaration([// we are appending to the existing specifiers
     // We are doing a filter hear because sometimes specifiers can be removed
     // but they hand around in the declaration
-    ...(declaration.value.specifiers || []).filter(item => item.type === 'ImportSpecifier' && item.imported != null), importSpecifier], j.literal(packageName));
+    ...(declaration.value.specifiers || []).filter(item => item.type === 'ImportSpecifier' && item.imported != null), importSpecifier], j.literal(packageName), declaration.value.importKind);
   });
 }
 

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/codemod-utils",
-	"version": "4.0.0",
+	"version": "4.1.0",
 	"sideEffects": false
 }

package/dist/esm/utils/index.js

@@ -246,7 +246,7 @@ var renameNamedImportWithAliasName = function renameNamedImportWithAliasName(com
   };
 };
 
-var changeImportEntryPoint = function changeImportEntryPoint(oldPackageName, importToConvert, newPackageName) {
+var changeImportEntryPoint = function changeImportEntryPoint(oldPackageName, importToConvert, newPackageName, shouldBeTypeImport) {
   return function (j, root) {
     root.find(j.ImportDeclaration, {
       source: {
@@ -271,7 +271,7 @@ var changeImportEntryPoint = function changeImportEntryPoint(oldPackageName, imp
       var localSpecifierName = (_currentImportSpecifi = currentImportSpecifier.local) === null || _currentImportSpecifi === void 0 ? void 0 : _currentImportSpecifi.name;
       var newIdentifier = j.importSpecifier(j.identifier(importedSpecifierName), localSpecifierName ? j.identifier(localSpecifierName) : undefined); // check if new import exists, if not create it
 
-      tryCreateImport(j, root, oldPackageName, newPackageName); // remove the old import specifier, but NOT the whole package
+      tryCreateImport(j, root, oldPackageName, newPackageName, shouldBeTypeImport); // remove the old import specifier, but NOT the whole package
 
       root.find(j.ImportDeclaration, {
         source: {

package/dist/esm/utils/support.js

@@ -241,27 +241,56 @@ function removeImport(j, base, packageName) {
   }).remove();
 }
 
-function tryCreateImport(j, base, relativeToPackage, packageName) {
-  var exists = base.find(j.ImportDeclaration).filter(function (path) {
+function tryCreateImport(j, base, relativeToPackage, packageName, shouldBeTypeImport) {
+  var matches = base.find(j.ImportDeclaration).filter(function (path) {
     return path.value.source.value === packageName;
-  }).length > 0;
+  });
+  var exists = matches.length > 0;
 
   if (exists) {
+    if (shouldBeTypeImport) {
+      // if the matched import declarations are not type imports
+      // but should be, we update them accordingly
+      var isTypeImports = matches.every(function (path) {
+        return path.value.importKind === 'type';
+      });
+
+      if (!isTypeImports) {
+        matches.filter(function (path) {
+          return path.value.importKind !== 'type';
+        }).forEach(function (path) {
+          path.value.importKind = 'type';
+        });
+        return;
+      }
+    }
+
     return;
+  } // we dynamically build up importDeclaration args, so that if shouldBeTypeImport
+  // is falsy, it is never passed explicitly as an importKind parameter (avoiding
+  // runtime exceptions during transform runs when importKind is undefined)
+
+
+  var importDeclarationArgs = [[], j.literal(packageName)];
+
+  if (shouldBeTypeImport) {
+    importDeclarationArgs.push('type');
   }
 
   base.find(j.ImportDeclaration).filter(function (path) {
     return path.value.source.value === relativeToPackage;
-  }).insertBefore(j.importDeclaration([], j.literal(packageName)));
+  }) // we only take the first matching path, to avoid duplicate inserts
+  // if the source contains the same import declaration more than once
+  .paths()[0].insertBefore(j.importDeclaration.apply(j, importDeclarationArgs));
 }
 
 function addToImport(j, base, importSpecifier, packageName) {
   base.find(j.ImportDeclaration).filter(function (path) {
     return path.value.source.value === packageName;
-  }).replaceWith(function (declaration) {
+  }).at(0).replaceWith(function (declaration) {
     return j.importDeclaration([].concat(_toConsumableArray((declaration.value.specifiers || []).filter(function (item) {
       return item.type === 'ImportSpecifier' && item.imported != null;
-    })), [importSpecifier]), j.literal(packageName));
+    })), [importSpecifier]), j.literal(packageName), declaration.value.importKind);
   });
 }
 

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/codemod-utils",
-	"version": "4.0.0",
+	"version": "4.1.0",
 	"sideEffects": false
 }

package/dist/types/utils/index.d.ts

@@ -11,5 +11,5 @@ declare const flattenCertainChildPropsAsProp: (component: string, propName: stri
 declare const createRenameJSXFunc: (packagePath: string, from: string, to: string, fallback?: string | undefined) => (j: core.JSCodeshift, source: any) => void;
 declare const createRemoveFuncAddCommentFor: (component: string, prop: string, comment?: string | undefined) => (j: core.JSCodeshift, source: Collection<Node>) => void;
 declare const renameNamedImportWithAliasName: (component: string, from: string, to: string) => (j: core.JSCodeshift, source: Collection<Node>) => void;
-declare const changeImportEntryPoint: (oldPackageName: string, importToConvert: string, newPackageName: string) => (j: core.JSCodeshift, root: Collection<Node>) => void;
+declare const changeImportEntryPoint: (oldPackageName: string, importToConvert: string, newPackageName: string, shouldBeTypeImport?: boolean | undefined) => (j: core.JSCodeshift, root: Collection<Node>) => void;
 export { createRenameFuncFor, createConvertFuncFor, createRenameImportFor, createRemoveFuncFor, replaceImportStatementFor, elevateComponentToNewEntryPoint, createTransformer, renameNamedImportWithAliasName, flattenCertainChildPropsAsProp, createRenameJSXFunc, createRemoveFuncAddCommentFor, changeImportEntryPoint, };

package/dist/types/utils/support.d.ts

@@ -21,7 +21,7 @@ declare const testMethodVariantEach: (path: ASTPath<CallExpression>, testMethods
 declare const hasJSXAttributesByName: (j: core.JSCodeshift, element: ASTPath<any>, attributeName: string) => boolean;
 declare const doesIdentifierExist: (j: core.JSCodeshift, base: Collection<any>, name: string) => boolean;
 declare function removeImport(j: core.JSCodeshift, base: Collection<any>, packageName: string): void;
-declare function tryCreateImport(j: core.JSCodeshift, base: Collection<any>, relativeToPackage: string, packageName: string): void;
+declare function tryCreateImport(j: core.JSCodeshift, base: Collection<any>, relativeToPackage: string, packageName: string, shouldBeTypeImport?: boolean): void;
 declare function addToImport(j: core.JSCodeshift, base: Collection<any>, importSpecifier: ImportSpecifier | ImportDefaultSpecifier, packageName: string): void;
 declare const shiftDefaultImport: (j: core.JSCodeshift, base: Collection<any>, defaultName: string, oldPackagePath: string, newPackagePath: string) => void;
 declare function getSafeImportName({ j, base, currentDefaultSpecifierName, desiredName, fallbackName, }: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/codemod-utils",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
   "description": " jscodeshift-compatible codemod utilities",
@@ -30,7 +30,7 @@
     "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
     "@types/jscodeshift": "^0.11.0",
     "jscodeshift": "^0.13.0",
-    "typescript": "3.9.10"
+    "typescript": "4.2.4"
   },
   "techstack": {
     "@atlassian/frontend": {