feat(plugin-axe): add plugin setup

Author: hanna-skryl

code-pushup.config.ts

@@ -1,5 +1,6 @@
 import 'dotenv/config';
 import {
+  axeCoreConfig,
   coverageCoreConfigNx,
   eslintCoreConfigNx,
   jsDocsCoreConfig,
@@ -43,4 +44,7 @@ export default mergeConfigs(
     '!**/implementation/**',
     '!**/internal/**',
   ]),
+  axeCoreConfig(
+    'https://github.com/code-pushup/cli?tab=readme-ov-file#code-pushup-cli/',
+  ),
 );

code-pushup.preset.ts

@@ -4,6 +4,7 @@ import type {
   CoreConfig,
   PluginUrls,
 } from './packages/models/src/index.js';
+import axePlugin from './packages/plugin-axe/src/index.js';
 import coveragePlugin, {
   getNxCoveragePaths,
 } from './packages/plugin-coverage/src/index.js';
@@ -216,3 +217,7 @@ export const coverageCoreConfigNx = async (
     categories: coverageCategories,
   };
 };
+
+export const axeCoreConfig = (urls: PluginUrls): CoreConfig => ({
+  plugins: [axePlugin(urls)],
+});

nx.json

@@ -306,6 +306,27 @@
         }
       }
     },
+    "code-pushup-axe": {
+      "cache": true,
+      "inputs": ["default", "code-pushup-inputs"],
+      "outputs": ["{projectRoot}/.code-pushup/axe/runner-output.json"],
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "node packages/cli/src/index.ts collect",
+        "args": [
+          "--no-progress",
+          "--verbose",
+          "--config={projectRoot}/code-pushup.config.ts",
+          "--cache.write",
+          "--onlyPlugins=axe",
+          "--persist.outputDir={projectRoot}/.code-pushup"
+        ],
+        "env": {
+          "NODE_OPTIONS": "--import tsx",
+          "TSX_TSCONFIG_PATH": "tsconfig.base.json"
+        }
+      }
+    },
     "nx-release-publish": {
       "dependsOn": ["build"],
       "executor": "@nx/js:release-publish",

package-lock.json

@@ -19,6 +19,7 @@
   },
   "private": true,
   "dependencies": {
+    "@axe-core/playwright": "^4.11.0",
     "@code-pushup/portal-client": "^0.16.0",
     "@isaacs/cliui": "^8.0.2",
     "@nx/devkit": "21.4.1",
@@ -36,6 +37,7 @@
     "nx": "21.4.1",
     "ora": "^9.0.0",
     "parse-lcov": "^1.0.4",
+    "playwright-core": "^1.56.1",
     "rimraf": "^6.0.1",
     "semver": "^7.6.3",
     "simple-git": "^3.26.0",

package.json

@@ -1,3 +1,5 @@
 import { axePlugin } from './lib/axe-plugin.js';
 
 export default axePlugin;
+export type { AxePluginOptions } from './lib/config.js';
+export type { AxePreset } from './lib/constants.js';

packages/plugin-axe/src/index.ts

@@ -26,6 +26,7 @@
     },
     "code-pushup-jsdocs": {},
     "code-pushup-typescript": {},
+    "code-pushup-axe": {},
     "code-pushup": {
       "dependsOn": ["code-pushup-*"],
       "executor": "nx:run-commands",