Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# AccessibilityDevTools
A Swift Package Manager (SPM) command plugin and CLI tool that scans your iOS Swift codebase for accessibility issues using BrowserStack’s Accessibility DevTools rule engine.
A Swift Package Manager (SPM) command plugin and CLI tool that scans your iOS codebase for accessibility issues using BrowserStack’s Accessibility DevTools rule engine.

AccessibilityDevTools enables static accessibility linting directly inside Xcode, via SwiftPM, or using the standalone BrowserStack CLI, helping teams catch WCAG violations early—before UI tests, QA, or production.

---
## 🚀 Key Capabilities
* 🔍 **Automatic static accessibility linting** for SwiftUI
* 🔍 **Automatic static accessibility linting** for SwiftUI and UIKit
* 🛠 **10+ WCAG-aligned rules** from the Spectra rule engine
* 🛠 **Inline errors inside Xcode** with remediation guidance
* ⚡ **Runs during build** using the SPM command plugin
* 📂 **Broad File Support**: Analyzes .swift, .xib, and .storyboard files

---
## Supported projects types
Expand Down Expand Up @@ -80,17 +81,17 @@ Repeat these steps for each target in your project

Zsh
```zsh
./browserstack-a11y-scan-spm-zsh.sh --include **/*.swift --non-strict
./browserstack-a11y-scan-spm-zsh.sh --include "**/*.swift" --include "**/*.xib" --include "**/*.storyboard"
```

Bash
```bash
./browserstack-a11y-scan-spm-bash.sh --include **/*.swift --non-strict
./browserstack-a11y-scan-spm-bash.sh --include "**/*.swift" --include "**/*.xib" --include "**/*.storyboard"
```

Fish
```bash
./browserstack-a11y-scan-spm-fish.sh --include **/*.swift --non-strict
./browserstack-a11y-scan-spm-fish.sh --include "**/*.swift" --include "**/*.xib" --include "**/*.storyboard"
```

Xcode will now automatically run the accessibility scan during builds.
Expand Down Expand Up @@ -163,17 +164,17 @@ Repeat these steps for each target in your project

Zsh
```zsh
./browserstack-a11y-scan-spm-zsh.sh --include **/*.swift --non-strict
./browserstack-a11y-scan-spm-zsh.sh --include "**/*.swift" --include "**/*.xib" --include "**/*.storyboard"
```

Bash
```bash
./browserstack-a11y-scan-spm-bash.sh --include **/*.swift --non-strict
./browserstack-a11y-scan-spm-bash.sh --include "**/*.swift" --include "**/*.xib" --include "**/*.storyboard"
```

Fish
```bash
./browserstack-a11y-scan-spm-fish.sh --include **/*.swift --non-strict
./browserstack-a11y-scan-spm-fish.sh --include "**/*.swift" --include "**/*.xib" --include "**/*.storyboard"
```

Xcode will now automatically run the accessibility scan during builds.
Expand Down
2 changes: 1 addition & 1 deletion scripts/bash/cli.sh
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ EOF

a11y_scan() {
if [[ -z "$EXTRA_ARGS" ]]; then
EXTRA_ARGS="--include **/*.swift"
EXTRA_ARGS="--include **/*.swift --include **/*.xib --include **/*.storyboard"
fi
env -i HOME="$HOME" \
XCODE_VERSION_ACTUAL="$XCODE_VERSION_ACTUAL"\
Expand Down
2 changes: 1 addition & 1 deletion scripts/bash/spm.sh
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ EOF

setup
if [[ -z "$EXTRA_ARGS" ]]; then
EXTRA_ARGS="--include **/*.swift"
EXTRA_ARGS="--include **/*.swift --include **/*.xib --include **/*.storyboard"
fi
env -i HOME="$HOME" \
XCODE_VERSION_ACTUAL="$XCODE_VERSION_ACTUAL"\
Expand Down
2 changes: 1 addition & 1 deletion scripts/fish/cli.sh
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ EOF

a11y_scan() {
if [[ -z "$EXTRA_ARGS" ]]; then
EXTRA_ARGS="--include **/*.swift"
EXTRA_ARGS="--include **/*.swift --include **/*.xib --include **/*.storyboard"
fi
env -i HOME="$HOME" \
XCODE_VERSION_ACTUAL="$XCODE_VERSION_ACTUAL"\
Expand Down
2 changes: 1 addition & 1 deletion scripts/fish/spm.sh
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ EOF

setup
if [[ -z "$EXTRA_ARGS" ]]; then
EXTRA_ARGS="--include **/*.swift"
EXTRA_ARGS="--include **/*.swift --include **/*.xib --include **/*.storyboard"
fi
env -i HOME="$HOME" \
XCODE_VERSION_ACTUAL="$XCODE_VERSION_ACTUAL"\
Expand Down
2 changes: 1 addition & 1 deletion scripts/zsh/cli.sh
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ EOF

a11y_scan() {
if [[ -z "$EXTRA_ARGS" ]]; then
EXTRA_ARGS="--include **/*.swift"
EXTRA_ARGS="--include **/*.swift --include **/*.xib --include **/*.storyboard"
fi
env -i HOME="$HOME" \
XCODE_VERSION_ACTUAL="$XCODE_VERSION_ACTUAL"\
Expand Down
2 changes: 1 addition & 1 deletion scripts/zsh/spm.sh
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ EOF

setup
if [[ -z "$EXTRA_ARGS" ]]; then
EXTRA_ARGS="--include **/*.swift"
EXTRA_ARGS="--include **/*.swift --include **/*.xib --include **/*.storyboard"
fi
env -i HOME="$HOME" \
XCODE_VERSION_ACTUAL="$XCODE_VERSION_ACTUAL"\
Expand Down
Loading