feat(plugin-axe): add plugin scaffolding

Author: hanna-skryl

packages/plugin-axe/eslint.config.js

@@ -0,0 +1,12 @@
+import tseslint from 'typescript-eslint';
+import baseConfig from '../../eslint.config.js';
+
+export default tseslint.config(...baseConfig, {
+  files: ['**/*.ts'],
+  languageOptions: {
+    parserOptions: {
+      projectService: true,
+      tsconfigRootDir: import.meta.dirname,
+    },
+  },
+});

packages/plugin-axe/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@code-pushup/axe-plugin",
+  "version": "0.84.0",
+  "license": "MIT",
+  "description": "Code PushUp plugin for detecting accessibility issues using Axe 🌐",
+  "homepage": "https://github.com/code-pushup/cli/tree/main/packages/plugin-axe#readme",
+  "bugs": {
+    "url": "https://github.com/code-pushup/cli/issues?q=is%3Aissue%20state%3Aopen%20type%3ABug%20label%3A%22🧩%20axe-plugin%22"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/code-pushup/cli.git",
+    "directory": "packages/plugin-axe"
+  },
+  "keywords": [
+    "CLI",
+    "Code PushUp",
+    "plugin",
+    "axe",
+    "axe-core",
+    "accessibility",
+    "a11y",
+    "WCAG",
+    "compliance",
+    "testing",
+    "quality",
+    "automation",
+    "runtime analysis",
+    "audit",
+    "score monitoring",
+    "developer tools",
+    "conformance",
+    "KPI tracking",
+    "tech debt",
+    "automated feedback",
+    "regression guard",
+    "actionable feedback"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "dependencies": {
+    "@axe-core/playwright": "^4.11.0",
+    "@code-pushup/models": "0.84.0",
+    "@code-pushup/utils": "0.84.0",
+    "axe-core": "^4.11.0",
+    "zod": "^4.1.12"
+  },
+  "peerDependencies": {
+    "playwright-core": "^1.56.1"
+  },
+  "files": [
+    "src",
+    "!**/*.tsbuildinfo"
+  ]
+}

packages/plugin-axe/project.json

@@ -0,0 +1,13 @@
+{
+  "name": "plugin-axe",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/plugin-axe/src",
+  "projectType": "library",
+  "tags": ["scope:plugin", "type:feature", "publishable"],
+  "// targets": "to see all targets run: nx show project plugin-axe --web",
+  "targets": {
+    "build": {},
+    "lint": {},
+    "unit-test": {}
+  }
+}

packages/plugin-axe/src/index.ts

@@ -0,0 +1 @@
+export * from './lib/axe-plugin.js';

packages/plugin-axe/src/lib/axe-plugin.ts

@@ -0,0 +1,3 @@
+export function axePlugin(): string {
+  return 'plugin-axe';
+}

packages/plugin-axe/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "ESNext",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "importHelpers": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "types": ["vitest"]
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.test.json"
+    }
+  ]
+}

packages/plugin-axe/tsconfig.lib.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["vitest.unit.config.ts", "src/**/*.test.ts"]
+}

packages/plugin-axe/tsconfig.test.json

@@ -0,0 +1,14 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "types": [
+      "vitest/globals",
+      "vitest/importMeta",
+      "vite/client",
+      "node",
+      "vitest"
+    ]
+  },
+  "include": ["vitest.unit.config.ts", "src/**/*.test.ts"]
+}

packages/plugin-axe/vitest.unit.config.ts

@@ -0,0 +1,29 @@
+/// <reference types="vitest" />
+import { defineConfig } from 'vitest/config';
+import { tsconfigPathAliases } from '../../tools/vitest-tsconfig-path-aliases.js';
+
+export default defineConfig({
+  cacheDir: '../../node_modules/.vite/plugin-axe',
+  test: {
+    reporters: ['basic'],
+    globals: true,
+    cache: {
+      dir: '../../node_modules/.vitest',
+    },
+    alias: tsconfigPathAliases(),
+    pool: 'threads',
+    poolOptions: { threads: { singleThread: true } },
+    coverage: {
+      reporter: ['text', 'lcov'],
+      reportsDirectory: '../../coverage/plugin-axe/unit-tests',
+      exclude: ['mocks/**', '**/types.ts'],
+    },
+    environment: 'node',
+    include: ['src/**/*.unit.test.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
+    globalSetup: ['../../global-setup.ts'],
+    setupFiles: [
+      '../../testing/test-setup/src/lib/console.mock.ts',
+      '../../testing/test-setup/src/lib/reset.mocks.ts',
+    ],
+  },
+});

tsconfig.base.json

@@ -20,6 +20,7 @@
     "allowSyntheticDefaultImports": true,
     "verbatimModuleSyntax": true,
     "paths": {
+      "@code-pushup/axe-plugin": ["packages/plugin-axe/src/index.ts"],
       "@code-pushup/ci": ["packages/ci/src/index.ts"],
       "@code-pushup/cli": ["packages/cli/src/index.ts"],
       "@code-pushup/core": ["packages/core/src/index.ts"],