Accessibility Tester AI 🧪♿

AI-powered accessibility testing for WCAG 2.1 compliance in VS Code

✨ Key Features

🔍 Automated WCAG Testing - Comprehensive Level A/AA/AAA compliance checks
🤖 AI-Powered Analysis - Smart issue detection and fix suggestions
📋 Manual Checks Guide - Interactive accessibility testing workflow
📊 VPAT Reports - Generate Voluntary Product Accessibility Templates
⚡ Fast CLI Testing - Command-line interface for CI/CD pipelines
📸 Visual Issue Tracking - Screenshot-based problem identification
🎯 Multi-Provider AI - OpenAI, Azure OpenAI, Google Gemini support

🚀 Perfect For

Web Developers building accessible websites
QA Testers conducting accessibility audits
Compliance Teams preparing VPAT documentation
Designers ensuring inclusive user experiences
Organizations meeting WCAG standards

⚠️ Preview Version Notice

This is a PREVIEW version of the Testers.AI IDE extension.

What "Preview" Means

Early Access: This extension is in active development and may have incomplete features or functionality
Potential Instability: You may encounter bugs, performance issues, or unexpected behavior
Frequent Updates: Features and APIs may change between versions without notice
Not Production-Ready: This version is intended for testing and feedback purposes

What to Expect

Features may be added, removed, or modified in future releases
Some functionality may not work as expected
Documentation may be incomplete or outdated
Performance optimizations are ongoing

Feedback

If you encounter issues or have suggestions, please report them through the appropriate channels. Your feedback helps improve the extension!

Stable Release

A stable, production-ready version will be released in the future. The preview version uses pre-release versioning (e.g., 0.1.1-preview) to distinguish it from stable releases.

Quick Start - Command Line Usage

The extension supports full command-line execution that automatically launches and runs tests. This is the fastest way to get started.

Single Command Installation & Execution

Run one of these scripts to automatically check for VS Code, install it if needed, build and install the extension, and run a test:

macOS/Linux:

./install-and-run.sh --url https://example.com --json-output ./results --image-output ./screenshots

Windows:

install-and-run.bat --url https://example.com --json-output ./results --image-output ./screenshots

Manual Command Line Usage

Once the extension is installed, you can run tests directly:

Method 1: Using Wrapper Scripts (Recommended)

macOS/Linux:

./testers-ai-cli.sh --url https://example.com --json-output ./results --image-output ./screenshots

Windows:

testers-ai-cli.bat --url https://example.com --json-output ./results --image-output ./screenshots

Method 2: Direct VS Code Command

code --command testersAi.runTestCLI

With environment variables:

export TESTERS_AI_URLS="https://example.com"
export TESTERS_AI_JSON_OUTPUT="./results"
export TESTERS_AI_IMAGE_OUTPUT="./screenshots"
code --command testersAi.runTestCLI

Method 3: Inline Environment Variables

TESTERS_AI_URLS=https://example.com TESTERS_AI_JSON_OUTPUT=./results code --command testersAi.runTestCLI

Command-Line Options

--url <url> - URL to test (can be specified multiple times for multiple URLs)
--instructions <text> - Instructions for the test
--json-output <dir> - Directory to save JSON results
--image-output <dir> - Directory to save PNG screenshots
--acr-output <dir> - Directory to save ACR (Accessibility Conformance Report)
--help or -h - Show help message

Environment Variables

TESTERS_AI_URLS - Comma-separated list of URLs to test
TESTERS_AI_INSTRUCTIONS - Instructions for the test
TESTERS_AI_JSON_OUTPUT - Directory for JSON output
TESTERS_AI_IMAGE_OUTPUT - Directory for PNG output
TESTERS_AI_ACR_OUTPUT - Directory for ACR report output

Examples

Test a single URL:

./testers-ai-cli.sh --url https://example.com --json-output ./results --image-output ./screenshots

Test multiple URLs:

./testers-ai-cli.sh --url https://example.com --url https://example2.com --instructions "Check accessibility"

Test with custom instructions:

./testers-ai-cli.sh \
  --url https://example.com \
  --instructions "Focus on mobile responsiveness and accessibility" \
  --json-output ./test-results \
  --image-output ./screenshots

Test with ACR report generation:

./testers-ai-cli.sh \
  --url https://example.com \
  --instructions "Check accessibility compliance" \
  --acr-output ./acr-reports

Output Files

JSON Output:

Contains complete test results including metadata, artifacts, and analysis
Filename format: {url_slug}_{timestamp}.json

Image Output:

Full-page screenshot of the tested page
Filename format: {url_slug}_{timestamp}.png

ACR Report Output:

Accessibility Conformance Report (ACR) in HTML format
Automatically generated after test completion when --acr-output is specified
Requires API key to be configured in VS Code settings
Filename format: acr-report-{runId}-{timestamp}.html

Features

Command-Line Interface: Run tests directly from terminal without opening VS Code UI
Automated Testing: Automatically captures screenshots, network traffic, console logs, and performance metrics
Accessibility Checks: Built-in accessibility auditing with ARIA, contrast, keyboard navigation, and more
Branded Panel: Displays Testers.AI branding information
Configurable: Customize branding through configuration files
Multiple URL Support: Test multiple URLs in a single run
Programmatic Output: Save results as JSON and PNG files

Installation

Automated Installation (Recommended)

Use the installation scripts that handle everything automatically:

macOS/Linux:

chmod +x install-and-run.sh
./install-and-run.sh

Windows:

install-and-run.bat

Manual Installation

Prerequisites:
- Node.js (v16 or higher)
- Visual Studio Code (or the installation script will install it)
Install dependencies:
```
npm install
```
Compile TypeScript:
```
npm run compile
```

Build VSIX package:

npm install -g @vscode/vsce
npx @vscode/vsce package

Install extension:

code --install-extension testers-ai-ide-0.0.1.vsix

Configuration

Edit configs/default-config.json to customize the branding:

{
  "title": "Testers Panel",
  "logoUri": "https://testers.ai/img/t_logo.png",
  "logoAlt": "Testers Logo",
  "brandText": "testers.ai",
  "subtitle": "Build Faster",
  "jasonUri": "...",
  "brand_prompt": ""
}

Extension Settings

Configure the extension in VS Code settings:

testersAi.enterpriseAccount - Enterprise account name (format: BRANDNAME_ANYSTRING_THREEDIGITS, e.g., eggplant_test_777)
testersAi.azureEndpoint - Azure OpenAI endpoint URL
testersAi.azureDeployment - Azure OpenAI deployment name (default: gpt-4o)
testersAi.azureApiVersion - Azure OpenAI API version (default: 2024-10-01)

Development

Install dependencies:
```
npm install
```
Compile TypeScript:
```
npm run compile
```
Watch mode (auto-compile on changes):
```
npm run watch
```
Press F5 to launch the extension in a new Extension Development Host window

Building

Standard Build

npm run compile

The compiled JavaScript will be in the out directory.

Build VSIX Package

npm install -g @vscode/vsce
npx @vscode/vsce package

Build Matrix (Enterprise Configurations)

npm run build:matrix

This builds VSIX files for all enterprise + coverage combinations. Output is saved to vsix-builds/ directory.

Troubleshooting

Command not found

Make sure VS Code is in your PATH. Verify by running:

code --version

If not found, add VS Code to your PATH:

macOS: Add VS Code to PATH via Command Palette: Shell Command: Install 'code' command in PATH
Linux: Usually installed automatically, or add to PATH manually
Windows: Usually installed automatically, or add C:\Program Files\Microsoft VS Code\bin to PATH

Extension not activated

The extension activates automatically when VS Code starts. If you encounter issues:

Open VS Code
Run: code --command testersAi.showPanel (to ensure extension is loaded)
Then run the CLI command

No output files

Check that output directories are writable
Verify paths are correct (use absolute paths if relative paths don't work)
Check VS Code's Output channel ("Testers.AI CLI") for error messages

VS Code installation issues

If the installation script cannot install VS Code automatically:

macOS: Install via Homebrew: brew install --cask visual-studio-code
Linux: Install via package manager (apt, yum, etc.) or download from code.visualstudio.com
Windows: Download installer from code.visualstudio.com

Additional Documentation

CLI.md - Detailed CLI usage guide
ACCESSIBILITY_TESTS.md - Accessibility testing documentation
COVERAGE_GAPS.md - Coverage gap analysis
VPAT.md - Voluntary Product Accessibility Template (WCAG/Section 508 compliance)

Accessibility Tester AI - WCAG Compliance & Testing

Testers.AI

Accessibility Tester AI 🧪♿

✨ Key Features

🚀 Perfect For

⚠️ Preview Version Notice

What "Preview" Means

What to Expect

Feedback

Stable Release

Quick Start - Command Line Usage

Single Command Installation & Execution

Manual Command Line Usage

Method 1: Using Wrapper Scripts (Recommended)

Method 2: Direct VS Code Command

Method 3: Inline Environment Variables

Command-Line Options

Environment Variables

Examples

Output Files

Features

Installation

Automated Installation (Recommended)

Manual Installation

Configuration

Extension Settings

Development

Building

Standard Build

Build VSIX Package

Build Matrix (Enterprise Configurations)

Troubleshooting

Command not found

Extension not activated

No output files

VS Code installation issues

Additional Documentation