Use our own more simple vitest-axe extension

Signed-off-by: MTRNord <[email protected]>

Author: MTRNord

example-widget-mui/package.json

@@ -54,7 +54,6 @@
     ]
   },
   "devDependencies": {
-    "@chialab/vitest-axe": "^0.18.1",
     "@matrix-widget-toolkit/testing": "2.5.0",
     "@testing-library/dom": "^10.4.0",
     "@testing-library/jest-dom": "^6.5.0",

example-widget-mui/src/setupTests.ts

@@ -20,19 +20,41 @@
 // learn more: https://github.com/testing-library/jest-dom
 import '@testing-library/jest-dom/vitest';
 
-import vitestAxeMatchers from '@chialab/vitest-axe';
-import matchers from '@testing-library/jest-dom/matchers';
-import '@testing-library/jest-dom/vitest';
 import { TextDecoder, TextEncoder } from 'util';
 import { expect, vi } from 'vitest';
 
-expect.extend(matchers);
-
 // Make sure to initialize i18n (see mock below)
+import { AxeResults } from 'axe-core';
 import './i18n';
 
 // Add support for axe
-expect.extend(vitestAxeMatchers);
+expect.extend({
+  toHaveNoViolations(results: AxeResults) {
+    const violations = results.violations ?? [];
+
+    return {
+      pass: violations.length === 0,
+      actual: violations,
+      message() {
+        if (violations.length === 0) {
+          return '';
+        }
+
+        return `Expected no accessibility violations but received some.
+
+${violations
+  .map(
+    (violation) => `[${violation.impact}] ${violation.id}
+${violation.description}
+${violation.helpUrl}
+`,
+  )
+  .join('\n')}
+`;
+      },
+    };
+  },
+});
 
 // Use a different configuration for i18next during tests
 vi.mock('./i18n', async () => {

example-widget-mui/src/vitest.d.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 Nordeck IT + Consulting GmbH
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import 'vitest';
+
+interface AxeMatchers<R = unknown> {
+  toHaveNoViolations: () => R;
+}
+
+declare module 'vitest' {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  interface Assertion<T = any> extends AxeMatchers<T> {}
+  interface AsymmetricMatchersContaining extends AxeMatchers {}
+}

packages/mui/package.json

@@ -8,7 +8,6 @@
   "module": "./src/index.ts",
   "types": "./src/index.ts",
   "devDependencies": {
-    "@chialab/vitest-axe": "^0.18.1",
     "@testing-library/jest-dom": "^6.5.0",
     "@testing-library/react": "^16.0.1",
     "@testing-library/user-event": "^14.5.2",

packages/mui/src/setupTests.ts

@@ -21,8 +21,9 @@
 import '@testing-library/jest-dom/vitest';
 
 // Make sure to initialize i18n (see mock below)
-import vitestAxeMatchers from '@chialab/vitest-axe';
 import i18n from 'i18next';
+
+import { AxeResults } from 'axe-core';
 import { initReactI18next } from 'react-i18next';
 import { expect } from 'vitest';
 
@@ -35,4 +36,30 @@ i18n.use(initReactI18next).init({
 });
 
 // Add support for axe
-expect.extend(vitestAxeMatchers);
+expect.extend({
+  toHaveNoViolations(results: AxeResults) {
+    const violations = results.violations ?? [];
+
+    return {
+      pass: violations.length === 0,
+      actual: violations,
+      message() {
+        if (violations.length === 0) {
+          return '';
+        }
+
+        return `Expected no accessibility violations but received some.
+
+${violations
+  .map(
+    (violation) => `[${violation.impact}] ${violation.id}
+${violation.description}
+${violation.helpUrl}
+`,
+  )
+  .join('\n')}
+`;
+      },
+    };
+  },
+});

packages/mui/src/vitest.d.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 Nordeck IT + Consulting GmbH
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import 'vitest';
+
+interface AxeMatchers<R = unknown> {
+  toHaveNoViolations: () => R;
+}
+
+declare module 'vitest' {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  interface Assertion<T = any> extends AxeMatchers<T> {}
+  interface AsymmetricMatchersContaining extends AxeMatchers {}
+}

yarn.lock

@@ -326,11 +326,6 @@
     human-id "^1.0.2"
     prettier "^2.7.1"
 
-"@chialab/vitest-axe@^0.18.1":
-  version "0.18.1"
-  resolved "https://registry.yarnpkg.com/@chialab/vitest-axe/-/vitest-axe-0.18.1.tgz#4d6a3ae3628bc3222b4640295023445e0e530619"
-  integrity sha512-kdEwEdb6ill2i3Vjm/txJiWzBRES04HowNIzk9KUXy4VH35BXQpfdlNrb8p5c5vztZr0CFuUUyPhQVSBLjateg==
-
 "@emotion/babel-plugin@^11.12.0":
   version "11.12.0"
   resolved "https://registry.yarnpkg.com/@emotion/babel-plugin/-/babel-plugin-11.12.0.tgz#7b43debb250c313101b3f885eba634f1d723fcc2"
@@ -1567,7 +1562,7 @@
     semver "^7.6.0"
     ts-api-utils "^1.3.0"
 
-"@typescript-eslint/[email protected]", "@typescript-eslint/utils@^6.0.0 || ^7.0.0 || ^8.0.0":
+"@typescript-eslint/[email protected]":
   version "8.4.0"
   resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-8.4.0.tgz#35c552a404858c853a1f62ba6df2214f1988afc3"
   integrity sha512-swULW8n1IKLjRAgciCkTCafyTHHfwVQFt8DovmaF69sKbOxTSFMmIZaSHjqO9i/RV0wIblaawhzvtva8Nmm7lQ==
@@ -2905,13 +2900,6 @@ eslint-config-prettier@^9.1.0:
   resolved "https://registry.yarnpkg.com/eslint-config-prettier/-/eslint-config-prettier-9.1.0.tgz#31af3d94578645966c082fcb71a5846d3c94867f"
   integrity sha512-NSWl5BFQWEPi1j4TjVNItzYV7dZXZ+wP6I6ZhrBGpChQhZRUaElihE9uRRkcbRnNb76UMKDF3r+WTmNcGPKsqw==
 
-eslint-plugin-jest@^28.8.2:
-  version "28.8.3"
-  resolved "https://registry.yarnpkg.com/eslint-plugin-jest/-/eslint-plugin-jest-28.8.3.tgz#c5699bba0ad06090ad613535e4f1572f4c2567c0"
-  integrity sha512-HIQ3t9hASLKm2IhIOqnu+ifw7uLZkIlR7RYNv7fMcEi/p0CIiJmfriStQS2LDkgtY4nyLbIZAD+JL347Yc2ETQ==
-  dependencies:
-    "@typescript-eslint/utils" "^6.0.0 || ^7.0.0 || ^8.0.0"
-
 eslint-plugin-notice@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/eslint-plugin-notice/-/eslint-plugin-notice-1.0.0.tgz#4b98ffdf2274d10f34a4231a74efafdecad6cde4"