@rgaa-checker/eslint-plugin-rgaa 0.1.0

package/README.md

@@ -0,0 +1,65 @@
+# @rgaa-checker/eslint-plugin-rgaa
+
+Règles ESLint d'accessibilité **mappées au RGAA 4.1.2**, en couche au-dessus de
+[`eslint-plugin-jsx-a11y`](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y).
+Chaque règle indique le critère RGAA visé et renvoie vers sa fiche.
+
+> **Lint partiel, pas une preuve de conformité.** Un linter statique ne couvre
+> qu'une fraction du RGAA. D'après la méthodologie d'axe-core, **~60 % des
+> critères WCAG restent à vérifier manuellement**. Ce plugin aide à corriger tôt
+> les erreurs détectables dans le code source ; pour le reste, lancez un
+> [scan complet RGAA Checker](https://rgaa-checker.com?utm_source=eslint).
+
+## Installation
+
+```bash
+npm install -D @rgaa-checker/eslint-plugin-rgaa eslint-plugin-jsx-a11y eslint
+```
+
+## Usage (ESLint 9, flat config)
+
+Le plugin suppose un **parseur compatible JSX déjà configuré** dans votre projet
+(Next.js, `typescript-eslint`, etc.). Ajoutez la config recommandée à la suite
+de votre configuration existante :
+
+```js
+// eslint.config.js
+import rgaa from '@rgaa-checker/eslint-plugin-rgaa';
+
+export default [
+  // ...votre config qui établit le parseur JSX/TS (Next.js, typescript-eslint)...
+  ...rgaa.configs.recommended,
+];
+```
+
+`rgaa.configs.recommended` active les checks de `jsx-a11y` **et** les règles RGAA
+ci-dessous.
+
+Pour n'activer que les règles RGAA (sans `jsx-a11y`) :
+
+```js
+import rgaa from '@rgaa-checker/eslint-plugin-rgaa';
+
+export default [
+  {
+    plugins: { rgaa },
+    rules: {
+      'rgaa/img-alt': 'error',
+      'rgaa/no-noninteractive-onclick': 'error',
+    },
+  },
+];
+```
+
+## Règles
+
+| Règle | Critère RGAA | Description |
+|-------|--------------|-------------|
+| `rgaa/img-alt` | 1.1 | Les images doivent avoir une alternative textuelle (`alt`). |
+| `rgaa/no-noninteractive-onclick` | 7.1 | Une action au clic doit être sur un `<button>` (ou `<a>` pour naviguer), pas un élément statique. |
+
+D'autres critères seront ajoutés progressivement.
+
+## Licence
+
+MPL-2.0

package/dist/criteria.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Canonical RGAA fiche URL for a criterion, with acquisition attribution.
+ * The fiche route is /guide/<criterion> (cf. criteria-catalog primaryGuide).
+ */
+export declare const FICHE_BASE = "https://rgaa-checker.com/guide";
+export declare function ficheUrl(criterion: string): string;
+//# sourceMappingURL=criteria.d.ts.map

package/dist/criteria.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"criteria.d.ts","sourceRoot":"","sources":["../src/criteria.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,UAAU,mCAAmC,CAAC;AAE3D,wBAAgB,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAElD"}

package/dist/criteria.js

@@ -0,0 +1,9 @@
+/**
+ * Canonical RGAA fiche URL for a criterion, with acquisition attribution.
+ * The fiche route is /guide/<criterion> (cf. criteria-catalog primaryGuide).
+ */
+export const FICHE_BASE = 'https://rgaa-checker.com/guide';
+export function ficheUrl(criterion) {
+    return `${FICHE_BASE}/${criterion}?utm_source=eslint`;
+}
+//# sourceMappingURL=criteria.js.map

package/dist/criteria.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"criteria.js","sourceRoot":"","sources":["../src/criteria.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,gCAAgC,CAAC;AAE3D,MAAM,UAAU,QAAQ,CAAC,SAAiB;IACtC,OAAO,GAAG,UAAU,IAAI,SAAS,oBAAoB,CAAC;AAC1D,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+declare const plugin: {
+    meta: {
+        name: string;
+        version: string;
+    };
+    rules: {
+        'img-alt': import("eslint").Rule.RuleModule;
+        'no-noninteractive-onclick': import("eslint").Rule.RuleModule;
+    };
+    configs: Record<string, unknown>;
+};
+export default plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,QAAA,MAAM,MAAM;;;;;;;;;aAMO,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CACzC,CAAC;AAgBF,eAAe,MAAM,CAAC"}

package/dist/index.js

@@ -0,0 +1,26 @@
+import jsxA11y from 'eslint-plugin-jsx-a11y';
+import imgAlt from './rules/img-alt.js';
+import noNoninteractiveOnclick from './rules/no-noninteractive-onclick.js';
+const plugin = {
+    meta: { name: '@rgaa-checker/eslint-plugin-rgaa', version: '0.1.0' },
+    rules: {
+        'img-alt': imgAlt,
+        'no-noninteractive-onclick': noNoninteractiveOnclick,
+    },
+    configs: {},
+};
+// Flat config (ESLint 9): compose jsx-a11y's recommended config with our RGAA
+// rules. Element 1 brings the jsx-a11y checks; element 2 registers the `rgaa`
+// plugin and enables our rules.
+plugin.configs.recommended = [
+    jsxA11y.flatConfigs.recommended,
+    {
+        plugins: { rgaa: plugin },
+        rules: {
+            'rgaa/img-alt': 'error',
+            'rgaa/no-noninteractive-onclick': 'error',
+        },
+    },
+];
+export default plugin;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,wBAAwB,CAAC;AAC7C,OAAO,MAAM,MAAM,oBAAoB,CAAC;AACxC,OAAO,uBAAuB,MAAM,sCAAsC,CAAC;AAE3E,MAAM,MAAM,GAAG;IACX,IAAI,EAAE,EAAE,IAAI,EAAE,kCAAkC,EAAE,OAAO,EAAE,OAAO,EAAE;IACpE,KAAK,EAAE;QACH,SAAS,EAAE,MAAM;QACjB,2BAA2B,EAAE,uBAAuB;KACvD;IACD,OAAO,EAAE,EAA6B;CACzC,CAAC;AAEF,8EAA8E;AAC9E,8EAA8E;AAC9E,gCAAgC;AAChC,MAAM,CAAC,OAAO,CAAC,WAAW,GAAG;IACzB,OAAO,CAAC,WAAW,CAAC,WAAW;IAC/B;QACI,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;QACzB,KAAK,EAAE;YACH,cAAc,EAAE,OAAO;YACvB,gCAAgC,EAAE,OAAO;SAC5C;KACJ;CACJ,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/dist/jsx-ast.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Minimal shape of the JSX AST nodes our rules inspect.
+ *
+ * ESLint's estree types do not include JSX nodes, so rule visitors would
+ * otherwise fall back to `any`. This local interface gives us just enough
+ * type-safety for the attributes/name fields we read, without `any`.
+ */
+export interface JsxOpeningElement {
+    name?: {
+        type?: string;
+        name?: string;
+    };
+    attributes: Array<{
+        type: string;
+        name?: {
+            name?: string;
+        };
+    }>;
+}
+//# sourceMappingURL=jsx-ast.d.ts.map

package/dist/jsx-ast.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsx-ast.d.ts","sourceRoot":"","sources":["../src/jsx-ast.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAC9B,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACxC,UAAU,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC,CAAC;CACjE"}

package/dist/jsx-ast.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=jsx-ast.js.map

package/dist/jsx-ast.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsx-ast.js","sourceRoot":"","sources":["../src/jsx-ast.ts"],"names":[],"mappings":""}

package/dist/rules/img-alt.d.ts

@@ -0,0 +1,4 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;
+//# sourceMappingURL=img-alt.d.ts.map

package/dist/rules/img-alt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"img-alt.d.ts","sourceRoot":"","sources":["../../src/rules/img-alt.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAMnC,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAuChB,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/rules/img-alt.js

@@ -0,0 +1,43 @@
+import { ficheUrl } from '../criteria.js';
+const CRITERION = '1.1';
+const rule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Les images doivent avoir une alternative textuelle (attribut alt). RGAA 1.1.',
+            url: ficheUrl(CRITERION),
+        },
+        schema: [],
+        messages: {
+            missingAlt: "Image sans alternative textuelle : ajoutez un attribut alt (alt=\"\" si l'image est décorative). (RGAA 1.1, lint partiel — voir la fiche)",
+        },
+    },
+    create(context) {
+        return {
+            JSXOpeningElement(node) {
+                if (node.name?.type !== 'JSXIdentifier' || node.name.name !== 'img') {
+                    return;
+                }
+                let hasAlt = false;
+                let hasSpread = false;
+                for (const attr of node.attributes) {
+                    if (attr.type === 'JSXSpreadAttribute') {
+                        hasSpread = true;
+                        continue;
+                    }
+                    if (attr.type === 'JSXAttribute' && attr.name?.name === 'alt') {
+                        hasAlt = true;
+                    }
+                }
+                // A spread (e.g. {...props}) may carry alt — don't flag, avoid false positives.
+                if (hasSpread)
+                    return;
+                if (!hasAlt) {
+                    context.report({ node: node, messageId: 'missingAlt' });
+                }
+            },
+        };
+    },
+};
+export default rule;
+//# sourceMappingURL=img-alt.js.map

