@atlaskit/codemod-utils 4.1.3 → 4.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/codemod-utils",
-  "version": "4.1.3",
+  "version": "4.2.1",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
   "description": " jscodeshift-compatible codemod utilities",
@@ -8,7 +8,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "atlassian": {
-    "team": "UIP: Monorepo",
+    "team": "UIP: Frontend Delivery",
     "inPublicMirror": false,
     "releaseModel": "continuous"
   },
@@ -18,9 +18,10 @@
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
   "typesVersions": {
-    ">=4.0 <4.5": {
+    ">=4.5 <4.9": {
       "*": [
-        "dist/types-ts4.0/*"
+        "dist/types-ts4.5/*",
+        "dist/types-ts4.5/index.d.ts"
       ]
     }
   },
@@ -37,7 +38,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": "4.5.5"
+    "typescript": "~4.9.5"
   },
   "techstack": {
     "@atlassian/frontend": {
@@ -52,6 +53,9 @@
       "analytics": [
         "analytics-next"
       ],
+      "design-tokens": [
+        "color"
+      ],
       "theming": [
         "react-context"
       ],

package/report.api.md

@@ -1,12 +1,18 @@
+<!-- API Report Version: 2.3 -->
+
 ## API Report File for "@atlaskit/codemod-utils"
 
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
 
-<!--
-	Generated API Report version: 2.0
--->
+- [Main Entry Types](#main-entry-types)
+- [Peer Dependencies](#peer-dependencies)
 
-[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
 
 ```ts
 import { API } from 'jscodeshift';
@@ -29,11 +35,11 @@ import { VariableDeclarator } from 'jscodeshift';
 export function addCommentBefore(
   j: core.JSCodeshift,
   target:
-    | Collection<Program>
+    | Collection<CallExpression>
     | Collection<ImportDeclaration>
-    | Collection<JSXElement>
     | Collection<JSXAttribute>
-    | Collection<CallExpression>
+    | Collection<JSXElement>
+    | Collection<Program>
     | Collection<VariableDeclarator>,
   message: string,
   commentType?: 'block' | 'line',
@@ -63,7 +69,7 @@ export const addDynamicImport: (
 export function addToImport(
   j: core.JSCodeshift,
   base: Collection<any>,
-  importSpecifier: ImportSpecifier | ImportDefaultSpecifier,
+  importSpecifier: ImportDefaultSpecifier | ImportSpecifier,
   packageName: string,
 ): void;
 
@@ -78,7 +84,7 @@ export const changeImportEntryPoint: (
   oldPackageName: string,
   importToConvert: string,
   newPackageName: string,
-  shouldBeTypeImport?: boolean | undefined,
+  shouldBeTypeImport?: boolean,
 ) => (j: core.JSCodeshift, root: Collection<Node>) => void;
 
 // @public (undocumented)
@@ -93,7 +99,7 @@ export const createConvertFuncFor: (
 export const createRemoveFuncAddCommentFor: (
   component: string,
   prop: string,
-  comment?: string | undefined,
+  comment?: string,
 ) => (j: core.JSCodeshift, source: Collection<Node>) => void;
 
 // @public (undocumented)
@@ -102,7 +108,7 @@ export const createRemoveFuncFor: (
   importName: string,
   prop: string,
   predicate?: (j: core.JSCodeshift, element: ASTPath<any>) => boolean,
-  comment?: string | undefined,
+  comment?: string,
 ) => (j: core.JSCodeshift, source: Collection<Node>) => void;
 
 // @public (undocumented)
@@ -161,14 +167,14 @@ export const getDefaultSpecifier: (
   j: core.JSCodeshift,
   source: Collection<Node>,
   specifier: string,
-) => string | null;
+) => null | string;
 
 // @public (undocumented)
 export const getDynamicImportName: (
   j: core.JSCodeshift,
   source: Collection<any>,
   importPath: string,
-) => string | null;
+) => null | string;
 
 // @public (undocumented)
 export const getJSXAttributesByName: (
@@ -183,7 +189,7 @@ export function getNamedSpecifier(
   source: Collection<Node>,
   specifier: string,
   importName: string,
-): string | null;
+): null | string;
 
 // @public (undocumented)
 export function getSafeImportName({
@@ -195,7 +201,7 @@ export function getSafeImportName({
 }: {
   j: core.JSCodeshift;
   base: Collection<any>;
-  currentDefaultSpecifierName: string | null;
+  currentDefaultSpecifierName: null | string;
   desiredName: string;
   fallbackName: string;
 }): string;
@@ -258,3 +264,15 @@ export function tryCreateImport(
 
 // (No @packageDocumentation comment for this package)
 ```
+
+<!--SECTION END: Main Entry Types-->
+
+### Peer Dependencies
+
+<!--SECTION START: Peer Dependencies-->
+
+```json
+{}
+```
+
+<!--SECTION END: Peer Dependencies-->

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,122 @@
+## API Report File for "@atlaskit/codemod-utils"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { API } from 'jscodeshift';
+import { ASTPath } from 'jscodeshift';
+import { CallExpression } from 'jscodeshift';
+import { Collection } from 'jscodeshift/src/Collection';
+import core from 'jscodeshift';
+import { FileInfo } from 'jscodeshift';
+import { ImportDeclaration } from 'jscodeshift';
+import { ImportDefaultSpecifier } from 'jscodeshift';
+import { ImportSpecifier } from 'jscodeshift';
+import { JSXAttribute } from 'jscodeshift';
+import { JSXElement } from 'jscodeshift';
+import { Options } from 'jscodeshift';
+import { Program } from 'jscodeshift';
+import { VariableDeclaration } from 'jscodeshift';
+import { VariableDeclarator } from 'jscodeshift';
+
+// @public (undocumented)
+export function addCommentBefore(j: core.JSCodeshift, target: Collection<CallExpression> | Collection<ImportDeclaration> | Collection<JSXAttribute> | Collection<JSXElement> | Collection<Program> | Collection<VariableDeclarator>, message: string, commentType?: 'block' | 'line', messagePrefix?: string): void;
+
+// @public (undocumented)
+export const addCommentToStartOfFile: ({ j, base, message, }: {
+    j: core.JSCodeshift;
+    base: Collection<Node>;
+    message: string;
+}) => void;
+
+// @public (undocumented)
+export const addDynamicImport: (j: core.JSCodeshift, target: Collection<VariableDeclaration>, name: string, packageEndpoint: string) => void;
+
+// @public (undocumented)
+export function addToImport(j: core.JSCodeshift, base: Collection<any>, importSpecifier: ImportDefaultSpecifier | ImportSpecifier, packageName: string): void;
+
+// @public (undocumented)
+export const callExpressionArgMatchesString: (arg: CallExpression['arguments'][number], str: string) => boolean;
+
+// @public (undocumented)
+export const changeImportEntryPoint: (oldPackageName: string, importToConvert: string, newPackageName: string, shouldBeTypeImport?: boolean) => (j: core.JSCodeshift, root: Collection<Node>) => void;
+
+// @public (undocumented)
+export const createConvertFuncFor: (component: string, from: string, to: string, predicate?: ((value: any) => boolean) | undefined) => (j: core.JSCodeshift, source: Collection<Node>) => void;
+
+// @public (undocumented)
+export const createRemoveFuncAddCommentFor: (component: string, prop: string, comment?: string) => (j: core.JSCodeshift, source: Collection<Node>) => void;
+
+// @public (undocumented)
+export const createRemoveFuncFor: (component: string, importName: string, prop: string, predicate?: (j: core.JSCodeshift, element: ASTPath<any>) => boolean, comment?: string) => (j: core.JSCodeshift, source: Collection<Node>) => void;
+
+// @public (undocumented)
+export const createRenameFuncFor: (component: string, from: string, to: string) => (j: core.JSCodeshift, source: Collection<Node>) => void;
+
+// @public (undocumented)
+export const createRenameImportFor: (component: string, from: string, to: string) => (j: core.JSCodeshift, source: Collection<Node>) => void;
+
+// @public (undocumented)
+export const createRenameJSXFunc: (packagePath: string, from: string, to: string, fallback?: string | undefined) => (j: core.JSCodeshift, source: any) => void;
+
+// @public (undocumented)
+export const createTransformer: (migrates: ((j: core.JSCodeshift, source: Collection<Node>) => void)[], shouldApplyTransform?: ((j: core.JSCodeshift, source: Collection<Node>) => boolean) | undefined) => (fileInfo: FileInfo, { jscodeshift: j }: API, options: Options) => string;
+
+// @public (undocumented)
+export const doesIdentifierExist: (j: core.JSCodeshift, base: Collection<any>, name: string) => boolean;
+
+// @public (undocumented)
+export const elevateComponentToNewEntryPoint: (pkg: string, toPkg: string, innerElementName: string) => (j: core.JSCodeshift, root: any) => void;
+
+// @public (undocumented)
+export const flattenCertainChildPropsAsProp: (component: string, propName: string, childProps: string[]) => (j: core.JSCodeshift, source: Collection<Node>) => void;
+
+// @public (undocumented)
+export const getDefaultSpecifier: (j: core.JSCodeshift, source: Collection<Node>, specifier: string) => null | string;
+
+// @public (undocumented)
+export const getDynamicImportName: (j: core.JSCodeshift, source: Collection<any>, importPath: string) => null | string;
+
+// @public (undocumented)
+export const getJSXAttributesByName: (j: core.JSCodeshift, element: ASTPath<any>, attributeName: string) => Collection<JSXAttribute>;
+
+// @public (undocumented)
+export function getNamedSpecifier(j: core.JSCodeshift, source: Collection<Node>, specifier: string, importName: string): null | string;
+
+// @public (undocumented)
+export function getSafeImportName({ j, base, currentDefaultSpecifierName, desiredName, fallbackName, }: {
+    j: core.JSCodeshift;
+    base: Collection<any>;
+    currentDefaultSpecifierName: null | string;
+    desiredName: string;
+    fallbackName: string;
+}): string;
+
+// @public (undocumented)
+export const hasImportDeclaration: (j: core.JSCodeshift, source: Collection<Node>, importPath: string) => boolean;
+
+// @public (undocumented)
+export const hasImportDeclarationFromAnyPackageEntrypoint: (j: core.JSCodeshift, source: Collection<Node>, packageName: string) => boolean;
+
+// @public (undocumented)
+export const hasJSXAttributesByName: (j: core.JSCodeshift, element: ASTPath<any>, attributeName: string) => boolean;
+
+// @public (undocumented)
+export function removeImport(j: core.JSCodeshift, base: Collection<any>, packageName: string): void;
+
+// @public (undocumented)
+export const renameNamedImportWithAliasName: (component: string, from: string, to: string) => (j: core.JSCodeshift, source: Collection<Node>) => void;
+
+// @public (undocumented)
+export const replaceImportStatementFor: (pkg: string, convertMap: any) => (j: core.JSCodeshift, root: Collection<Node>) => void;
+
+// @public (undocumented)
+export const testMethodVariantEach: (path: ASTPath<CallExpression>, testMethods: Set<string>) => boolean;
+
+// @public (undocumented)
+export function tryCreateImport(j: core.JSCodeshift, base: Collection<any>, relativeToPackage: string, packageName: string, shouldBeTypeImport?: boolean): void;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/types-ts4.0/index.d.ts

@@ -1,2 +0,0 @@
-export { createRenameFuncFor, createConvertFuncFor, createRenameImportFor, createRemoveFuncFor, replaceImportStatementFor, elevateComponentToNewEntryPoint, createTransformer, renameNamedImportWithAliasName, flattenCertainChildPropsAsProp, createRenameJSXFunc, createRemoveFuncAddCommentFor, changeImportEntryPoint, } from './utils';
-export { getDefaultSpecifier, getNamedSpecifier, getJSXAttributesByName, hasJSXAttributesByName, doesIdentifierExist, hasImportDeclaration, hasImportDeclarationFromAnyPackageEntrypoint, addCommentBefore, addCommentToStartOfFile, callExpressionArgMatchesString, testMethodVariantEach, getSafeImportName, removeImport, getDynamicImportName, addDynamicImport, tryCreateImport, addToImport, } from './utils/support';

package/dist/types-ts4.0/utils/index.d.ts

@@ -1,15 +0,0 @@
-import core, { API, ASTPath, FileInfo, Options } from 'jscodeshift';
-import { Collection } from 'jscodeshift/src/Collection';
-declare const createRemoveFuncFor: (component: string, importName: string, prop: string, predicate?: (j: core.JSCodeshift, element: ASTPath<any>) => boolean, comment?: string | undefined) => (j: core.JSCodeshift, source: Collection<Node>) => void;
-declare const createRenameFuncFor: (component: string, from: string, to: string) => (j: core.JSCodeshift, source: Collection<Node>) => void;
-declare const createConvertFuncFor: (component: string, from: string, to: string, predicate?: ((value: any) => boolean) | undefined) => (j: core.JSCodeshift, source: Collection<Node>) => void;
-declare const replaceImportStatementFor: (pkg: string, convertMap: any) => (j: core.JSCodeshift, root: Collection<Node>) => void;
-declare const createRenameImportFor: (component: string, from: string, to: string) => (j: core.JSCodeshift, source: Collection<Node>) => void;
-declare const createTransformer: (migrates: ((j: core.JSCodeshift, source: Collection<Node>) => void)[], shouldApplyTransform?: ((j: core.JSCodeshift, source: Collection<Node>) => boolean) | undefined) => (fileInfo: FileInfo, { jscodeshift: j }: API, options: Options) => string;
-declare const elevateComponentToNewEntryPoint: (pkg: string, toPkg: string, innerElementName: string) => (j: core.JSCodeshift, root: any) => void;
-declare const flattenCertainChildPropsAsProp: (component: string, propName: string, childProps: string[]) => (j: core.JSCodeshift, source: Collection<Node>) => void;
-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, 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-ts4.0/utils/support.d.ts

@@ -1,47 +0,0 @@
-import core, { ASTPath, CallExpression, ImportDeclaration, ImportDefaultSpecifier, ImportSpecifier, JSXAttribute, JSXElement, Program, VariableDeclaration, VariableDeclarator } from 'jscodeshift';
-import { Collection } from 'jscodeshift/src/Collection';
-declare function getNamedSpecifier(j: core.JSCodeshift, source: Collection<Node>, specifier: string, importName: string): string | null;
-declare const getDynamicImportName: (j: core.JSCodeshift, source: Collection<any>, importPath: string) => string | null;
-declare const addDynamicImport: (j: core.JSCodeshift, target: Collection<VariableDeclaration>, name: string, packageEndpoint: string) => void;
-declare function clean(value: string): string;
-declare const addCommentToStartOfFile: ({ j, base, message, }: {
-    j: core.JSCodeshift;
-    base: Collection<Node>;
-    message: string;
-}) => void;
-declare function addCommentBefore(j: core.JSCodeshift, target: Collection<Program> | Collection<ImportDeclaration> | Collection<JSXElement> | Collection<JSXAttribute> | Collection<CallExpression> | Collection<VariableDeclarator>, message: string, commentType?: 'block' | 'line', messagePrefix?: string): void;
-declare const getDefaultSpecifier: (j: core.JSCodeshift, source: Collection<Node>, specifier: string) => string | null;
-declare const getJSXAttributesByName: (j: core.JSCodeshift, element: ASTPath<any>, attributeName: string) => Collection<JSXAttribute>;
-declare const isEmpty: any;
-declare const hasImportDeclaration: (j: core.JSCodeshift, source: Collection<Node>, importPath: string) => boolean;
-declare const hasImportDeclarationFromAnyPackageEntrypoint: (j: core.JSCodeshift, source: Collection<Node>, packageName: string) => boolean;
-declare const debug: (component: string) => (j: core.JSCodeshift, source: Collection<Node>) => void;
-export declare function placeholderStringMatches(placeholderStr: string, resolvedStr: string): boolean;
-/**
- * Check whether a value contains a Format Specifier (printf placeholder)
- *
- * @see https://jestjs.io/docs/api#testeachtablename-fn-timeout
- * @see https://nodejs.org/api/util.html#utilformatformat-args
- *
- * @param argValue The string potentially containing a format specifier (e.g. 'Foo %s')
- * @param str The string that has replaced a format specifier with a tangible value (e.g. 'Foo Bar`)
- *
- * @returns Boolean: True if the strings matched (after considering the placeholder), or false if not.
- */
-export declare function matchesStringWithFormatSpecifier(argValue: string | number | boolean | RegExp | null, str: string): boolean;
-declare const callExpressionArgMatchesString: (arg: CallExpression['arguments'][number], str: string) => boolean;
-declare const testMethodVariantEach: (path: ASTPath<CallExpression>, testMethods: Set<string>) => boolean;
-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, 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, }: {
-    j: core.JSCodeshift;
-    base: Collection<any>;
-    currentDefaultSpecifierName: string | null;
-    desiredName: string;
-    fallbackName: string;
-}): string;
-export { getDefaultSpecifier, getNamedSpecifier, getJSXAttributesByName, hasJSXAttributesByName, hasImportDeclaration, hasImportDeclarationFromAnyPackageEntrypoint, addCommentBefore, addCommentToStartOfFile, doesIdentifierExist, removeImport, tryCreateImport, addToImport, shiftDefaultImport, isEmpty, clean, debug, callExpressionArgMatchesString, testMethodVariantEach, getSafeImportName, getDynamicImportName, addDynamicImport, };