feat(react-conformance): Deprecate conformance test `consistent-callb…

…ack-args` (#30301)
microsoft · Feb 7, 2024 · d9a7739 · d9a7739
1 parent ba59525
commit d9a7739
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 1 deletion.
diff --git a/change/@fluentui-react-conformance-431ee39f-6045-4fc2-92c0-ac5b7f5d9b6c.json b/change/@fluentui-react-conformance-431ee39f-6045-4fc2-92c0-ac5b7f5d9b6c.json
@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Deprecate consistent-callback-args test",
+  "packageName": "@fluentui/react-conformance",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/react-conformance/src/defaultTests.tsx b/packages/react-conformance/src/defaultTests.tsx
@@ -444,7 +444,10 @@ export const defaultTests: DefaultTestObject = {
     });
   },
 
-  /** Ensures that components have consistent callback arguments (ev, data) */
+  /**
+   * Ensures that components have consistent callback arguments (ev, data)
+   * @deprecated this test is for existing callbacks. The newly added callbacks' type will be guarded by eslint rule consistent-callback-type
+   */
   'consistent-callback-args': (testInfo, componentInfo, tsProgram) => {
     it('has consistent custom callback arguments (consistent-callback-args)', () => {
       const { testOptions = {} } = testInfo;

diff --git a/packages/react-conformance/src/types.ts b/packages/react-conformance/src/types.ts
@@ -137,6 +137,9 @@ export interface DefaultTestObject<TProps = {}> {
   'has-top-level-file': BaseConformanceTest<TProps>;
   'kebab-aria-attributes': ConformanceTest<TProps>;
   'consistent-callback-names': ConformanceTest<TProps>;
+  /**
+   * @deprecated this test is for existing callbacks. The newly added callbacks' type will be guarded by eslint rule consistent-callback-type
+   */
   'consistent-callback-args': ConformanceTest<TProps>;
   'primary-slot-gets-native-props': BaseConformanceTest<TProps>;
 }