package/dist/rules/img-alt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"img-alt.js","sourceRoot":"","sources":["../../src/rules/img-alt.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C,MAAM,SAAS,GAAG,KAAK,CAAC;AAExB,MAAM,IAAI,GAAoB;IAC1B,IAAI,EAAE;QACF,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACF,WAAW,EACP,8EAA8E;YAClF,GAAG,EAAE,QAAQ,CAAC,SAAS,CAAC;SAC3B;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACN,UAAU,EACN,2IAA2I;SAClJ;KACJ;IACD,MAAM,CAAC,OAAO;QACV,OAAO;YACH,iBAAiB,CAAC,IAAuB;gBACrC,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,KAAK,eAAe,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;oBAClE,OAAO;gBACX,CAAC;gBACD,IAAI,MAAM,GAAG,KAAK,CAAC;gBACnB,IAAI,SAAS,GAAG,KAAK,CAAC;gBACtB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;oBACjC,IAAI,IAAI,CAAC,IAAI,KAAK,oBAAoB,EAAE,CAAC;wBACrC,SAAS,GAAG,IAAI,CAAC;wBACjB,SAAS;oBACb,CAAC;oBACD,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,KAAK,KAAK,EAAE,CAAC;wBAC5D,MAAM,GAAG,IAAI,CAAC;oBAClB,CAAC;gBACL,CAAC;gBACD,gFAAgF;gBAChF,IAAI,SAAS;oBAAE,OAAO;gBACtB,IAAI,CAAC,MAAM,EAAE,CAAC;oBACV,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAA4B,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,CAAC;gBACpF,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;CACJ,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/rules/no-noninteractive-onclick.d.ts

@@ -0,0 +1,4 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;
+//# sourceMappingURL=no-noninteractive-onclick.d.ts.map

package/dist/rules/no-noninteractive-onclick.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-noninteractive-onclick.d.ts","sourceRoot":"","sources":["../../src/rules/no-noninteractive-onclick.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAiBnC,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAsChB,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/rules/no-noninteractive-onclick.js

@@ -0,0 +1,55 @@
+import { ficheUrl } from '../criteria.js';
+const CRITERION = '7.1';
+// Native HTML elements that are already interactive — onClick is legitimate.
+const INTERACTIVE = new Set([
+    'button',
+    'a',
+    'input',
+    'select',
+    'textarea',
+    'option',
+    'summary',
+]);
+const rule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: "Une action au clic doit être portée par un élément interactif (button pour agir, a pour naviguer), pas un élément statique. RGAA 7.1.",
+            url: ficheUrl(CRITERION),
+        },
+        schema: [],
+        messages: {
+            noninteractive: 'Action au clic sur un élément non interactif : utilisez <button> pour une action (ou <a> pour naviguer). (RGAA 7.1, lint partiel — voir la fiche)',
+        },
+    },
+    create(context) {
+        return {
+            JSXOpeningElement(node) {
+                const name = node.name;
+                if (name?.type !== 'JSXIdentifier')
+                    return;
+                const tag = name.name;
+                // Skip missing names, components (Capitalized) and natively-interactive tags.
+                if (!tag || !/^[a-z]/.test(tag) || INTERACTIVE.has(tag))
+                    return;
+                let hasOnClick = false;
+                let hasRole = false;
+                for (const attr of node.attributes) {
+                    if (attr.type !== 'JSXAttribute')
+                        continue;
+                    const an = attr.name?.name;
+                    if (an === 'onClick')
+                        hasOnClick = true;
+                    if (an === 'role')
+                        hasRole = true;
+                }
+                // A role (e.g. role="button") signals an intentional ARIA widget — don't flag here.
+                if (hasOnClick && !hasRole) {
+                    context.report({ node: node, messageId: 'noninteractive' });
+                }
+            },
+        };
+    },
+};
+export default rule;
+//# sourceMappingURL=no-noninteractive-onclick.js.map

