feat(rules): add new accessibility rule tests for various HTML elements and attributes

Author: PhilDaiguille

.github/release-drafter.yml

@@ -0,0 +1,58 @@
+name-template: 'v$RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+change-template: '- $TITLE (#$NUMBER) @$AUTHOR'
+template: |
+  ## Changes
+
+  $CHANGES
+
+version-resolver:
+  major:
+    labels:
+      - 'breaking'
+  minor:
+    labels:
+      - 'feature'
+      - 'enhancement'
+  patch:
+    labels:
+      - 'bug'
+      - 'fix'
+      - 'dependencies'
+  default: patch
+
+categories:
+  - title: 'Breaking Changes'
+    labels:
+      - 'breaking'
+  - title: 'Features'
+    labels:
+      - 'feature'
+      - 'enhancement'
+  - title: 'Bug Fixes'
+    labels:
+      - 'bug'
+      - 'fix'
+  - title: 'Maintenance'
+    labels:
+      - 'chore'
+      - 'dependencies'
+      - 'documentation'
+
+exclude-labels:
+  - 'skip-changelog'
+
+autolabeler:
+  - label: 'documentation'
+    files:
+      - '*.md'
+      - 'docs/**'
+  - label: 'tests'
+    files:
+      - 'tests/**'
+  - label: 'feature'
+    files:
+      - 'src/**'
+
+sort-by: 'merged_at'
+sort-direction: 'descending'

.github/workflows/release-drafter.yml

@@ -0,0 +1,29 @@
+name: Release Drafter
+
+on:
+    push:
+        branches:
+            - main
+    pull_request_target:
+        types:
+            - opened
+            - reopened
+            - synchronize
+            - labeled
+            - unlabeled
+
+permissions:
+    contents: write
+    pull-requests: write
+
+jobs:
+    update_release_draft:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Draft next release
+              uses: release-drafter/release-drafter@v6
+              with:
+                  config-name: release-drafter.yml
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,19 @@
+name: Release
+
+on:
+    push:
+        tags:
+            - 'v*'
+
+permissions:
+    contents: write
+
+jobs:
+    publish:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Create GitHub release
+              uses: softprops/action-gh-release@v2
+              with:
+                  generate_release_notes: true

README.md

@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TwigA11y\Rules\Anchor;
+
+use TwigA11y\Rules\AbstractA11yRule;
+use TwigCsFixer\Token\Token;
+use TwigCsFixer\Token\Tokens;
+
+final class LinkHrefValidityRule extends AbstractA11yRule
+{
+    public function evaluate(Tokens $tokens, int $tokenIndex, callable $emit): void
+    {
+        if ($this->shouldSkipByTokenIndex($tokenIndex)) {
+            return;
+        }
+
+        $token = $tokens->get($tokenIndex);
+        if (!$token->isMatching(Token::TEXT_TYPE)) {
+            return;
+        }
+
+        $value = $token->getValue();
+        if (!str_contains($value, '<a')) {
+            return;
+        }
+
+        $tag = $this->collectUntil($tokenIndex, $tokens, '>', 100);
+
+        if (!preg_match('/<a\b/i', $tag)) {
+            return;
+        }
+
+        if (preg_match('/\brole\s*=\s*["\']button["\']/i', $tag)) {
+            return;
+        }
+
+        if ($this->containsTwigExpressions($tag)) {
+            return;
+        }
+
+        if (!preg_match('/\bhref\s*=\s*(?:"([^"]*)"|\'([^\']*)\')/i', $tag, $hrefMatch)) {
+            $emit('Anchor elements should include a valid href attribute.', $token, 'LinkHref.MissingHref');
+
+            return;
+        }
+
+        $href = $this->firstMatch($hrefMatch, 1, 2);
+        $normalized = strtolower(trim($href));
+
+        if ('' === $normalized) {
+            $emit('Anchor elements should not use an empty href attribute.', $token, 'LinkHref.EmptyHref');
+
+            return;
+        }
+
+        if ('#' === $normalized || 'javascript:void(0)' === $normalized || 'javascript:void(0);' === $normalized) {
+            $emit('Anchor elements should use a real destination href instead of placeholder links.', $token, 'LinkHref.PlaceholderHref');
+        }
+    }
+}

phpunit.xml

@@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TwigA11y\Rules\Aria;
+
+use TwigA11y\Rules\AbstractA11yRule;
+use TwigCsFixer\Token\Token;
+use TwigCsFixer\Token\Tokens;
+
+final class AriaControlsIdExistsRule extends AbstractA11yRule
+{
+    public function evaluate(Tokens $tokens, int $tokenIndex, callable $emit): void
+    {
+        if ($this->shouldSkipByTokenIndex($tokenIndex)) {
+            return;
+        }
+
+        $full = $this->getFullContent($tokens);
+
+        if (!str_contains($full, 'aria-controls')) {
+            return;
+        }
+
+        $idCount = preg_match_all('/\bid\s*=\s*(?:"|\')([^"\']+)(?:"|\')/i', $full, $idMatches);
+        $ids = [];
+        if ($idCount > 0) {
+            $ids = array_flip($idMatches[1]);
+        }
+
+        if (!preg_match_all('/\baria-controls\s*=\s*(?:"([^"]+)"|\'([^\']+)\')/i', $full, $refs, PREG_OFFSET_CAPTURE)) {
+            return;
+        }
+
+        foreach ($refs[0] as $index => $match) {
+            $attr = $match[0];
+            $offset = $match[1];
+            $value = $refs[1][$index][0] ?: $refs[2][$index][0];
+            $pieces = preg_split('/\s+/', trim($value));
+
+            if (false === $pieces) {
+                $pieces = [];
+            }
+
+            foreach ($pieces as $refId) {
+                if ('' === $refId) {
+                    continue;
+                }
+
+                if (isset($ids[$refId])) {
+                    continue;
+                }
+
+                $line = 1 + substr_count(substr($full, 0, $offset), "\n");
+                $fakeToken = $this->fakeTokenForLine($tokens, $line, $attr);
+
+                $emit(sprintf('Referenced id "%s" in aria-controls does not exist in template.', $refId), $fakeToken, 'AriaControls.MissingId');
+
+                return;
+            }
+        }
+    }
+
+    protected function evaluateOncePerFile(): bool
+    {
+        return true;
+    }
+
+    private function fakeTokenForLine(Tokens $tokens, int $line, string $value): Token
+    {
+        $token = $tokens->get(0);
+
+        return new Token(
+            $token->getType(),
+            $line,
+            1,
+            $token->getFilename(),
+            $value
+        );
+    }
+}

roadmap.md

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TwigA11y\Rules\Forms;
+
+use TwigA11y\Rules\AbstractA11yRule;
+use TwigCsFixer\Token\Token;
+use TwigCsFixer\Token\Tokens;
+
+final class ButtonTypeRule extends AbstractA11yRule
+{
+    public function evaluate(Tokens $tokens, int $tokenIndex, callable $emit): void
+    {
+        $token = $tokens->get($tokenIndex);
+        if (!$token->isMatching(Token::TEXT_TYPE)) {
+            return;
+        }
+
+        $value = $token->getValue();
+        if (!str_contains($value, '<button')) {
+            return;
+        }
+
+        $tag = $this->collectUntil($tokenIndex, $tokens, '>', 100);
+
+        if (preg_match('/\btype\s*=\s*["\'](?:button|submit|reset)["\']/i', $tag)) {
+            return;
+        }
+
+        $emit('Button inside a form should declare an explicit type attribute.', $token, 'ButtonType.MissingType');
+    }
+}