Acerca de axe DevTools Linter
Descripción general de axe DevTools Linter y este sitio de documentación
Axe DevTools Linter le permite revisar su código para detectar problemas de accesibilidad (de manera similar a cómo un linter de código verifica si hay problemas de codificación). Es fácil de configurar y utilizar. Puede verificar archivos React (.js, .jsx y .tsx), Vue (.vue), Angular (.component.html, tenga en cuenta que actualmente no se admite la verificación de plantillas Angular en línea), HTML (.html, .htm y .xhtml) y Markdown (.md y .markdown) para que pueda evitar defectos de accesibilidad comunes.
Ediciones de Linter
Hay dos ediciones de axe DevTools Linter:
- El primero, axe DevTools Linter Software as a Service (SaaS), es un servicio basado en la nube proporcionado por Deque. En esta documentación se lo denomina axe DevTools Linter SaaS cuando es necesario distinguirlo de la otra edición de axe DevTools Linter.
- El segundo, axe DevTools Linter On-Premises Server , es un servidor que puede instalar en una máquina Linux para proporcionar servicios de análisis de accesibilidad en su organización. No requiere autenticación, por lo que solo es adecuado para su uso detrás de un firewall.
Linting local
La herramienta de línea de comandos axe DevTools Connector admite el linting local, que realiza linting de sus archivos localmente sin enviar el contenido del archivo a un servidor. Puede encontrar más información sobre el uso del linting local en la sección Linting local del artículo Conector Linter de axe DevTools.
Descripción general de la documentación
En esta sección de la documentación encontrará lo siguiente:
Cómo obtener una clave API de axe DevTools Linter SaaS le muestra cómo obtener una clave que le permita acceder a axe DevTools Linter SaaS basado en la nube de Deque.
Si utiliza la versión de software como servicio, axe DevTools Linter SaaS, no tendrá que configurar un servidor y podrá comenzar a utilizar los servicios de axe DevTools Linter inmediatamente. Solo necesita una clave API para comenzar a utilizar sus servicios.
La descarga del conector axe DevTools Linter le brinda información sobre cómo obtener el conector axe DevTools Linter, que se describe en la documentación del conector axe DevTools Linter.
Reglas de accesibilidad enumera todas las reglas que axe DevTools Linter verifica cuando analiza su código en busca de problemas de accesibilidad. Cada regla está vinculada a más detalles en Deque University.
Configuración de axe DevTools Linter proporciona las opciones de configuración que entiende la extensión VS Code, el complemento JetBrains o el punto final de la API REST /lint-source.
Las secciones siguientes incluyen:
Instalación y seguridad contiene artículos que le indican cómo instalar el servidor local y cifrar su tráfico utilizando NGINX como proxy inverso.
Uso de axe DevTools Linter muestra varias formas en las que puede usar axe DevTools Linter para verificar el código con las reglas de accesibilidad de Deque y cómo integrarlo con Jenkins, un gancho previo a la confirmación de GitHub, una acción de GitHub y SonarQube. En esta sección también se incluye una discusión del complemento JetBrains y de la extensión VS Code .
Linting de componentes personalizados analiza las características de axe DevTools Linter para el linting de componentes personalizados. Hay dos tutoriales en esta sección. El primero es para usuarios de la extensión VS Code o del complemento JetBrains, y el segundo es para usuarios del servicio de linting REST. También hay un artículo que describe el soporte para bibliotecas de componentes preconfiguradas.
Desarrollo con las API REST describe cómo acceder a axe DevTools Linter programáticamente utilizando su interfaz REST.
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.