package/dist/rules/no-noninteractive-onclick.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-noninteractive-onclick.js","sourceRoot":"","sources":["../../src/rules/no-noninteractive-onclick.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C,MAAM,SAAS,GAAG,KAAK,CAAC;AAExB,6EAA6E;AAC7E,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC;IACxB,QAAQ;IACR,GAAG;IACH,OAAO;IACP,QAAQ;IACR,UAAU;IACV,QAAQ;IACR,SAAS;CACZ,CAAC,CAAC;AAEH,MAAM,IAAI,GAAoB;IAC1B,IAAI,EAAE;QACF,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACF,WAAW,EACP,uIAAuI;YAC3I,GAAG,EAAE,QAAQ,CAAC,SAAS,CAAC;SAC3B;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACN,cAAc,EACV,mJAAmJ;SAC1J;KACJ;IACD,MAAM,CAAC,OAAO;QACV,OAAO;YACH,iBAAiB,CAAC,IAAuB;gBACrC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;gBACvB,IAAI,IAAI,EAAE,IAAI,KAAK,eAAe;oBAAE,OAAO;gBAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;gBACtB,8EAA8E;gBAC9E,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC;oBAAE,OAAO;gBAEhE,IAAI,UAAU,GAAG,KAAK,CAAC;gBACvB,IAAI,OAAO,GAAG,KAAK,CAAC;gBACpB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;oBACjC,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc;wBAAE,SAAS;oBAC3C,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC;oBAC3B,IAAI,EAAE,KAAK,SAAS;wBAAE,UAAU,GAAG,IAAI,CAAC;oBACxC,IAAI,EAAE,KAAK,MAAM;wBAAE,OAAO,GAAG,IAAI,CAAC;gBACtC,CAAC;gBACD,oFAAoF;gBACpF,IAAI,UAAU,IAAI,CAAC,OAAO,EAAE,CAAC;oBACzB,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAA4B,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC,CAAC;gBACxF,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;CACJ,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@rgaa-checker/eslint-plugin-rgaa",
+  "version": "0.1.0",
+  "description": "Règles ESLint d'accessibilité mappées au RGAA 4.1.2, par-dessus eslint-plugin-jsx-a11y.",
+  "license": "MPL-2.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": ["dist", "README.md"],
+  "keywords": ["eslint", "eslintplugin", "eslint-plugin", "accessibility", "a11y", "rgaa", "jsx-a11y"],
+  "homepage": "https://rgaa-checker.com",
+  "repository": { "type": "git", "url": "https://github.com/rgaa-checker/devtools.git" },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run"
+  },
+  "peerDependencies": {
+    "eslint": ">=9",
+    "eslint-plugin-jsx-a11y": ">=6.10"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "eslint": "^9.39.4",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "typescript": "^5.0.0",
+    "vitest": "^2.1.9"
+  },
+  "engines": { "node": ">=18.0.0" }
+}