@atlaskit/editor-core 193.24.6 → 193.24.18

package/codemods/__tests__/rename-unsafe-cards-prop.ts

@@ -6,15 +6,13 @@ import { createTransformer } from '../utils';
 // This stays as require() since changing to import will trigger a linter error
 const defineInlineTest = require('jscodeshift/dist/testUtils').defineInlineTest;
 
-const transformer = createTransformer('@atlaskit/editor-core', [
-  renameUnsafeCardProp,
-]);
+const transformer = createTransformer('@atlaskit/editor-core', [renameUnsafeCardProp]);
 
 describe('Rename UNSAFE_cards to smartLinks', () => {
-  defineInlineTest(
-    { default: transformer, parser: 'tsx' },
-    {},
-    `
+	defineInlineTest(
+		{ default: transformer, parser: 'tsx' },
+		{},
+		`
     import React from 'react';
     import { Editor } from '@atlaskit/editor-core';
 
@@ -22,7 +20,7 @@ describe('Rename UNSAFE_cards to smartLinks', () => {
       <Editor />
     );
     `, // -----
-    `
+		`
     import React from 'react';
     import { Editor } from '@atlaskit/editor-core';
 
@@ -30,13 +28,13 @@ describe('Rename UNSAFE_cards to smartLinks', () => {
       <Editor />
     );
     `, // -----
-    'rename nothing if UNSAFE_cards prop not set',
-  );
+		'rename nothing if UNSAFE_cards prop not set',
+	);
 
-  defineInlineTest(
-    { default: transformer, parser: 'tsx' },
-    {},
-    `
+	defineInlineTest(
+		{ default: transformer, parser: 'tsx' },
+		{},
+		`
     import React from 'react';
     import { Editor } from '@atlaskit/editor-core';
 
@@ -44,7 +42,7 @@ describe('Rename UNSAFE_cards to smartLinks', () => {
       <Editor smartLinks />
     );
     `, // -----
-    `
+		`
     import React from 'react';
     import { Editor } from '@atlaskit/editor-core';
 
@@ -52,13 +50,13 @@ describe('Rename UNSAFE_cards to smartLinks', () => {
       <Editor smartLinks />
     );
     `, // -----
-    'rename nothing if boolean prop',
-  );
+		'rename nothing if boolean prop',
+	);
 
-  defineInlineTest(
-    { default: transformer, parser: 'tsx' },
-    {},
-    `
+	defineInlineTest(
+		{ default: transformer, parser: 'tsx' },
+		{},
+		`
     import React from 'react';
     import { Editor } from '@atlaskit/editor-core';
 
@@ -66,7 +64,7 @@ describe('Rename UNSAFE_cards to smartLinks', () => {
       <Editor smartLinks={{ provider: Promise.resolve({})}} />
     );
     `, // -----
-    `
+		`
     import React from 'react';
     import { Editor } from '@atlaskit/editor-core';
 
@@ -74,13 +72,13 @@ describe('Rename UNSAFE_cards to smartLinks', () => {
       <Editor smartLinks={{ provider: Promise.resolve({})}} />
     );
     `, // -----
-    'rename nothing if UNSAFE_cards not found',
-  );
+		'rename nothing if UNSAFE_cards not found',
+	);
 
-  defineInlineTest(
-    { default: transformer, parser: 'tsx' },
-    {},
-    `
+	defineInlineTest(
+		{ default: transformer, parser: 'tsx' },
+		{},
+		`
     import React from 'react';
     import { Editor } from '@atlaskit/editor-core';
 
@@ -88,7 +86,7 @@ describe('Rename UNSAFE_cards to smartLinks', () => {
       <Editor UNSAFE_cards={{ provider: Promise.resolve({}), allowEmbeds: true }} />
     );
     `, // -----
-    `
+		`
     import React from 'react';
     import { Editor } from '@atlaskit/editor-core';
 
@@ -96,13 +94,13 @@ describe('Rename UNSAFE_cards to smartLinks', () => {
       <Editor smartLinks={{ provider: Promise.resolve({}), allowEmbeds: true }} />
     );
     `, // -----
-    'rename UNSAFE_cards to smartLinks and do not change other options',
-  );
+		'rename UNSAFE_cards to smartLinks and do not change other options',
+	);
 
-  defineInlineTest(
-    { default: transformer, parser: 'tsx' },
-    {},
-    `
+	defineInlineTest(
+		{ default: transformer, parser: 'tsx' },
+		{},
+		`
     import React from 'react';
     import { Editor as AKEditor } from '@atlaskit/editor-core';
 
@@ -110,7 +108,7 @@ describe('Rename UNSAFE_cards to smartLinks', () => {
       <AKEditor UNSAFE_cards={{ provider: Promise.resolve({}) }} />
     );
     `, // -----
-    `
+		`
     import React from 'react';
     import { Editor as AKEditor } from '@atlaskit/editor-core';
 
@@ -118,13 +116,13 @@ describe('Rename UNSAFE_cards to smartLinks', () => {
       <AKEditor smartLinks={{ provider: Promise.resolve({}) }} />
     );
     `, // -----
-    'rename UNSAFE_cards to smartLinks when Editor is renamed',
-  );
+		'rename UNSAFE_cards to smartLinks when Editor is renamed',
+	);
 
-  defineInlineTest(
-    { default: transformer, parser: 'tsx' },
-    {},
-    `
+	defineInlineTest(
+		{ default: transformer, parser: 'tsx' },
+		{},
+		`
     import React from 'react';
 
     const Editor = (props) => {
@@ -135,7 +133,7 @@ describe('Rename UNSAFE_cards to smartLinks', () => {
       <Editor UNSAFE_cards={{ provider: Promise.resolve({}) }} />
     );
     `, // -----
-    `
+		`
     import React from 'react';
 
     const Editor = (props) => {
@@ -146,6 +144,6 @@ describe('Rename UNSAFE_cards to smartLinks', () => {
       <Editor UNSAFE_cards={{ provider: Promise.resolve({}) }} />
     );
     `, // -----
-    'rename nothing if UNSAFE_cards for Editor is not from @atlaskit/editor-core',
-  );
+		'rename nothing if UNSAFE_cards for Editor is not from @atlaskit/editor-core',
+	);
 });

package/codemods/migrates/next-remove-allow-more-text-colors-prop.ts

@@ -7,49 +7,45 @@ import { findImportFromPackage } from '../utils';
  * from `allowTextColor` Editor prop.
  * Ref: ED-15849
  */
-const createRemoveAllowMoreTextColorsPropTransform = (
-  pkg: string,
-  component: string,
-) => {
-  return (j: core.JSCodeshift, source: Collection<any>) => {
-    // Find regular or renamed imports
-    // of <Editor/> component from '@atlaskit/editor-core' package
-    const importedNames: string[] = findImportFromPackage(
-      j,
-      source,
-      '@atlaskit/editor-core',
-      'Editor',
-    );
-    // Make the change on all instances of named imports found
-    importedNames.forEach((importedComponentName) => {
-      // Find `allowTextColor` prop
-      const allowTextColorCollection = source.find(j.JSXAttribute, {
-        name: {
-          type: 'JSXIdentifier',
-          name: 'allowTextColor',
-        },
-      });
-      allowTextColorCollection
-        .find(j.ObjectProperty, { key: { name: 'allowMoreTextColors' } })
-        .forEach((x) => j(x).remove());
-      // If the remaining `allowTextColor` prop is an empty object, set `allowTextColor` to `true`.
-      allowTextColorCollection.forEach((allowTextColorPath) => {
-        j(allowTextColorPath).find(j.ObjectExpression, (objectExpression) => {
-          if (objectExpression.properties.length === 0) {
-            j(allowTextColorPath).replaceWith(
-              j.jsxAttribute(
-                j.jsxIdentifier('allowTextColor'),
-                j.jsxExpressionContainer(j.booleanLiteral(true)),
-              ),
-            );
-          }
-        });
-      });
-    });
-  };
+const createRemoveAllowMoreTextColorsPropTransform = (pkg: string, component: string) => {
+	return (j: core.JSCodeshift, source: Collection<any>) => {
+		// Find regular or renamed imports
+		// of <Editor/> component from '@atlaskit/editor-core' package
+		const importedNames: string[] = findImportFromPackage(
+			j,
+			source,
+			'@atlaskit/editor-core',
+			'Editor',
+		);
+		// Make the change on all instances of named imports found
+		importedNames.forEach((importedComponentName) => {
+			// Find `allowTextColor` prop
+			const allowTextColorCollection = source.find(j.JSXAttribute, {
+				name: {
+					type: 'JSXIdentifier',
+					name: 'allowTextColor',
+				},
+			});
+			allowTextColorCollection
+				.find(j.ObjectProperty, { key: { name: 'allowMoreTextColors' } })
+				.forEach((x) => j(x).remove());
+			// If the remaining `allowTextColor` prop is an empty object, set `allowTextColor` to `true`.
+			allowTextColorCollection.forEach((allowTextColorPath) => {
+				j(allowTextColorPath).find(j.ObjectExpression, (objectExpression) => {
+					if (objectExpression.properties.length === 0) {
+						j(allowTextColorPath).replaceWith(
+							j.jsxAttribute(
+								j.jsxIdentifier('allowTextColor'),
+								j.jsxExpressionContainer(j.booleanLiteral(true)),
+							),
+						);
+					}
+				});
+			});
+		});
+	};
 };
-export const removeAllowMoreColorsProp =
-  createRemoveAllowMoreTextColorsPropTransform(
-    '@atlaskit/editor-core',
-    'Editor',
-  );
+export const removeAllowMoreColorsProp = createRemoveAllowMoreTextColorsPropTransform(
+	'@atlaskit/editor-core',
+	'Editor',
+);

package/codemods/migrates/remove-config-panel-width-prop.ts

@@ -3,37 +3,28 @@ import type { Collection } from 'jscodeshift/src/Collection';
 
 import { findImportFromPackage } from '../utils';
 
-const createRemoveComponentPropTransform = (
-  pkg: string,
-  component: string,
-  propName: string,
-) => {
-  return (j: core.JSCodeshift, source: Collection<any>) => {
-    // Find regular or renamed imports
-    const importedNames: string[] = findImportFromPackage(
-      j,
-      source,
-      pkg,
-      component,
-    );
+const createRemoveComponentPropTransform = (pkg: string, component: string, propName: string) => {
+	return (j: core.JSCodeshift, source: Collection<any>) => {
+		// Find regular or renamed imports
+		const importedNames: string[] = findImportFromPackage(j, source, pkg, component);
 
-    // Make the change on all instances of named imports found
-    importedNames.forEach((importedComponentName) => {
-      source
-        .findJSXElements(importedComponentName)
-        .find(j.JSXAttribute, {
-          name: {
-            type: 'JSXIdentifier',
-            name: propName,
-          },
-        })
-        .forEach((x) => j(x).remove());
-    });
-  };
+		// Make the change on all instances of named imports found
+		importedNames.forEach((importedComponentName) => {
+			source
+				.findJSXElements(importedComponentName)
+				.find(j.JSXAttribute, {
+					name: {
+						type: 'JSXIdentifier',
+						name: propName,
+					},
+				})
+				.forEach((x) => j(x).remove());
+		});
+	};
 };
 
 export const removeConfigPanelWidthProp = createRemoveComponentPropTransform(
-  '@atlaskit/editor-core',
-  'ContextPanel',
-  'width',
+	'@atlaskit/editor-core',
+	'ContextPanel',
+	'width',
 );

package/codemods/migrates/rename-editor-to-editor-migration-component.ts

@@ -6,29 +6,25 @@ import type { Collection } from 'jscodeshift/src/Collection';
  * EditorMigrationComponent
  * Ref: ED-16826
  */
-export const createUpdateEditorToMigrationComponent = (
-  pkg: string,
-  component: string,
-) => {
-  return (j: core.JSCodeshift, source: Collection<any>) => {
-    source
-      .find(j.ImportDeclaration, { source: { value: pkg } })
-      .filter(
-        (path) =>
-          j(path).find(j.ImportSpecifier, {
-            imported: { type: 'Identifier', name: component },
-          }).length > 0,
-      )
-      .find(j.ImportSpecifier)
-      .filter((path) => path.node.imported.name === component)
-      .replaceWith((currentImport) =>
-        j.importSpecifier(
-          j.identifier('EditorMigrationComponent'),
-          currentImport.node.local,
-        ),
-      );
-  };
+export const createUpdateEditorToMigrationComponent = (pkg: string, component: string) => {
+	return (j: core.JSCodeshift, source: Collection<any>) => {
+		source
+			.find(j.ImportDeclaration, { source: { value: pkg } })
+			.filter(
+				(path) =>
+					j(path).find(j.ImportSpecifier, {
+						imported: { type: 'Identifier', name: component },
+					}).length > 0,
+			)
+			.find(j.ImportSpecifier)
+			.filter((path) => path.node.imported.name === component)
+			.replaceWith((currentImport) =>
+				j.importSpecifier(j.identifier('EditorMigrationComponent'), currentImport.node.local),
+			);
+	};
 };
 
-export const renameEditorToMigrationComponent =
-  createUpdateEditorToMigrationComponent('@atlaskit/editor-core', 'Editor');
+export const renameEditorToMigrationComponent = createUpdateEditorToMigrationComponent(
+	'@atlaskit/editor-core',
+	'Editor',
+);

package/codemods/migrates/rename-smartlinks-prop.ts

@@ -10,47 +10,39 @@ import type { Collection } from 'jscodeshift/src/Collection';
  * @param toObjectKey String
  */
 export const createJSXRenameVariableToNestedKeyTransform = (
-  from: string,
-  toObjectName: string,
-  toObjectKey: string,
+	from: string,
+	toObjectName: string,
+	toObjectKey: string,
 ) => {
-  return (j: core.JSCodeshift, source: Collection<any>) => {
-    source
-      .find(j.JSXAttribute, { name: { type: 'JSXIdentifier', name: from } })
-      .forEach((fromAttribute) => {
-        // is there an existing destination prop
-        const isExistingAttribute =
-          source.find(j.JSXAttribute, {
-            name: { type: 'JSXIdentifier', name: toObjectName },
-          }).length !== 0;
+	return (j: core.JSCodeshift, source: Collection<any>) => {
+		source
+			.find(j.JSXAttribute, { name: { type: 'JSXIdentifier', name: from } })
+			.forEach((fromAttribute) => {
+				// is there an existing destination prop
+				const isExistingAttribute =
+					source.find(j.JSXAttribute, {
+						name: { type: 'JSXIdentifier', name: toObjectName },
+					}).length !== 0;
 
-        if (
-          !isExistingAttribute &&
-          fromAttribute.node.value?.type === 'JSXExpressionContainer' &&
-          fromAttribute.node.value.expression.type === 'ObjectExpression'
-        ) {
-          const existingProperties =
-            fromAttribute.node.value.expression.properties;
-          const newObject = j.objectExpression([
-            j.property(
-              'init',
-              j.identifier(toObjectKey),
-              j.objectExpression(existingProperties),
-            ),
-          ]);
-          fromAttribute.replace(
-            j.jsxAttribute(
-              j.jsxIdentifier(toObjectName),
-              j.jsxExpressionContainer(newObject),
-            ),
-          );
-        }
-      });
-  };
+				if (
+					!isExistingAttribute &&
+					fromAttribute.node.value?.type === 'JSXExpressionContainer' &&
+					fromAttribute.node.value.expression.type === 'ObjectExpression'
+				) {
+					const existingProperties = fromAttribute.node.value.expression.properties;
+					const newObject = j.objectExpression([
+						j.property('init', j.identifier(toObjectKey), j.objectExpression(existingProperties)),
+					]);
+					fromAttribute.replace(
+						j.jsxAttribute(j.jsxIdentifier(toObjectName), j.jsxExpressionContainer(newObject)),
+					);
+				}
+			});
+	};
 };
 
 export const renameSmartLinksProp = createJSXRenameVariableToNestedKeyTransform(
-  'smartLinks',
-  'linking',
-  'smartLinks',
+	'smartLinks',
+	'linking',
+	'smartLinks',
 );

package/codemods/migrates/rename-unsafe-allowUndoRedoButtons-prop.ts

@@ -1,7 +1,6 @@
 import { createRenameVariableTransform } from '../utils';
 
-export const renameUnsafeAllowUndoRedoButtonsProp =
-  createRenameVariableTransform(
-    'UNSAFE_allowUndoRedoButtons',
-    'allowUndoRedoButtons',
-  );
+export const renameUnsafeAllowUndoRedoButtonsProp = createRenameVariableTransform(
+	'UNSAFE_allowUndoRedoButtons',
+	'allowUndoRedoButtons',
+);

package/codemods/migrates/rename-unsafe-cards-prop.ts

@@ -1,6 +1,3 @@
 import { createRenameVariableTransform } from '../utils';
 
-export const renameUnsafeCardProp = createRenameVariableTransform(
-  'UNSAFE_cards',
-  'smartLinks',
-);
+export const renameUnsafeCardProp = createRenameVariableTransform('UNSAFE_cards', 'smartLinks');

package/codemods/utils.ts

@@ -1,44 +1,34 @@
 import type {
-  API,
-  ASTPath,
-  default as core,
-  FileInfo,
-  ImportDeclaration,
-  Options,
+	API,
+	ASTPath,
+	default as core,
+	FileInfo,
+	ImportDeclaration,
+	Options,
 } from 'jscodeshift';
 import type { Collection } from 'jscodeshift/src/Collection';
 
-function hasImportDeclaration(
-  j: core.JSCodeshift,
-  source: Collection<any>,
-  importPath: string,
-) {
-  const imports = source
-    .find(j.ImportDeclaration)
-    .filter(
-      (path: ASTPath<ImportDeclaration>) =>
-        path.node.source.value === importPath,
-    );
+function hasImportDeclaration(j: core.JSCodeshift, source: Collection<any>, importPath: string) {
+	const imports = source
+		.find(j.ImportDeclaration)
+		.filter((path: ASTPath<ImportDeclaration>) => path.node.source.value === importPath);
 
-  return Boolean(imports.length);
+	return Boolean(imports.length);
 }
 
 export const createTransformer =
-  (
-    packageName: string,
-    migrations: { (j: core.JSCodeshift, source: Collection<any>): void }[],
-  ) =>
-  (fileInfo: FileInfo, { jscodeshift: j }: API, options: Options) => {
-    const source = j(fileInfo.source);
+	(packageName: string, migrations: { (j: core.JSCodeshift, source: Collection<any>): void }[]) =>
+	(fileInfo: FileInfo, { jscodeshift: j }: API, options: Options) => {
+		const source = j(fileInfo.source);
 
-    if (!hasImportDeclaration(j, source, packageName)) {
-      return fileInfo.source;
-    }
+		if (!hasImportDeclaration(j, source, packageName)) {
+			return fileInfo.source;
+		}
 
-    migrations.forEach((transform) => transform(j, source));
+		migrations.forEach((transform) => transform(j, source));
 
-    return source.toSource(options.printOptions || { quote: 'single' });
-  };
+		return source.toSource(options.printOptions || { quote: 'single' });
+	};
 
 /**
  * Finds import from a particular path/package matching a particular name.
@@ -51,45 +41,45 @@ export const createTransformer =
  * @returns String[] Array of result names which match the specified importName
  */
 export const findImportFromPackage = (
-  j: core.JSCodeshift,
-  source: Collection<any>,
-  pkg: string,
-  importName: string,
+	j: core.JSCodeshift,
+	source: Collection<any>,
+	pkg: string,
+	importName: string,
 ): string[] => {
-  // Find regular or renamed imports
-  return (
-    source
-      // find all import statements which import from the given package
-      .find(j.ImportDeclaration, {
-        source: {
-          value: pkg,
-        },
-      })
-      // narrow down to imports related to 'component'
-      .filter(
-        (importDeclaration) =>
-          j(importDeclaration).find(j.ImportSpecifier, {
-            imported: {
-              type: 'Identifier',
-              name: importName,
-            },
-          }).length > 0,
-      )
-      .nodes()
-      .map((importDeclaration): string => {
-        const importSpecifier = j(importDeclaration)
-          .find(j.ImportSpecifier, {
-            imported: {
-              type: 'Identifier',
-              name: importName,
-            },
-          })
-          .nodes()[0];
+	// Find regular or renamed imports
+	return (
+		source
+			// find all import statements which import from the given package
+			.find(j.ImportDeclaration, {
+				source: {
+					value: pkg,
+				},
+			})
+			// narrow down to imports related to 'component'
+			.filter(
+				(importDeclaration) =>
+					j(importDeclaration).find(j.ImportSpecifier, {
+						imported: {
+							type: 'Identifier',
+							name: importName,
+						},
+					}).length > 0,
+			)
+			.nodes()
+			.map((importDeclaration): string => {
+				const importSpecifier = j(importDeclaration)
+					.find(j.ImportSpecifier, {
+						imported: {
+							type: 'Identifier',
+							name: importName,
+						},
+					})
+					.nodes()[0];
 
-        return importSpecifier.local?.name || '';
-      })
-      .filter((name) => Boolean(name))
-  );
+				return importSpecifier.local?.name || '';
+			})
+			.filter((name) => Boolean(name))
+	);
 };
 
 /**
@@ -99,9 +89,9 @@ export const findImportFromPackage = (
  * @param toName String
  */
 export const createRenameVariableTransform = (from: string, toName: string) => {
-  return (j: core.JSCodeshift, source: Collection<any>) => {
-    source.find(j.Identifier, { name: from }).forEach((x) => {
-      x.replace(j.identifier(toName));
-    });
-  };
+	return (j: core.JSCodeshift, source: Collection<any>) => {
+		source.find(j.Identifier, { name: from }).forEach((x) => {
+			x.replace(j.identifier(toName));
+		});
+	};
 };