Sobre Axe DevTools Linter
Visión general de Axe DevTools Linter y este sitio de documentación
¿Qué es el Linting?
El linting es el proceso automatizado de analizar el código fuente para encontrar problemas antes de ejecutarlo. Un linter es una herramienta que lee tu código y señala problemas, desde errores de sintaxis y errores tipográficos hasta inconsistencias estilísticas y posibles errores.
El término proviene de una herramienta Unix llamada lint, que originalmente verificaba programas C en busca de construcciones sospechosas. Hoy en día, existen linters para prácticamente todos los lenguajes de programación y sirven como una primera línea de defensa en la calidad del código.
Piensa en un linter como un corrector ortográfico para el código, excepto que en lugar de solo atrapar errores tipográficos, también detecta errores lógicos, aplica reglas de estilo y te advierte sobre patrones que probablemente causen errores.
¿Qué es un Linter de Accesibilidad?
Un linter de accesibilidad verifica potencialmente malas prácticas de accesibilidad, proporcionándote retroalimentación mientras desarrollas en lugar de después de que tu sitio web o aplicación esté construido y funcionando.
Lo que hace Axe DevTools Linter
Axe DevTools Linter realiza un análisis estático de tus archivos fuente. Lee tu código y lo verifica contra las reglas de Deque para identificar patrones que probablemente causen problemas de accesibilidad. Por ejemplo, puede detectar:
- Imágenes sin texto alternativo
- Entradas de formulario sin etiquetas
- Atributos ARIA incorrectos o faltantes
- Problemas en la estructura de encabezados
Debido a que analiza el código fuente en lugar de una aplicación en ejecución, Axe DevTools Linter puede detectar estos problemas temprano, antes de que el código se fusione, despliegue o incluso compile.
Lo que Axe DevTools Linter no puede hacer
Debido a que Axe DevTools Linter es una herramienta de análisis estático, no puede:
- Probar el comportamiento en tiempo de ejecución de tu aplicación, como el contenido cargado dinámicamente o los cambios en la interfaz de usuario impulsados por JavaScript.
- Detectar todos los problemas de accesibilidad; el análisis estático cubre un subconjunto de defectos detectables, y algunos problemas requieren pruebas basadas en navegador o revisión manual.
- Reemplazar las pruebas manuales de accesibilidad o herramientas basadas en navegador.
Tecnologías compatibles
Axe DevTools Linter puede verificar los siguientes tipos de archivos:
| Tecnología | Extensiones de archivo |
|---|---|
| React | .js, .jsx, .tsx |
| Vue | .vue |
| Angular | .component.html |
| HTML | .html, .htm, .xhtml |
| LiquidJS | .liquid |
| HTL (Adobe Experience Manager) | .htl |
| Markdown | .md, .markdown |
| React Native | Ver Axe DevTools Linter para React Native |
Formas de usar Axe DevTools Linter
Axe DevTools Linter se puede usar de varias formas dependiendo de tu flujo de trabajo:
Extensiones de IDE proporciona retroalimentación en tiempo real mientras escribes código. El extensión de VS Code (también disponible para IDEs compatibles con VS Code, como Cursor y Windsurf) y plugin de JetBrains (WebStorm e IntelliJ IDEA Ultimate) indican problemas de accesibilidad directamente en tu editor a medida que escribes.
El Conector es una herramienta de línea de comandos para linting de archivos en lotes, en scripts o como parte de un pipeline CI/CD. Ver Usar el Conector de Axe DevTools Linter.
La Acción de GitHub verifica los archivos que han cambiado en una solicitud de extracción e informa sobre problemas de accesibilidad. Ver La Acción de GitHub de Axe DevTools Linter.
Otras integraciones de CI/CD incluye Jenkins, SonarQube y ganchos de pre-commit de Git.
Dónde se Ejecuta el Análisis
Análisis local: La extensión de VS Code, el plugin de JetBrains y el Conector (con la opción --local) ejecutan un análisis de accesibilidad en tu propia máquina. El contenido de los archivos nunca sale de tu computadora.
Análisis basado en servidor: El Conector también puede enviar tus archivos a un servidor de Axe DevTools Linter para su análisis. Este es el enfoque utilizado por la acción de GitHub. Hay dos opciones de servidor:
- SaaS alojado por Deque: Servidor de nube de Deque. Requiere una clave API; no se necesita configuración del servidor.
- Local: Un servidor que ejecutas dentro de tu propia infraestructura. Ver Instalación y Seguridad.
Para obtener orientación sobre la elección entre linting local y basado en servidor con el Conector, ver Análisis Local.
Descripción General de la Documentación
Elegir la configuración adecuada de Axe DevTools Linter te ayuda a decidir qué modelo de implementación, integraciones y configuración se ajustan al flujo de trabajo de tu equipo.
Obtener una Clave API de SaaS de Axe DevTools Linter te muestra cómo obtener una clave para acceder al servicio de linting basado en la nube de Deque.
Reglas de Accesibilidad lista todas las reglas que verifica Axe DevTools Linter, con enlaces a información detallada en Deque University.
Configurar Axe DevTools Linter cubre las opciones de configuración disponibles en la extensión de VS Code, el plugin de JetBrains, el Conector de Axe DevTools Linter y el endpoint de la API REST /lint-source.
Instalación y Seguridad contiene artículos sobre la instalación del servidor en las instalaciones y cómo protegerlo con NGINX como proxy inverso.
Usar Axe DevTools Linter cubre las diversas integraciones: el plugin de JetBrains, extensión de VS Code, CLI del Conector, GitHub Action, hook pre-commit, Jenkins y SonarQube.
Linting de Componentes Personalizados discute el soporte de Axe DevTools Linter para componentes personalizados, con guías para usuarios de VS Code y JetBrains y usuarios de terminales REST, además de un artículo sobre bibliotecas de componentes preconfiguradas.
Desarrollo con las API REST describe cómo acceder a Axe DevTools Linter programáticamente utilizando su interfaz REST.
Créditos proporciona información sobre atribuciones y licencias para el software de terceros utilizado por Axe DevTools Linter.
Note: It is never necessary to use Deque's software or services in a way that collects, stores, or shares personal data. Do not use the software or services in a manner that collects, stores, or shares personal data.