[v5] break: remove various deprecated APIs, clean up ESLint comments (#…

…6125)

.eslintrc.js

@@ -55,9 +55,6 @@ module.exports = {
                 "@typescript-eslint/no-unused-expressions": "off",
                 // HACKHACK: test dependencies are only declared at root but used in all packages.
                 "import/no-extraneous-dependencies": "off",
-                // HACKHACK: added to reduce diff in https://github.com/palantir/blueprint/pull/4644,
-                // can be removed in v4.0
-                "deprecation/deprecation": "off",
             },
         },
         {

packages/core/src/common/classes.ts

@@ -208,8 +208,6 @@ export const MULTISTEP_DIALOG = `${NS}-multistep-dialog`;
 export const MULTISTEP_DIALOG_PANELS = `${MULTISTEP_DIALOG}-panels`;
 export const MULTISTEP_DIALOG_LEFT_PANEL = `${MULTISTEP_DIALOG}-left-panel`;
 export const MULTISTEP_DIALOG_RIGHT_PANEL = `${MULTISTEP_DIALOG}-right-panel`;
-/** @deprecated use `Classes.DIALOG_FOOTER` instead */
-export const MULTISTEP_DIALOG_FOOTER = `${MULTISTEP_DIALOG}-footer`;
 export const MULTISTEP_DIALOG_NAV_TOP = `${MULTISTEP_DIALOG}-nav-top`;
 export const MULTISTEP_DIALOG_NAV_RIGHT = `${MULTISTEP_DIALOG}-nav-right`;
 

packages/core/src/common/index.ts

@@ -20,8 +20,6 @@ export { AbstractComponent } from "./abstractComponent";
 export { AbstractPureComponent } from "./abstractPureComponent";
 export { Alignment } from "./alignment";
 export { Boundary } from "./boundary";
-// eslint-disable-next-line deprecation/deprecation
-export { Constructor } from "./constructor";
 export { Elevation } from "./elevation";
 export { Intent } from "./intent";
 // eslint-disable-next-line deprecation/deprecation

packages/core/src/common/refs.ts

@@ -36,11 +36,6 @@ export function setRef<T>(refTarget: React.Ref<T> | undefined, ref: T | null): v
     }
 }
 
-/** @deprecated use mergeRefs() instead */
-export function combineRefs<T>(ref1: React.RefCallback<T>, ref2: React.RefCallback<T>) {
-    return mergeRefs(ref1, ref2);
-}
-
 /**
  * Utility for merging refs into one singular callback ref.
  * If using in a functional component, would recomend using `useMemo` to preserve function identity.

packages/core/src/common/utils/compareUtils.ts

@@ -25,8 +25,6 @@ export interface KeyDenylist<T> {
     exclude: Array<keyof T>;
 }
 
-/* eslint-enable deprecation/deprecation */
-
 /**
  * Returns true if the arrays are equal. Elements will be shallowly compared by
  * default, or they will be compared using the custom `compare` function if one

packages/core/src/components/dialog/dialogStepButton.tsx

@@ -22,15 +22,13 @@ import { Tooltip, TooltipProps } from "../tooltip/tooltip";
 
 export type DialogStepButtonProps = Partial<ButtonSharedPropsAndAttributes> & {
     /** If defined, the button will be wrapped with a tooltip with the specified content. */
