@atlaskit/popper 5.6.0 → 6.1.0

package/codemods/__tests__/update-render-props.tsx

@@ -5,17 +5,17 @@ import transformer from '../5.0.0-lite-mode';
 const defineInlineTest = require('jscodeshift/dist/testUtils').defineInlineTest;
 
 describe('Update props', () => {
-  /**
-   * It should rename outOfBoundaries and scheduleUpdate props
-   * Render Props:
-   * - `outOfBoundaries` has been replaced with `isReferenceHidden`, and is now true when the popper is hidden (i.e. by a
-   * scroll container)
-   * - `scheduleUpdate`, for async updates, has been renamed to `update`, and now returns a Promise.
-   */
-  defineInlineTest(
-    { default: transformer, parser: 'tsx' },
-    {},
-    `
+	/**
+	 * It should rename outOfBoundaries and scheduleUpdate props
+	 * Render Props:
+	 * - `outOfBoundaries` has been replaced with `isReferenceHidden`, and is now true when the popper is hidden (i.e. by a
+	 * scroll container)
+	 * - `scheduleUpdate`, for async updates, has been renamed to `update`, and now returns a Promise.
+	 */
+	defineInlineTest(
+		{ default: transformer, parser: 'tsx' },
+		{},
+		`
     import { Popper } from '@atlaskit/popper';
 
     export default () => (
@@ -35,7 +35,7 @@ describe('Update props', () => {
       </Popper>
     )
   `,
-    `
+		`
     import { Popper } from '@atlaskit/popper';
 
     export default () => (
@@ -55,5 +55,5 @@ describe('Update props', () => {
       </Popper>
     )
   `,
-  );
+	);
 });

package/codemods/utils/helpers.tsx

@@ -1,260 +1,256 @@
-import { NodePath } from 'ast-types/lib/node-path';
-import core, {
-  ASTPath,
-  ImportDeclaration,
-  JSXAttribute,
-  JSXElement,
-  Node,
+import { type NodePath } from 'ast-types/lib/node-path';
+import {
+	type ASTPath,
+	type default as core,
+	type ImportDeclaration,
+	type JSXAttribute,
+	type JSXElement,
+	type Node,
 } from 'jscodeshift';
-import { Collection } from 'jscodeshift/src/Collection';
+import { type Collection } from 'jscodeshift/src/Collection';
 
 export type Nullable<T> = T | null;
 
 export function hasImportDeclaration(
-  j: core.JSCodeshift,
-  source: string,
-  importPath: string,
+	j: core.JSCodeshift,
+	source: string,
+	importPath: string,
 ): boolean {
-  return (
-    j(source)
-      .find(j.ImportDeclaration)
-      .filter(
-        (path: ASTPath<ImportDeclaration>) =>
-          path.node.source.value === importPath,
-      ).length > 0
-  );
+	return (
+		j(source)
+			.find(j.ImportDeclaration)
+			.filter((path: ASTPath<ImportDeclaration>) => path.node.source.value === importPath).length >
+		0
+	);
 }
 
 export function getDefaultSpecifierName({
-  j,
-  base,
-  packageName,
+	j,
+	base,
+	packageName,
 }: {
-  j: core.JSCodeshift;
-  base: Collection<any>;
-  packageName: string;
+	j: core.JSCodeshift;
+	base: Collection<any>;
+	packageName: string;
 }): Nullable<string> {
-  const specifiers = base
-    .find(j.ImportDeclaration)
-    .filter((path) => path.node.source.value === packageName)
-    .find(j.ImportDefaultSpecifier);
+	const specifiers = base
+		.find(j.ImportDeclaration)
+		.filter((path) => path.node.source.value === packageName)
+		.find(j.ImportDefaultSpecifier);
 
-  if (!specifiers.length) {
-    return null;
-  }
-  return specifiers.nodes()[0]!.local!.name;
+	if (!specifiers.length) {
+		return null;
+	}
+	return specifiers.nodes()[0]!.local!.name;
 }
 
 export function getSpecifierName({
-  j,
-  base,
-  packageName,
-  component,
+	j,
+	base,
+	packageName,
+	component,
 }: {
-  j: core.JSCodeshift;
-  base: Collection<any>;
-  packageName: string;
-  component: string;
+	j: core.JSCodeshift;
+	base: Collection<any>;
+	packageName: string;
+	component: string;
 }): Nullable<string> {
-  const specifiers = base
-    .find(j.ImportDeclaration)
-    .filter((path) => path.node.source.value === packageName)
-    .find(j.ImportSpecifier);
+	const specifiers = base
+		.find(j.ImportDeclaration)
+		.filter((path) => path.node.source.value === packageName)
+		.find(j.ImportSpecifier);
 
-  if (!specifiers.length) {
-    return null;
-  }
-  const specifierNode = specifiers
-    .nodes()
-    .find((node) => node.imported.name === component);
-  if (!specifierNode) {
-    return null;
-  }
-  // @ts-ignore
-  return specifierNode.local.name;
+	if (!specifiers.length) {
+		return null;
+	}
+	const specifierNode = specifiers.nodes().find((node) => node.imported.name === component);
+	if (!specifierNode) {
+		return null;
+	}
+	// @ts-ignore
+	return specifierNode.local.name;
 }
 
 export function getJSXAttributesByName({
-  j,
-  element,
-  attributeName,
+	j,
+	element,
+	attributeName,
 }: {
-  j: core.JSCodeshift;
-  element: JSXElement | ASTPath<JSXElement>;
-  attributeName: string;
+	j: core.JSCodeshift;
+	element: JSXElement | ASTPath<JSXElement>;
+	attributeName: string;
 }): Collection<JSXAttribute> {
-  return j(element)
-    .find(j.JSXOpeningElement)
-    .find(j.JSXAttribute)
-    .filter((attribute) => {
-      const matches = j(attribute)
-        .find(j.JSXIdentifier)
-        .filter((identifier) => identifier.value.name === attributeName);
-      return Boolean(matches.length);
-    });
+	return j(element)
+		.find(j.JSXOpeningElement)
+		.find(j.JSXAttribute)
+		.filter((attribute) => {
+			const matches = j(attribute)
+				.find(j.JSXIdentifier)
+				.filter((identifier) => identifier.value.name === attributeName);
+			return Boolean(matches.length);
+		});
 }
 
 export function hasJSXAttributesByName({
-  j,
-  element,
-  attributeName,
+	j,
+	element,
+	attributeName,
 }: {
-  j: core.JSCodeshift;
-  element: JSXElement;
-  attributeName: string;
+	j: core.JSCodeshift;
+	element: JSXElement;
+	attributeName: string;
 }): boolean {
-  return getJSXAttributesByName({ j, element, attributeName }).length > 0;
+	return getJSXAttributesByName({ j, element, attributeName }).length > 0;
 }
 
 export function isUsingSupportedSpread({
-  j,
-  base,
-  element,
+	j,
+	base,
+	element,
 }: {
-  j: core.JSCodeshift;
-  base: Collection<any>;
-  element: NodePath<JSXElement, JSXElement>;
+	j: core.JSCodeshift;
+	base: Collection<any>;
+	element: NodePath<JSXElement, JSXElement>;
 }): boolean {
-  const isUsingSpread: boolean =
-    j(element).find(j.JSXSpreadAttribute).length > 0;
+	const isUsingSpread: boolean = j(element).find(j.JSXSpreadAttribute).length > 0;
 
-  if (!isUsingSpread) {
-    return true;
-  }
+	if (!isUsingSpread) {
+		return true;
+	}
 
-  return (
-    j(element)
-      .find(j.JSXSpreadAttribute)
-      .filter((spread) => {
-        const argument = spread.value.argument;
-        // in place expression is supported
-        if (argument.type === 'ObjectExpression') {
-          return true;
-        }
+	return (
+		j(element)
+			.find(j.JSXSpreadAttribute)
+			.filter((spread) => {
+				const argument = spread.value.argument;
+				// in place expression is supported
+				if (argument.type === 'ObjectExpression') {
+					return true;
+				}
 
-        // Supporting identifiers that point to an a local object expression
-        if (argument.type === 'Identifier') {
-          return (
-            base.find(j.VariableDeclarator).filter((declarator): boolean => {
-              return (
-                declarator.value.id.type === 'Identifier' &&
-                // @ts-ignore
-                declarator.value.init.type === 'ObjectExpression'
-              );
-            }).length > 0
-          );
-        }
+				// Supporting identifiers that point to an a local object expression
+				if (argument.type === 'Identifier') {
+					return (
+						base.find(j.VariableDeclarator).filter((declarator): boolean => {
+							return (
+								declarator.value.id.type === 'Identifier' &&
+								// @ts-ignore
+								declarator.value.init.type === 'ObjectExpression'
+							);
+						}).length > 0
+					);
+				}
 
-        // We don't support anything else
-        return false;
-      }).length > 0
-  );
+				// We don't support anything else
+				return false;
+			}).length > 0
+	);
 }
 
 export function isUsingThroughSpread({
-  j,
-  base,
-  element,
-  propName,
+	j,
+	base,
+	element,
+	propName,
 }: {
-  j: core.JSCodeshift;
-  base: Collection<any>;
-  element: NodePath<JSXElement, JSXElement>;
-  propName: string;
+	j: core.JSCodeshift;
+	base: Collection<any>;
+	element: NodePath<JSXElement, JSXElement>;
+	propName: string;
 }): boolean {
-  if (!isUsingSupportedSpread({ j, base, element })) {
-    return false;
-  }
+	if (!isUsingSupportedSpread({ j, base, element })) {
+		return false;
+	}
 
-  const isUsedThroughExpression: boolean =
-    j(element)
-      .find(j.JSXSpreadAttribute)
-      .find(j.ObjectExpression)
-      .filter((item) => {
-        const match: boolean =
-          item.value.properties.filter(
-            (property) =>
-              property.type === 'ObjectProperty' &&
-              property.key.type === 'Identifier' &&
-              property.key.name === propName,
-          ).length > 0;
+	const isUsedThroughExpression: boolean =
+		j(element)
+			.find(j.JSXSpreadAttribute)
+			.find(j.ObjectExpression)
+			.filter((item) => {
+				const match: boolean =
+					item.value.properties.filter(
+						(property) =>
+							property.type === 'ObjectProperty' &&
+							property.key.type === 'Identifier' &&
+							property.key.name === propName,
+					).length > 0;
 
-        return match;
-      }).length > 0;
+				return match;
+			}).length > 0;
 
-  if (isUsedThroughExpression) {
-    return true;
-  }
+	if (isUsedThroughExpression) {
+		return true;
+	}
 
-  const isUsedThroughIdentifier: boolean =
-    j(element)
-      .find(j.JSXSpreadAttribute)
-      .find(j.Identifier)
-      .filter((identifier): boolean => {
-        return (
-          base
-            .find(j.VariableDeclarator)
-            .filter(
-              (declarator) =>
-                declarator.value.id.type === 'Identifier' &&
-                declarator.value.id.name === identifier.value.name,
-            )
-            .filter((declarator) => {
-              const value = declarator.value;
-              if (value.id.type !== 'Identifier') {
-                return false;
-              }
+	const isUsedThroughIdentifier: boolean =
+		j(element)
+			.find(j.JSXSpreadAttribute)
+			.find(j.Identifier)
+			.filter((identifier): boolean => {
+				return (
+					base
+						.find(j.VariableDeclarator)
+						.filter(
+							(declarator) =>
+								declarator.value.id.type === 'Identifier' &&
+								declarator.value.id.name === identifier.value.name,
+						)
+						.filter((declarator) => {
+							const value = declarator.value;
+							if (value.id.type !== 'Identifier') {
+								return false;
+							}
 
-              if (value.id.name !== identifier.value.name) {
-                return false;
-              }
-              // @ts-ignore
-              if (value.init.type !== 'ObjectExpression') {
-                return false;
-              }
+							if (value.id.name !== identifier.value.name) {
+								return false;
+							}
+							// @ts-ignore
+							if (value.init.type !== 'ObjectExpression') {
+								return false;
+							}
 
-              const match: boolean =
-                // @ts-ignore
-                value.init.properties.filter(
-                  // @ts-ignore
-                  (property) =>
-                    property.type === 'ObjectProperty' &&
-                    property.key.type === 'Identifier' &&
-                    property.key.name === propName,
-                ).length > 0;
+							const match: boolean =
+								// @ts-ignore
+								value.init.properties.filter(
+									// @ts-ignore
+									(property) =>
+										property.type === 'ObjectProperty' &&
+										property.key.type === 'Identifier' &&
+										property.key.name === propName,
+								).length > 0;
 
-              return match;
-            }).length > 0
-        );
-      }).length > 0;
+							return match;
+						}).length > 0
+				);
+			}).length > 0;
 
-  return isUsedThroughIdentifier;
+	return isUsedThroughIdentifier;
 }
 
 export function isUsingProp({
-  j,
-  base,
-  element,
-  propName,
+	j,
+	base,
+	element,
+	propName,
 }: {
-  j: core.JSCodeshift;
-  base: Collection<any>;
-  element: NodePath<JSXElement, JSXElement>;
-  propName: string;
+	j: core.JSCodeshift;
+	base: Collection<any>;
+	element: NodePath<JSXElement, JSXElement>;
+	propName: string;
 }): boolean {
-  return (
-    hasJSXAttributesByName({
-      j,
-      element: element.value,
-      attributeName: propName,
-    }) ||
-    isUsingThroughSpread({
-      j,
-      base,
-      element,
-      propName,
-    })
-  );
+	return (
+		hasJSXAttributesByName({
+			j,
+			element: element.value,
+			attributeName: propName,
+		}) ||
+		isUsingThroughSpread({
+			j,
+			base,
+			element,
+			propName,
+		})
+	);
 }
 
 // not replacing newlines (which \s does)
@@ -262,82 +258,76 @@ const spacesAndTabs: RegExp = /[ \t]{2,}/g;
 const lineStartWithSpaces: RegExp = /^[ \t]*/gm;
 
 function clean(value: string): string {
-  return (
-    value
-      .replace(spacesAndTabs, ' ')
-      .replace(lineStartWithSpaces, '')
-      // using .trim() to clear the any newlines before the first text and after last text
-      .trim()
-  );
+	return (
+		value
+			.replace(spacesAndTabs, ' ')
+			.replace(lineStartWithSpaces, '')
+			// using .trim() to clear the any newlines before the first text and after last text
+			.trim()
+	);
 }
 
 export function addCommentToStartOfFile({
-  j,
-  base,
-  message,
+	j,
+	base,
+	message,
 }: {
-  j: core.JSCodeshift;
-  base: Collection<Node>;
-  message: string;
+	j: core.JSCodeshift;
+	base: Collection<Node>;
+	message: string;
 }) {
-  addCommentBefore({
-    j,
-    // @ts-ignore
-    target: base.find(j.Program),
-    message,
-  });
+	addCommentBefore({
+		j,
+		// @ts-ignore
+		target: base.find(j.Program),
+		message,
+	});
 }
 
 export function addCommentBefore({
-  j,
-  target,
-  message,
+	j,
+	target,
+	message,
 }: {
-  j: core.JSCodeshift;
-  target: Collection<Node>;
-  message: string;
+	j: core.JSCodeshift;
+	target: Collection<Node>;
+	message: string;
 }) {
-  const content: string = ` TODO: (from codemod) ${clean(message)} `;
-  target.forEach((path) => {
-    path.value.comments = path.value.comments || [];
+	const content: string = ` TODO: (from codemod) ${clean(message)} `;
+	target.forEach((path) => {
+		path.value.comments = path.value.comments || [];
 
-    const exists = path.value.comments.find(
-      (comment) => comment.value === content,
-    );
+		const exists = path.value.comments.find((comment) => comment.value === content);
 
-    // avoiding duplicates of the same comment
-    if (exists) {
-      return;
-    }
+		// avoiding duplicates of the same comment
+		if (exists) {
+			return;
+		}
 
-    path.value.comments.push(j.commentBlock(content));
-  });
+		path.value.comments.push(j.commentBlock(content));
+	});
 }
 
 export function updateRenderProps(
-  j: core.JSCodeshift,
-  source: Collection<any>,
-  specifier: string,
-  oldProperty: string,
-  newProperty: string,
+	j: core.JSCodeshift,
+	source: Collection<any>,
+	specifier: string,
+	oldProperty: string,
+	newProperty: string,
 ) {
-  source.findJSXElements(specifier).forEach((element: ASTPath<JSXElement>) => {
-    j(element)
-      .find(j.ArrowFunctionExpression)
-      .find(j.ObjectPattern)
-      .find(j.ObjectProperty)
-      .filter(
-        // @ts-ignore
-        (path: ASTPath<ObjectProperty>) => path.value.key.name === oldProperty,
-      )
-      .forEach((path) => {
-        j(path).replaceWith(
-          j.property(
-            'init',
-            j.identifier(newProperty),
-            j.identifier(oldProperty),
-          ),
-        );
-      });
-  });
+	source.findJSXElements(specifier).forEach((element: ASTPath<JSXElement>) => {
+		j(element)
+			.find(j.ArrowFunctionExpression)
+			.find(j.ObjectPattern)
+			.find(j.ObjectProperty)
+			.filter(
+				// @ts-ignore
+				(path: ASTPath<ObjectProperty>) => path.value.key.name === oldProperty,
+			)
+			.forEach((path) => {
+				j(path).replaceWith(
+					j.property('init', j.identifier(newProperty), j.identifier(oldProperty)),
+				);
+			});
+	});
 }

package/dist/types/popper.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
-import { Placement, VirtualElement } from '@popperjs/core';
-import { PopperChildrenProps, PopperProps } from 'react-popper';
+import { type Placement, type VirtualElement } from '@popperjs/core';
+import { type PopperChildrenProps, type PopperProps } from 'react-popper';
 export { placements } from '@popperjs/core';
 export type { Placement, VirtualElement } from '@popperjs/core';
 export type { ManagerProps, ReferenceProps, PopperProps, PopperArrowProps, PopperChildrenProps, StrictModifier, Modifier, } from 'react-popper';

package/dist/types-ts4.5/popper.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
-import { Placement, VirtualElement } from '@popperjs/core';
-import { PopperChildrenProps, PopperProps } from 'react-popper';
+import { type Placement, type VirtualElement } from '@popperjs/core';
+import { type PopperChildrenProps, type PopperProps } from 'react-popper';
 export { placements } from '@popperjs/core';
 export type { Placement, VirtualElement } from '@popperjs/core';
 export type { ManagerProps, ReferenceProps, PopperProps, PopperArrowProps, PopperChildrenProps, StrictModifier, Modifier, } from 'react-popper';