diff --git a/README.md b/README.md index 45d53c3..1d74d62 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. @@ -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. diff --git a/scripts/bash/cli.sh b/scripts/bash/cli.sh index d8698aa..d39f524 100644 --- a/scripts/bash/cli.sh +++ b/scripts/bash/cli.sh @@ -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"\ diff --git a/scripts/bash/spm.sh b/scripts/bash/spm.sh index 5c7cdbf..1202e11 100644 --- a/scripts/bash/spm.sh +++ b/scripts/bash/spm.sh @@ -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"\ diff --git a/scripts/fish/cli.sh b/scripts/fish/cli.sh index 8594d9d..6bf3d8b 100644 --- a/scripts/fish/cli.sh +++ b/scripts/fish/cli.sh @@ -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"\ diff --git a/scripts/fish/spm.sh b/scripts/fish/spm.sh index 17b3801..9ac8a67 100644 --- a/scripts/fish/spm.sh +++ b/scripts/fish/spm.sh @@ -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"\ diff --git a/scripts/zsh/cli.sh b/scripts/zsh/cli.sh index 72870da..697ad4e 100644 --- a/scripts/zsh/cli.sh +++ b/scripts/zsh/cli.sh @@ -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"\ diff --git a/scripts/zsh/spm.sh b/scripts/zsh/spm.sh index a16b6c8..35df10f 100644 --- a/scripts/zsh/spm.sh +++ b/scripts/zsh/spm.sh @@ -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"\