-    // eslint-disable-next-line deprecation/deprecation
     tooltipContent?: TooltipProps["content"];
 };
 
 export function DialogStepButton({ tooltipContent, ...props }: DialogStepButtonProps) {
     const button = <AnchorButton {...props} />;
 
     if (tooltipContent !== undefined) {
-        // eslint-disable-next-line deprecation/deprecation
         return <Tooltip content={tooltipContent}>{button}</Tooltip>;
     } else {
         return button;

packages/core/src/components/dialog/multistepDialog.tsx

@@ -217,12 +217,7 @@ export class MultistepDialog extends AbstractPureComponent<MultistepDialogProps,
         const maybeCloseButton = !showCloseButtonInFooter ? undefined : (
             <DialogStepButton text="Close" onClick={onClose} {...closeButtonProps} />
         );
-        return (
-            // eslint-disable-next-line deprecation/deprecation -- need to keep adding this class for backcompat, can be removed in next major version
-            <DialogFooter className={Classes.MULTISTEP_DIALOG_FOOTER} actions={this.renderButtons()}>
-                {maybeCloseButton}
-            </DialogFooter>
-        );
+        return <DialogFooter actions={this.renderButtons()}>{maybeCloseButton}</DialogFooter>;
     }
 
     private renderButtons() {

packages/core/src/components/menu/menuItem.tsx

@@ -256,7 +256,7 @@ export const MenuItem: React.FC<MenuItemProps> = React.forwardRef<HTMLLIElement,
         {
             // for menuitems, onClick when enter key pressed doesn't take effect like it does for a button-- fix this
             onKeyDown: clickElementOnKeyPress(["Enter", " "]),
-            // if hasSubmenu, must apply correct role and tabIndex to the outer Popover2 target <span> instead of this target element
+            // if hasSubmenu, must apply correct role and tabIndex to the outer popover target <span> instead of this target element
             role: hasSubmenu ? "none" : targetRole,
             tabIndex: hasSubmenu ? -1 : 0,
             ...removeNonHTMLProps(htmlProps),

packages/core/src/components/panel-stack/panelProps.ts

@@ -14,10 +14,15 @@
  * limitations under the License.
  */
 
-import * as React from "react";
+/**
+ * @fileoverview This component is DEPRECATED, and the code is frozen.
+ * All changes & bugfixes should be made to PanelStack2 instead.
+ */
 
 /* eslint-disable deprecation/deprecation */
 
+import * as React from "react";
+
 /**
  * An object describing a panel in a `PanelStack`.
  *

packages/core/src/components/panel-stack/panelView.tsx

@@ -14,15 +14,20 @@
  * limitations under the License.
  */
 
+/**
+ * @fileoverview This component is DEPRECATED, and the code is frozen.
+ * All changes & bugfixes should be made to PanelStack2 instead.
+ */
+
+/* eslint-disable deprecation/deprecation */
+
 import * as React from "react";
 
 import { AbstractPureComponent, Classes } from "../../common";
 import { Button } from "../button/buttons";
 import { Text } from "../text/text";
 import { IPanel } from "./panelProps";
 
-/* eslint-disable deprecation/deprecation */
-
 export interface IPanelViewProps {
     /**
      * Callback invoked when the user presses the back button or a panel invokes

packages/core/src/legacy/contextMenuLegacy.tsx

@@ -19,6 +19,8 @@
  * All changes & bugfixes should be made to ContextMenu2 instead.
  */
 
+/* eslint-disable deprecation/deprecation */
+
 import classNames from "classnames";
 import * as React from "react";
 import * as ReactDOM from "react-dom";
@@ -65,7 +67,6 @@ class ContextMenuLegacy extends AbstractPureComponent<ContextMenuLegacyProps, Co
 
         // wrap the popover in a positioned div to make sure it is properly
         // offset on the screen.
-        /* eslint-disable deprecation/deprecation */
         return (
             <div className={Classes.CONTEXT_MENU} style={this.state.offset}>
                 <Popover
@@ -87,7 +88,6 @@ class ContextMenuLegacy extends AbstractPureComponent<ContextMenuLegacyProps, Co
                 </Popover>
             </div>
         );
-        /* eslint-enable deprecation/deprecation */
     }
 
     public show(menu: JSX.Element, offset: Offset, onClose?: () => void, isDarkTheme = false) {
@@ -127,7 +127,6 @@ class ContextMenuLegacy extends AbstractPureComponent<ContextMenuLegacyProps, Co
 }
 
 let contextMenuElement: HTMLElement | undefined;
-// eslint-disable-next-line deprecation/deprecation
 let contextMenu: ContextMenuLegacy | undefined;
 
 /**
@@ -142,12 +141,10 @@ export function show(menu: JSX.Element, offset: Offset, onClose?: () => void, is
         contextMenuElement = document.createElement("div");
         contextMenuElement.classList.add(Classes.CONTEXT_MENU);
         document.body.appendChild(contextMenuElement);
-        /* eslint-disable deprecation/deprecation */
         contextMenu = ReactDOM.render<ContextMenuLegacyProps>(
             <ContextMenuLegacy onClosed={remove} />,
             contextMenuElement,
         ) as ContextMenuLegacy;
-        /* eslint-enable deprecation/deprecation */
     }
 
     contextMenu!.show(menu, offset, onClose, isDarkTheme);

packages/core/src/legacy/contextMenuTargetLegacy.tsx

@@ -14,6 +14,13 @@
  * limitations under the License.
  */
 
+/**
+ * @fileoverview This component is DEPRECATED, and the code is frozen.
+ * All changes & bugfixes should be made to ContextMenu2 instead.
+ */
+
+/* eslint-disable deprecation/deprecation */
+
 import * as React from "react";
 import * as ReactDOM from "react-dom";
 
@@ -30,8 +37,6 @@ export interface ContextMenuTargetLegacyComponent extends React.Component {
     onContextMenuClose?: () => void;
 }
 
-/* eslint-disable deprecation/deprecation */
-
 /**
  * ContextMenuTarget decorator.
  *

packages/core/test/collapse/collapseTests.tsx

@@ -48,7 +48,6 @@ describe("<Collapse>", () => {
     });
 
     it("supports custom Component", () => {
-        // eslint-disable-next-line deprecation/deprecation
         assert.isTrue(shallow(<Collapse component={MenuItem} />).is(MenuItem));
     });
 

packages/core/test/menu/menuTests.tsx

@@ -36,8 +36,6 @@ describe("<MenuDivider>", () => {
     });
 });
 
-/* eslint-disable deprecation/deprecation */
-
 describe("<Menu>", () => {
     it("React renders Menu with children", () => {
         const menu = shallow(

packages/core/test/multistep-dialog/multistepDialogTests.tsx

@@ -38,8 +38,6 @@ describe("<MultistepDialog>", () => {
             Classes.MULTISTEP_DIALOG_PANELS,
             Classes.MULTISTEP_DIALOG_LEFT_PANEL,
             Classes.MULTISTEP_DIALOG_RIGHT_PANEL,
-            // eslint-disable-next-line deprecation/deprecation -- need to keep adding this class for backcompat, can be removed in next major version
-            Classes.MULTISTEP_DIALOG_FOOTER,
             Classes.DIALOG_STEP,
             Classes.DIALOG_STEP_CONTAINER,
             Classes.DIALOG_STEP_ICON,

packages/core/test/panel-stack/panelStackTests.tsx

@@ -14,15 +14,20 @@
  * limitations under the License.
  */
 
+/**
+ * @fileoverview This component is DEPRECATED, and the code is frozen.
+ * All changes & bugfixes should be made to PanelStack2 instead.
+ */
+
+/* eslint-disable deprecation/deprecation */
+
 import { assert } from "chai";
 import { mount, ReactWrapper } from "enzyme";
 import * as React from "react";
 import { spy } from "sinon";
 
 import { Classes, IPanel, IPanelProps, PanelStack, PanelStackProps } from "../../src";
 
-/* eslint-disable deprecation/deprecation */
-
 export class TestPanel extends React.Component<IPanelProps> {
     public render() {
         return (

packages/datetime/src/common/timezoneDisplayFormat.ts

@@ -41,12 +41,6 @@ export const TimezoneDisplayFormat = {
      */
     LONG_NAME: "long-name" as "long-name",
 
-    /**
-     * @deprecated use {@link TimezoneDisplayFormat.CODE} instead
-     */
-    // eslint-disable-next-line deprecation/deprecation
-    NAME: "name" as "name",
-
     /**
      * Offset format: "-10:00", "-5:00", etc.
      */
@@ -68,9 +62,6 @@ export function formatTimezone(
     switch (displayFormat) {
         case TimezoneDisplayFormat.ABBREVIATION:
             return timezone.shortName;
-        // eslint-disable-next-line deprecation/deprecation
-        case TimezoneDisplayFormat.NAME:
-            return timezone.ianaCode;
         case TimezoneDisplayFormat.OFFSET:
             return timezone.offset;
         case TimezoneDisplayFormat.CODE:
@@ -83,5 +74,7 @@ export function formatTimezone(
             return /[-\+]/.test(shortName) || shortName === timezone.label
                 ? `${timezone.label} ${timezone.offset}`
                 : `${timezone.label} (${timezone.shortName}) ${timezone.offset}`;
+        default:
+            return undefined;
     }
 }

packages/datetime/src/components/shortcuts/shortcuts.tsx

@@ -85,8 +85,6 @@ export class Shortcuts extends React.PureComponent<ShortcutsProps> {
                 : this.props.shortcuts;
 
         const shortcutElements = shortcuts.map((shortcut, index) => (
-            // ok to use this here because it doesn't have a submenu
-            // eslint-disable-next-line deprecation/deprecation, @blueprintjs/no-deprecated-components
             <MenuItem
                 active={this.props.selectedShortcutIndex === index}
                 disabled={!this.isShortcutInRange(shortcut.dateRange)}

packages/demo-app/src/examples/MenuExample.tsx

@@ -14,8 +14,6 @@
  * limitations under the License.
  */
 
-/* eslint-disable deprecation/deprecation */
-
 import * as React from "react";
 
 import { Classes, Intent, Menu, MenuDivider, MenuItem } from "@blueprintjs/core";
@@ -30,7 +28,6 @@ export class MenuExample extends React.PureComponent {
                     <Menu className={Classes.ELEVATION_1}>
                         {Object.values(Intent).map(intent => (
                             <div key={`${intent}-menu-item`}>
-                                {/* eslint-disable-next-line @blueprintjs/no-deprecated-components */}
                                 <MenuItem intent={intent} icon="applications" text="Item" label="⌘M" />
                                 {intent !== "danger" && <MenuDivider />}
                             </div>
@@ -41,7 +38,6 @@ export class MenuExample extends React.PureComponent {
                     <Menu className={Classes.ELEVATION_1}>
                         {Object.values(Intent).map(intent => (
                             <div key={`${intent}-menu-item`}>
-                                {/* eslint-disable-next-line @blueprintjs/no-deprecated-components */}
                                 <MenuItem disabled={true} intent={intent} icon="applications" text="Item" label="⌘M" />
                                 {intent !== "danger" && <MenuDivider />}
                             </div>

packages/docs-theme/src/components/example.tsx

@@ -19,12 +19,7 @@ import * as React from "react";
 
 import { Props } from "@blueprintjs/core";
 
-/** @deprecated use ExampleProps */
-// eslint-disable-next-line @typescript-eslint/ban-types
-export type IExampleProps<T = {}> = ExampleProps<T>;
-
-// eslint-disable-next-line @typescript-eslint/ban-types
-export interface ExampleProps<T = {}> extends Props {
+export interface ExampleProps<T = object> extends Props {
     /**
      * Identifier of this example.
      * This will appear as the `data-example-id` attribute on the DOM element.

packages/select/src/common/listItemsProps.ts

@@ -33,9 +33,6 @@ export type ItemsEqualComparator<T> = (itemA: T, itemB: T) => boolean;
  */
 export type ItemsEqualProp<T> = ItemsEqualComparator<T> | keyof T;
 
-/** @deprecated use ListItemsProps */
-export type IListItemsProps<T> = ListItemsProps<T>;
-
 /** Reusable generic props for a component that operates on a filterable, selectable list of `items`. */
 export interface ListItemsProps<T> extends Props {
     /**

packages/select/src/common/listItemsUtils.ts

@@ -16,9 +16,6 @@
 
 /* eslint-disable no-underscore-dangle */
 
-/** @deprecated use CreateNewItem */
-export type ICreateNewItem = CreateNewItem;
-
 /**
  * The reserved type of the "Create Item" option in item lists. This is intended
  * not to conflict with any custom item type `T` that might be used in  item

packages/select/src/common/selectPopoverProps.ts

@@ -42,7 +42,7 @@ export interface SelectPopoverProps {
      * Optional ref for the Popover component instance.
      * This is sometimes useful to reposition the popover.
      *
-     * Note that this is defined as a specific kind of Popover2 which should be compatible with
+     * Note that this is defined as a specific kind of Popover instance which should be compatible with
      * most use cases, since it uses the default target props interface.
      */
     popoverRef?: React.RefObject<Popover<DefaultPopoverTargetHTMLProps>>;

packages/select/src/components/suggest/suggest.tsx

@@ -182,7 +182,6 @@ export class Suggest<T> extends AbstractPureComponent<SuggestProps<T>, SuggestSt
         if (this.state.isOpen === false && prevState.isOpen === true) {
             // just closed, likely by keyboard interaction
             // wait until the transition ends so there isn't a flash of content in the popover
-            /* eslint-disable-next-line deprecation/deprecation */
             const timeout = this.props.popoverProps?.transitionDuration ?? Popover.defaultProps.transitionDuration;
             setTimeout(() => this.maybeResetActiveItemToSelectedItem(), timeout);
         }

packages/select/test/suggestTests.tsx

@@ -252,7 +252,6 @@ describe("Suggest", () => {
             const modifiers = {}; // our own instance
             const wrapper = suggest({ popoverProps: getPopoverProps(false, modifiers) });
             wrapper.setProps({ popoverProps: getPopoverProps(true, modifiers) }).update();
-            /* eslint-disable-next-line deprecation/deprecation */
             assert.strictEqual(wrapper.find(Popover).prop("modifiers"), modifiers);
             assert.isTrue(onOpening.calledOnce);
         });