npm - ai-ccesibility - Versions diffs - 0.1.0 - Mend

ai-ccesibility 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/EXAMPLES.md ADDED Viewed

@@ -0,0 +1,595 @@
+# Ejemplos de Uso - AI-ccesibility
+Ejemplos concretos de inputs y outputs para cada herramienta MCP.
+## Tabla de Contenidos
+- [analyze-with-axe](#analyze-with-axe)
+- [analyze-with-pa11y](#analyze-with-pa11y)
+- [analyze-with-eslint](#analyze-with-eslint)
+- [analyze-all](#analyze-all)
+---
+## analyze-with-axe
+### Ejemplo 1: Análisis básico de URL
+**Input:**
+```json
+{
+  "url": "https://example.com"
+}
+```
+**Output:**
+```json
+{
+  "success": true,
+  "target": "https://example.com",
+  "issueCount": 5,
+  "issues": [
+    {
+      "id": "axe-core:image-alt:a3f8b9",
+      "ruleId": "image-alt",
+      "tool": "axe-core",
+      "severity": "critical",
+      "wcag": {
+        "criterion": "1.1.1",
+        "level": "A",
+        "principle": "perceivable"
+      },
+      "location": {
+        "selector": "img:nth-child(2)",
+        "snippet": "<img src=\"logo.png\">"
+      },
+      "message": "Images must have alternate text",
+      "humanContext": "**Contenido no textual (WCAG 1.1.1 - Nivel A)**\n\nTodo contenido no textual debe tener una alternativa de texto...",
+      "suggestedActions": [
+        "Añadir atributo alt descriptivo a imágenes",
+        "Usar aria-label para iconos decorativos con función",
+        "Marcar imágenes decorativas con alt=\"\" vacío"
+      ],
+      "affectedUsers": ["screen-reader", "low-vision"],
+      "priority": "critical",
+      "remediationEffort": "low",
+      "confidence": 1
+    }
+  ],
+  "summary": {
+    "total": 5,
+    "bySeverity": {
+      "critical": 1,
+      "serious": 2,
+      "moderate": 2,
+      "minor": 0
+    },
+    "byPrinciple": {
+      "perceivable": 3,
+      "operable": 2,
+      "understandable": 0,
+      "robust": 0
+    }
+  },
+  "duration": 2340
+}
+```
+---
+### Ejemplo 2: Análisis de HTML raw
+**Input:**
+```json
+{
+  "html": "<html><body><form><input type=\"text\" placeholder=\"Email\"><button>Submit</button></form></body></html>",
+  "options": {
+    "wcagLevel": "AA"
+  }
+}
+```
+**Output:**
+```json
+{
+  "success": true,
+  "target": "[html content]",
+  "issueCount": 2,
+  "issues": [
+    {
+      "id": "axe-core:label:f3a9b2",
+      "ruleId": "label",
+      "tool": "axe-core",
+      "severity": "serious",
+      "wcag": {
+        "criterion": "1.3.1",
+        "level": "A",
+        "principle": "perceivable"
+      },
+      "location": {
+        "selector": "input[type=\"text\"]",
+        "snippet": "<input type=\"text\" placeholder=\"Email\">"
+      },
+      "message": "Form elements must have labels",
+      "humanContext": "**Información y relaciones (WCAG 1.3.1 - Nivel A)**...",
+      "suggestedActions": [
+        "Asociar labels con inputs correctamente",
+        "Usar aria-label si label visible no es posible"
+      ],
+      "affectedUsers": ["screen-reader", "cognitive"],
+      "priority": "high",
+      "remediationEffort": "low"
+    }
+  ],
+  "duration": 180
+}
+```
+---
+### Ejemplo 3: Con opciones avanzadas
+**Input:**
+```json
+{
+  "url": "https://spa-app.com",
+  "options": {
+    "wcagLevel": "AA",
+    "includeIncomplete": false,
+    "browser": {
+      "waitForSelector": "#app-loaded",
+      "waitForTimeout": 3000,
+      "viewport": {
+        "width": 1280,
+        "height": 720
+      }
+    }
+  }
+}
+```
+---
+## analyze-with-pa11y
+### Ejemplo 1: Análisis con standard específico
+**Input:**
+```json
+{
+  "url": "https://example.com",
+  "options": {
+    "standard": "WCAG21AA",
+    "includeWarnings": true,
+    "includeNotices": false
+  }
+}
+```
+**Output:**
+```json
+{
+  "success": true,
+  "target": "https://example.com",
+  "issueCount": 3,
+  "issues": [
+    {
+      "id": "pa11y:WCAG2AA.Principle1.Guideline1_1.1_1_1.H37:8f3a2b",
+      "ruleId": "WCAG2AA.Principle1.Guideline1_1.1_1_1.H37",
+      "tool": "pa11y",
+      "severity": "serious",
+      "wcag": {
+        "criterion": "1.1.1",
+        "level": "AA",
+        "principle": "perceivable",
+        "version": "2.1"
+      },
+      "location": {
+        "selector": "html > body > img:nth-child(3)",
+        "snippet": "<img src=\"banner.jpg\">"
+      },
+      "message": "Img element missing an alt attribute. Use the alt attribute to specify a short text alternative.",
+      "humanContext": "**Contenido no textual (WCAG 1.1.1 - Nivel A)**...",
+      "affectedUsers": ["screen-reader", "low-vision"],
+      "priority": "critical",
+      "remediationEffort": "low",
+      "confidence": 1
+    }
+  ],
+  "summary": {
+    "total": 3,
+    "bySeverity": {
+      "critical": 0,
+      "serious": 2,
+      "moderate": 1,
+      "minor": 0
+    }
+  },
+  "metadata": {
+    "toolVersion": "9.0.1",
+    "pageTitle": "Example Domain"
+  },
+  "duration": 1890
+}
+```
+---
+## analyze-with-eslint
+### Ejemplo 1: Análisis de archivo Vue
+**Input:**
+```json
+{
+  "files": ["src/components/LoginForm.vue"]
+}
+```
+**Output:**
+```json
+{
+  "success": true,
+  "target": "src/components/LoginForm.vue",
+  "issueCount": 4,
+  "issues": [
+    {
+      "id": "eslint-vuejs-a11y:vuejs-accessibility/click-events-have-key-events:src/components/LoginForm.vue:42:15:f8a3c2",
+      "ruleId": "vuejs-accessibility/click-events-have-key-events",
+      "tool": "eslint-vuejs-a11y",
+      "severity": "serious",
+      "wcag": {
+        "criterion": "2.1.1",
+        "level": "A",
+        "principle": "operable",
+        "version": "2.1"
+      },
+      "location": {
+        "file": "src/components/LoginForm.vue",
+        "line": 42,
+        "column": 15,
+        "snippet": "<div @click=\"togglePassword\">"
+      },
+      "message": "Elements with click handlers must have corresponding key event handlers.",
+      "humanContext": "**Teclado (WCAG 2.1.1 - Nivel A)**\n\nToda funcionalidad debe ser operable mediante teclado...",
+      "suggestedActions": [
+        "Añadir manejadores de eventos de teclado (onKeyDown, onKeyPress)",
+        "Usar elementos interactivos nativos (button, a, input)"
+      ],
+      "affectedUsers": ["keyboard-only", "motor-impaired", "screen-reader"],
+      "priority": "critical",
+      "remediationEffort": "medium",
+      "confidence": 1
+    },
+    {
+      "id": "eslint-vuejs-a11y:vuejs-accessibility/form-control-has-label:src/components/LoginForm.vue:28:10:b9f2a1",
+      "ruleId": "vuejs-accessibility/form-control-has-label",
+      "tool": "eslint-vuejs-a11y",
+      "severity": "serious",
+      "wcag": {
+        "criterion": "1.3.1",
+        "level": "A",
+        "principle": "perceivable",
+        "version": "2.1"
+      },
+      "location": {
+        "file": "src/components/LoginForm.vue",
+        "line": 28,
+        "column": 10
+      },
+      "message": "A form control must have a label.",
+      "humanContext": "**Información y relaciones (WCAG 1.3.1 - Nivel A)**...",
+      "affectedUsers": ["screen-reader", "cognitive"],
+      "priority": "high",
+      "remediationEffort": "low"
+    }
+  ],
+  "summary": {
+    "total": 4,
+    "bySeverity": {
+      "critical": 0,
+      "serious": 4,
+      "moderate": 0,
+      "minor": 0
+    },
+    "byRule": {
+      "vuejs-accessibility/click-events-have-key-events": 2,
+      "vuejs-accessibility/form-control-has-label": 2
+    }
+  },
+  "duration": 450
+}
+```
+---
+### Ejemplo 2: Análisis de código inline
+**Input:**
+```json
+{
+  "code": "<template>\n  <div>\n    <img src=\"avatar.jpg\" />\n    <div @click=\"handleClick\">Click me</div>\n  </div>\n</template>\n\n<script>\nexport default {\n  methods: {\n    handleClick() {\n      console.log('clicked');\n    }\n  }\n};\n</script>"
+}
+```
+**Output:**
+```json
+{
+  "success": true,
+  "target": "inline.vue",
+  "issueCount": 2,
+  "issues": [
+    {
+      "ruleId": "vuejs-accessibility/alt-text",
+      "message": "img elements must have an alt prop...",
+      "location": {
+        "file": "inline.vue",
+        "line": 3,
+        "column": 5
+      }
+    },
+    {
+      "ruleId": "vuejs-accessibility/no-static-element-interactions",
+      "message": "Static HTML elements with event handlers require a role...",
+      "location": {
+        "file": "inline.vue",
+        "line": 4,
+        "column": 5
+      }
+    }
+  ]
+}
+```
+---
+## analyze-all
+### Ejemplo 1: Análisis combinado básico
+**Input:**
+```json
+{
+  "url": "https://example.com",
+  "tools": ["axe-core", "pa11y"],
+  "options": {
+    "wcagLevel": "AA",
+    "deduplicateResults": true
+  }
+}
+```
+**Output:**
+```json
+{
+  "success": true,
+  "target": "https://example.com",
+  "toolsUsed": ["axe-core", "pa11y"],
+  "issueCount": 8,
+  "deduplicatedCount": 12,
+  "issues": [
+    {
+      "id": "axe-core:image-alt:a3f8b9",
+      "ruleId": "image-alt",
+      "tool": "axe-core",
+      "severity": "critical",
+      "message": "Images must have alternate text",
+      "humanContext": "**Contenido no textual (WCAG 1.1.1 - Nivel A)**...",
+      "affectedUsers": ["screen-reader", "low-vision"],
+      "priority": "critical",
+      "remediationEffort": "low"
+    }
+  ],
+  "issuesByWCAG": {
+    "1.1.1": [
+      {
+        "tool": "axe-core",
+        "ruleId": "image-alt"
+      },
+      {
+        "tool": "axe-core",
+        "ruleId": "input-image-alt"
+      }
+    ],
+    "1.3.1": [
+      {
+        "tool": "pa11y",
+        "ruleId": "WCAG2AA.Principle1.Guideline1_3..."
+      }
+    ],
+    "2.1.1": [
+      {
+        "tool": "axe-core",
+        "ruleId": "button-name"
+      }
+    ]
+  },
+  "summary": {
+    "total": 8,
+    "bySeverity": {
+      "critical": 2,
+      "serious": 4,
+      "moderate": 2,
+      "minor": 0
+    },
+    "byPrinciple": {
+      "perceivable": 5,
+      "operable": 3,
+      "understandable": 0,
+      "robust": 0
+    },
+    "byTool": {
+      "axe-core": 5,
+      "pa11y": 3
+    }
+  },
+  "individualResults": [
+    {
+      "tool": "axe-core",
+      "success": true,
+      "issues": [],
+      "duration": 2340
+    },
+    {
+      "tool": "pa11y",
+      "success": true,
+      "issues": [],
+      "duration": 1890
+    }
+  ],
+  "duration": 2500
+}
+```
+---
+### Ejemplo 2: Sin deduplicación
+**Input:**
+```json
+{
+  "url": "https://example.com",
+  "tools": ["axe-core", "pa11y"],
+  "options": {
+    "deduplicateResults": false
+  }
+}
+```
+**Output:**
+```json
+{
+  "issueCount": 12,
+  "deduplicatedCount": 12,
+  "issues": [
+    {
+      "tool": "axe-core",
+      "ruleId": "image-alt",
+      "location": { "selector": "img:nth-child(2)" }
+    },
+    {
+      "tool": "pa11y",
+      "ruleId": "WCAG2AA.Principle1.Guideline1_1.1_1_1.H37",
+      "location": { "selector": "html > body > img:nth-child(2)" }
+    }
+  ]
+}
+```
+**Nota:** Ambos detectaron la misma imagen sin `alt`, pero con diferentes selectores.
+---
+### Ejemplo 3: Con viewport móvil
+**Input:**
+```json
+{
+  "url": "https://responsive-site.com",
+  "tools": ["axe-core", "pa11y"],
+  "options": {
+    "wcagLevel": "AA",
+    "browser": {
+      "viewport": {
+        "width": 375,
+        "height": 667
+      }
+    }
+  }
+}
+```
+---
+## Comparación de Outputs por Herramienta
+### Mismo Issue detectado por diferentes tools
+**Axe-core:**
+```json
+{
+  "tool": "axe-core",
+  "ruleId": "image-alt",
+  "severity": "critical",
+  "location": {
+    "selector": "img:nth-child(2)"
+  },
+  "message": "Images must have alternate text"
+}
+```
+**Pa11y:**
+```json
+{
+  "tool": "pa11y",
+  "ruleId": "WCAG2AA.Principle1.Guideline1_1.1_1_1.H37",
+  "severity": "serious",
+  "location": {
+    "selector": "html > body > img:nth-child(2)"
+  },
+  "message": "Img element missing an alt attribute..."
+}
+```
+**ESLint (en código Vue):**
+```json
+{
+  "tool": "eslint-vuejs-a11y",
+  "ruleId": "vuejs-accessibility/alt-text",
+  "severity": "serious",
+  "location": {
+    "file": "src/components/Avatar.vue",
+    "line": 12,
+    "column": 8
+  },
+  "message": "img elements must have an alt prop..."
+}
+```
+---
+## Resumen de Diferencias
+| Característica | axe-core | Pa11y | ESLint |
+|----------------|----------|-------|--------|
+| **Target** | URL/HTML | URL/HTML | Archivos .vue |
+| **Selector** | CSS compacto | CSS completo | Línea/columna |
+| **Severidades** | 4 niveles | 3 tipos | 2 niveles (warn/error) |
+| **Snippet** | ✅ | ✅ | ✅ |
+| **Confidence** | ✅ | ✅ | Siempre 1 |
+| **Browser** | Puppeteer | Puppeteer | - |
+| **Velocidad** | ~2-3s | ~2s | <1s |
+| **Falsos positivos** | Pocos | Moderados | Muy pocos |
+---
+## Tips para Interpretar Resultados
+### 1. Priorizar por Matriz
+```
+Critical + Low effort = Fix HOY
+Critical + Medium/High effort = Planificar sprint
+High + Low effort = Quick wins
+Medium/Low + High effort = Backlog
+```
+### 2. Validar Duplicados
+Si `deduplicatedCount` > `issueCount`, revisa `individualResults` para ver qué herramienta es más confiable para ese tipo de issue.
+### 3. Revisar `affectedUsers`
+Prioriza issues que afecten a usuarios de screen readers y keyboard-only (más comunes).
+### 4. Aprovechar `humanContext`
+Lee los ejemplos del mundo real para entender el impacto real en usuarios.
+---
+## Next Steps
+- Ver [USAGE.md](./USAGE.md) para workflows completos
+- Ver [README.md](./README.md) para configuración
+- Ver `src/data/README.md` para añadir más criterios WCAG

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2026 Diego Razquin
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.