@code-pushup/axe-plugin 0.123.0 → 0.125.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/axe-plugin",
-  "version": "0.123.0",
+  "version": "0.125.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",
@@ -42,8 +42,8 @@
   "type": "module",
   "dependencies": {
     "@axe-core/playwright": "^4.11.0",
-    "@code-pushup/models": "0.123.0",
-    "@code-pushup/utils": "0.123.0",
+    "@code-pushup/models": "0.125.0",
+    "@code-pushup/utils": "0.125.0",
     "axe-core": "^4.11.0",
     "playwright-core": "^1.56.1",
     "zod": "^4.2.1"

package/src/index.d.ts

@@ -4,3 +4,4 @@ export type { AxePluginOptions, AxePreset } from './lib/config.js';
 export type { AxeGroupSlug } from './lib/groups.js';
 export { axeAuditRef, axeAuditRefs, axeGroupRef, axeGroupRefs, } from './lib/utils.js';
 export { axeCategories } from './lib/categories.js';
+export { axeSetupBinding } from './lib/binding.js';

package/src/index.js

@@ -2,4 +2,5 @@ import { axePlugin } from './lib/axe-plugin.js';
 export default axePlugin;
 export { axeAuditRef, axeAuditRefs, axeGroupRef, axeGroupRefs, } from './lib/utils.js';
 export { axeCategories } from './lib/categories.js';
+export { axeSetupBinding } from './lib/binding.js';
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD,eAAe,SAAS,CAAC;AAKzB,OAAO,EACL,WAAW,EACX,YAAY,EACZ,WAAW,EACX,YAAY,GACb,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD,eAAe,SAAS,CAAC;AAKzB,OAAO,EACL,WAAW,EACX,YAAY,EACZ,WAAW,EACX,YAAY,GACb,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC"}

package/src/lib/binding.d.ts

@@ -0,0 +1,56 @@
+import type { CategoryCodegenConfig, PluginAnswer, PluginSetupTree } from '@code-pushup/models';
+export declare const axeSetupBinding: {
+    slug: string;
+    title: string;
+    packageName: string;
+    prompts: () => Promise<({
+        key: string;
+        message: string;
+        type: "input";
+        default: string;
+        choices?: undefined;
+    } | {
+        key: string;
+        message: string;
+        type: "select";
+        choices: {
+            name: string;
+            value: string;
+        }[];
+        default: string;
+    } | {
+        key: string;
+        message: string;
+        type: "confirm";
+        default: false;
+        choices?: undefined;
+    } | {
+        key: string;
+        message: string;
+        type: "confirm";
+        default: true;
+        choices?: undefined;
+    })[]>;
+    generateConfig: (answers: Record<string, PluginAnswer>, tree: PluginSetupTree) => Promise<{
+        imports: {
+            namedImports?: string[] | undefined;
+            moduleSpecifier: string;
+            defaultImport: string;
+        }[];
+        pluginInit: string[];
+        pluginDeclaration?: undefined;
+        categories?: undefined;
+    } | {
+        imports: {
+            namedImports?: string[] | undefined;
+            moduleSpecifier: string;
+            defaultImport: string;
+        }[];
+        pluginDeclaration: {
+            identifier: string;
+            expression: string;
+        };
+        pluginInit: string[];
+        categories: CategoryCodegenConfig[];
+    }>;
+};

package/src/lib/binding.js

@@ -0,0 +1,110 @@
+import { createRequire } from 'node:module';
+import { answerBoolean, answerNonEmptyArray, answerString, singleQuote, } from '@code-pushup/utils';
+import { AXE_DEFAULT_PRESET, AXE_PLUGIN_SLUG, AXE_PLUGIN_TITLE, AXE_PRESET_NAMES, } from './constants.js';
+const { name: PACKAGE_NAME } = createRequire(import.meta.url)('../../package.json');
+const DEFAULT_URL = 'http://localhost:4200';
+const PLUGIN_VAR = 'axe';
+const SETUP_SCRIPT_PATH = './axe-setup.ts';
+const CATEGORIES = [
+    {
+        slug: 'a11y',
+        title: 'Accessibility',
+        description: 'Tests website **accessibility** in accordance with WCAG',
+        refsExpression: `axeGroupRefs(${PLUGIN_VAR})`,
+    },
+];
+const PRESET_CHOICES = Object.entries(AXE_PRESET_NAMES).map(([value, name]) => ({ name, value }));
+const SETUP_SCRIPT_CONTENT = `import type { Page } from 'playwright-core';
+
+export default async function (page: Page): Promise<void> {
+  // ... add your custom logic here ...
+}
+`;
+export const axeSetupBinding = {
+    slug: AXE_PLUGIN_SLUG,
+    title: AXE_PLUGIN_TITLE,
+    packageName: PACKAGE_NAME,
+    prompts: async () => [
+        {
+            key: 'axe.urls',
+            message: 'Target URL(s) (comma-separated)',
+            type: 'input',
+            default: DEFAULT_URL,
+        },
+        {
+            key: 'axe.preset',
+            message: 'Accessibility preset',
+            type: 'select',
+            choices: [...PRESET_CHOICES],
+            default: AXE_DEFAULT_PRESET,
+        },
+        {
+            key: 'axe.setupScript',
+            message: 'Create setup script for auth-protected app?',
+            type: 'confirm',
+            default: false,
+        },
+        {
+            key: 'axe.categories',
+            message: 'Add Axe categories?',
+            type: 'confirm',
+            default: true,
+        },
+    ],
+    generateConfig: async (answers, tree) => {
+        const options = parseAnswers(answers);
+        if (options.setupScript) {
+            await tree.write(SETUP_SCRIPT_PATH, SETUP_SCRIPT_CONTENT);
+        }
+        const hasCategories = options.categories;
+        const imports = [
+            {
+                moduleSpecifier: PACKAGE_NAME,
+                defaultImport: 'axePlugin',
+                ...(hasCategories ? { namedImports: ['axeGroupRefs'] } : {}),
+            },
+        ];
+        const pluginCall = formatPluginCall(options);
+        if (!hasCategories) {
+            return {
+                imports,
+                pluginInit: [`${pluginCall},`],
+            };
+        }
+        return {
+            imports,
+            pluginDeclaration: {
+                identifier: PLUGIN_VAR,
+                expression: pluginCall,
+            },
+            pluginInit: [`${PLUGIN_VAR},`],
+            categories: CATEGORIES,
+        };
+    },
+};
+function parseAnswers(answers) {
+    return {
+        urls: answerNonEmptyArray(answers, 'axe.urls', DEFAULT_URL),
+        preset: answerString(answers, 'axe.preset') || AXE_DEFAULT_PRESET,
+        setupScript: answerBoolean(answers, 'axe.setupScript'),
+        categories: answerBoolean(answers, 'axe.categories'),
+    };
+}
+function formatPluginCall({ urls, preset, setupScript }) {
+    const formattedUrls = formatUrls(urls);
+    const options = [
+        preset !== AXE_DEFAULT_PRESET && `preset: ${singleQuote(preset)}`,
+        setupScript && `setupScript: ${singleQuote(SETUP_SCRIPT_PATH)}`,
+    ].filter(Boolean);
+    if (options.length === 0) {
+        return `axePlugin(${formattedUrls})`;
+    }
+    return `axePlugin(${formattedUrls}, { ${options.join(', ')} })`;
+}
+function formatUrls([first, ...rest]) {
+    if (rest.length === 0) {
+        return singleQuote(first);
+    }
+    return `[${[first, ...rest].map(singleQuote).join(', ')}]`;
+}
+//# sourceMappingURL=binding.js.map

package/src/lib/binding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"binding.js","sourceRoot":"","sources":["../../../src/lib/binding.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAO5C,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,YAAY,EACZ,WAAW,GACZ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AAExB,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAC3D,oBAAoB,CACkB,CAAC;AAEzC,MAAM,WAAW,GAAG,uBAAuB,CAAC;AAC5C,MAAM,UAAU,GAAG,KAAK,CAAC;AACzB,MAAM,iBAAiB,GAAG,gBAAgB,CAAC;AAE3C,MAAM,UAAU,GAA4B;IAC1C;QACE,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,eAAe;QACtB,WAAW,EAAE,yDAAyD;QACtE,cAAc,EAAE,gBAAgB,UAAU,GAAG;KAC9C;CACF,CAAC;AAEF,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,GAAG,CACzD,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CACrC,CAAC;AAEF,MAAM,oBAAoB,GAAG;;;;;CAK5B,CAAC;AASF,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,IAAI,EAAE,eAAe;IACrB,KAAK,EAAE,gBAAgB;IACvB,WAAW,EAAE,YAAY;IACzB,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC;QACnB;YACE,GAAG,EAAE,UAAU;YACf,OAAO,EAAE,iCAAiC;YAC1C,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,WAAW;SACrB;QACD;YACE,GAAG,EAAE,YAAY;YACjB,OAAO,EAAE,sBAAsB;YAC/B,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,CAAC,GAAG,cAAc,CAAC;YAC5B,OAAO,EAAE,kBAAkB;SAC5B;QACD;YACE,GAAG,EAAE,iBAAiB;YACtB,OAAO,EAAE,6CAA6C;YACtD,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;SACf;QACD;YACE,GAAG,EAAE,gBAAgB;YACrB,OAAO,EAAE,qBAAqB;YAC9B,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;SACd;KACF;IACD,cAAc,EAAE,KAAK,EACnB,OAAqC,EACrC,IAAqB,EACrB,EAAE;QACF,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;QACtC,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACxB,MAAM,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,CAAC;QAC5D,CAAC;QACD,MAAM,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC;QACzC,MAAM,OAAO,GAAG;YACd;gBACE,eAAe,EAAE,YAAY;gBAC7B,aAAa,EAAE,WAAW;gBAC1B,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC7D;SACF,CAAC;QACF,MAAM,UAAU,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAE7C,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO;gBACL,OAAO;gBACP,UAAU,EAAE,CAAC,GAAG,UAAU,GAAG,CAAC;aAC/B,CAAC;QACJ,CAAC;QACD,OAAO;YACL,OAAO;YACP,iBAAiB,EAAE;gBACjB,UAAU,EAAE,UAAU;gBACtB,UAAU,EAAE,UAAU;aACvB;YACD,UAAU,EAAE,CAAC,GAAG,UAAU,GAAG,CAAC;YAC9B,UAAU,EAAE,UAAU;SACvB,CAAC;IACJ,CAAC;CAC2B,CAAC;AAE/B,SAAS,YAAY,CAAC,OAAqC;IACzD,OAAO;QACL,IAAI,EAAE,mBAAmB,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,CAAC;QAC3D,MAAM,EAAE,YAAY,CAAC,OAAO,EAAE,YAAY,CAAC,IAAI,kBAAkB;QACjE,WAAW,EAAE,aAAa,CAAC,OAAO,EAAE,iBAAiB,CAAC;QACtD,UAAU,EAAE,aAAa,CAAC,OAAO,EAAE,gBAAgB,CAAC;KACrD,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAc;IACjE,MAAM,aAAa,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,OAAO,GAAG;QACd,MAAM,KAAK,kBAAkB,IAAI,WAAW,WAAW,CAAC,MAAM,CAAC,EAAE;QACjE,WAAW,IAAI,gBAAgB,WAAW,CAAC,iBAAiB,CAAC,EAAE;KAChE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAElB,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,aAAa,aAAa,GAAG,CAAC;IACvC,CAAC;IACD,OAAO,aAAa,aAAa,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;AAClE,CAAC;AAED,SAAS,UAAU,CAAC,CAAC,KAAK,EAAE,GAAG,IAAI,CAAwB;IACzD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IACD,OAAO,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;AAC7D,CAAC"}