+
Skip to content

AccessLint/actions

Repository files navigation

AccessLint - Accessibility Check

Get accessibility feedback directly in your pull requests. Automatically scans changed files and posts inline code review comments with specific guidance on fixing accessibility issues.

Key Benefits

  • 🎯 Inline code feedback - Get specific accessibility guidance directly on your code changes
  • 🚀 Zero setup - Uses GitHub OIDC authentication, no tokens or configuration required
  • Smart scanning - Only checks files that changed, not your entire codebase
  • 🔧 Multi-framework - Supports HTML, React/JSX, TypeScript, and Vue.js

Accessibility Coverage

49 automated accessibility rules across web technologies:

Coverage Areas

  • ARIA Implementation - Proper roles, properties, and state management
  • Keyboard & Focus - Tab navigation and focus management
  • Form Controls - Labels, naming, and associations
  • Media Content - Image alt text and media descriptions
  • Semantic Structure - Headings, landmarks, and document organization
  • Interactive Elements - Button naming and accessible interactions

Supported Technologies

  • HTML Documents - Static pages and markup validation
  • React/TypeScript - JSX accessibility patterns and component validation
  • Vue.js Applications - Vue-specific accessibility requirements

Quick Setup

Create .github/workflows/accesslint.yml in your repository:

name: 'AccessLint - Accessibility Check'

on:
  pull_request:
    types: [opened, synchronize, reopened]

permissions:
  contents: read
  pull-requests: write
  id-token: write

jobs:
  accesslint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - uses: accesslint/actions@v1.1.0
        with:
          mode: review
          file-patterns: '**/*.{html,htm,jsx,tsx,vue}' # Customize as needed

Configuration

Input Description Required Default
mode Action mode: review for PR comments Yes N/A
file-patterns Glob patterns for files to check No **/*.{html,htm,jsx,tsx,vue}
pr-number PR number (for manual workflow dispatch) No N/A

Troubleshooting

Action not running?

  • Verify mode: review is specified in your workflow
  • Ensure required permissions are set: contents: read, pull-requests: write, id-token: write

No files being checked?

  • Check that changed files match your file-patterns
  • Build artifacts (node_modules/, dist/) are automatically excluded

Authentication errors?

  • No setup required - the action uses GitHub OIDC automatically

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载