fix(no-deprecated-type-references): add IInputGroupProps2 (#6075)

palantir · Apr 18, 2023 · 120130a · 120130a · adidahiya · Apr 18, 2023
1 parent 6dab069
commit 120130a
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 8 deletions.
diff --git a/packages/core/src/common/props.ts b/packages/core/src/common/props.ts
@@ -159,7 +159,7 @@ export type OptionProps = IOptionProps;
 const INVALID_PROPS = [
     "active",
     "alignText",
-    "asyncControl", // IInputGroupProps2
+    "asyncControl", // InputGroupProps2
     "containerRef",
     "current",
     "elementRef",

diff --git a/packages/core/src/components/forms/inputGroup.tsx b/packages/core/src/components/forms/inputGroup.tsx
@@ -33,11 +33,12 @@ import { Icon, IconName } from "../icon/icon";
 import { AsyncControllableInput } from "./asyncControllableInput";
 import type { InputSharedProps } from "./inputSharedProps";
 
+/** @deprecated use InputGroupProps2 */
 // eslint-disable-next-line deprecation/deprecation
 export type InputGroupProps = IInputGroupProps;
 
 /**
- * @deprecated use IInputGroupProps2.
+ * @deprecated use InputGroupProps2.
  *
  * NOTE: This interface does not extend HTMLInputProps due to incompatiblity with `IControlledProps`.
  * Instead, we union the props in the component definition, which does work and properly disallows `string[]` values.
@@ -122,10 +123,10 @@ export interface IInputGroupProps
     type?: string;
 }
 
-// eslint-disable-next-line deprecation/deprecation
-export type InputGroupProps2 = IInputGroupProps2;
 /** @deprecated use InputGroupProps2 */
-export interface IInputGroupProps2
+export type IInputGroupProps2 = InputGroupProps2;
+
+export interface InputGroupProps2
     extends Omit<HTMLInputProps, keyof ControlledProps2>,
         ControlledProps2,
         InputSharedProps {

diff --git a/packages/core/src/components/forms/text-inputs.md b/packages/core/src/components/forms/text-inputs.md
@@ -36,7 +36,7 @@ but there is basic support for it using the `asyncControl` prop. Note that the i
 to the end of the input if the speed of text entry (time between change events) is faster than the
 speed of the async update.
 
-@interface IInputGroupProps
+@interface InputGroupProps2
 
 @### CSS
 

diff --git a/packages/eslint-plugin/src/rules/no-deprecated-type-references.ts b/packages/eslint-plugin/src/rules/no-deprecated-type-references.ts
@@ -28,7 +28,8 @@ const DEPRECATED_TYPE_REFERENCES_BY_PACKAGE = {
         "IIntentProps",
         "IActionProps",
         "ILinkProps",
-        "IControlledProps",
+        ["IControlledProps", "ControlledProps2"],
+        "IControlledProps2",
         "IOptionProps",
         "IKeyAllowlist",
         "IKeyDenylist",
@@ -53,7 +54,8 @@ const DEPRECATED_TYPE_REFERENCES_BY_PACKAGE = {
         "ICheckboxProps",
         "IFileInputProps",
         "IFormGroupProps",
-        "IInputGroupProps",
+        ["IInputGroupProps", "InputGroupProps2"],
+        "IInputGroupProps2",
         "INumericInputProps",
         "IRadioGroupProps",
         "ITextAreaProps",