From 7011ae2febbe1aa574c28dfca491fafbebece889 Mon Sep 17 00:00:00 2001 From: YuanboXue-Amber Date: Fri, 12 Jan 2024 14:27:02 +0100 Subject: [PATCH 1/3] deprecate consistent-callback-args --- packages/react-conformance/src/defaultTests.tsx | 5 ++++- packages/react-conformance/src/types.ts | 3 +++ .../react-library/files/src/testing/isConformant.ts__tmpl__ | 1 + 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/packages/react-conformance/src/defaultTests.tsx b/packages/react-conformance/src/defaultTests.tsx index 1eb5d36d7013fb..2c7f648dbc5710 100644 --- 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 index 95ab76f99cd23a..44668d74d817c1 100644 --- a/packages/react-conformance/src/types.ts +++ b/packages/react-conformance/src/types.ts @@ -137,6 +137,9 @@ export interface DefaultTestObject { 'has-top-level-file': BaseConformanceTest; 'kebab-aria-attributes': ConformanceTest; 'consistent-callback-names': ConformanceTest; + /** + * @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; 'primary-slot-gets-native-props': BaseConformanceTest; } diff --git a/tools/workspace-plugin/src/generators/react-library/files/src/testing/isConformant.ts__tmpl__ b/tools/workspace-plugin/src/generators/react-library/files/src/testing/isConformant.ts__tmpl__ index a3d988f29a1728..1a4876276e2542 100644 --- a/tools/workspace-plugin/src/generators/react-library/files/src/testing/isConformant.ts__tmpl__ +++ b/tools/workspace-plugin/src/generators/react-library/files/src/testing/isConformant.ts__tmpl__ @@ -9,6 +9,7 @@ export function isConformant( tsConfig: { configName: 'tsconfig.spec.json' }, componentPath: require.main?.filename.replace('.test', ''), extraTests: griffelTests as TestObject, + disabledTests: ['consistent-callback-args'], }; baseIsConformant(defaultOptions, testInfo); From bd1c84f978d87985837c578f97c0a14f9cbfb319 Mon Sep 17 00:00:00 2001 From: YuanboXue-Amber Date: Fri, 12 Jan 2024 14:27:47 +0100 Subject: [PATCH 2/3] changelog --- ...t-conformance-431ee39f-6045-4fc2-92c0-ac5b7f5d9b6c.json | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 change/@fluentui-react-conformance-431ee39f-6045-4fc2-92c0-ac5b7f5d9b6c.json diff --git a/change/@fluentui-react-conformance-431ee39f-6045-4fc2-92c0-ac5b7f5d9b6c.json b/change/@fluentui-react-conformance-431ee39f-6045-4fc2-92c0-ac5b7f5d9b6c.json new file mode 100644 index 00000000000000..40547637003688 --- /dev/null +++ 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": "yuanboxue@microsoft.com", + "dependentChangeType": "patch" +} From d886eb652fe944e44340c69061189f95bd472126 Mon Sep 17 00:00:00 2001 From: YuanboXue-Amber Date: Thu, 25 Jan 2024 11:39:21 +0100 Subject: [PATCH 3/3] remove disableTests from template as consistent-callback-args will change test option --- .../react-library/files/src/testing/isConformant.ts__tmpl__ | 1 - 1 file changed, 1 deletion(-) diff --git a/tools/workspace-plugin/src/generators/react-library/files/src/testing/isConformant.ts__tmpl__ b/tools/workspace-plugin/src/generators/react-library/files/src/testing/isConformant.ts__tmpl__ index 1a4876276e2542..a3d988f29a1728 100644 --- a/tools/workspace-plugin/src/generators/react-library/files/src/testing/isConformant.ts__tmpl__ +++ b/tools/workspace-plugin/src/generators/react-library/files/src/testing/isConformant.ts__tmpl__ @@ -9,7 +9,6 @@ export function isConformant( tsConfig: { configName: 'tsconfig.spec.json' }, componentPath: require.main?.filename.replace('.test', ''), extraTests: griffelTests as TestObject, - disabledTests: ['consistent-callback-args'], }; baseIsConformant(defaultOptions, testInfo);