Skip to content

[JIRA DEVA11Y-179] Updated documentation #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Crash0v3rrid3 merged 4 commits into from
Jan 14, 2026
Merged

[JIRA DEVA11Y-179] Updated documentation #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a25d096
[JIRA DEVA11Y-179] Updated documentation
Crash0v3rrid3 Dec 18, 2025
7f0e6a9
Updated readme
Crash0v3rrid3 Jan 14, 2026
22211be
Added sandboxing documentation and reverted support proj types order
Crash0v3rrid3 Jan 14, 2026
d6bd599
Merge branch 'main' into DEVA11Y-179
Crash0v3rrid3 Jan 14, 2026
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
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,5 @@ Thumbs.db
typings/
yarn-debug.log*
yarn-error.log*
TestProject/
TestProject/
.sot
78 changes: 59 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# AccessibilityDevTools
A Swift Package Manager (SPM) command plugin 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 Swift codebase for accessibility issues using BrowserStack’s Accessibility DevTools rule engine.

AccessibilityDevTools enables static accessibility linting directly inside Xcode via SwiftPM, helping teams catch WCAG violations early—before UI tests, QA, or production.
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
Expand Down Expand Up @@ -51,21 +51,22 @@ Run the following command at the **root of your repository**

Zsh
```zsh
curl -L -o browserstack-a11y-scan-spm.sh "https://raw.githubusercontent.com/browserstack/AccessibilityDevTools/refs/heads/main/scripts/zsh/spm.sh" && chmod 0775 browserstack-a11y-scan-spm.sh
curl -L -o browserstack-a11y-scan-spm-zsh.sh "https://raw.githubusercontent.com/browserstack/AccessibilityDevTools/refs/heads/main/scripts/zsh/spm.sh" && chmod 0775 browserstack-a11y-scan-spm-zsh.sh
```

Bash
```bash
curl -L -o browserstack-a11y-scan-spm.sh "https://raw.githubusercontent.com/browserstack/AccessibilityDevTools/refs/heads/main/scripts/bash/spm.sh" && chmod 0775 browserstack-a11y-scan-spm.sh
curl -L -o browserstack-a11y-scan-spm-bash.sh "https://raw.githubusercontent.com/browserstack/AccessibilityDevTools/refs/heads/main/scripts/bash/spm.sh" && chmod 0775 browserstack-a11y-scan-spm-bash.sh
```

Fish
```fish
curl -L -o browserstack-a11y-scan-spm.sh "https://raw.githubusercontent.com/browserstack/AccessibilityDevTools/refs/heads/main/scripts/fish/spm.sh" && chmod 0775 browserstack-a11y-scan-spm.sh
```bash
curl -L -o browserstack-a11y-scan-spm-fish.sh "https://raw.githubusercontent.com/browserstack/AccessibilityDevTools/refs/heads/main/scripts/fish/spm.sh" && chmod 0775 browserstack-a11y-scan-spm-fish.sh
```

#### Disable Sandboxing
- In Xcode, select first item (project root) in the left folder tree and go to Build Settings tab
- Search for `sandbox` > Set `User script sandboxing` to “NO”
1. In Xcode project, select first item (project root) in the left folder tree and go to Build Settings tab
2. Search for sandbox > Set user script sandboxing to “NO”

#### Add a Build Phase
Repeat these steps for each target in your project
Expand All @@ -75,10 +76,23 @@ Repeat these steps for each target in your project
![Build Phase](./resources/build-phase.png "Build Phase")
3. Drag this newly created build phase above **Compile Sources** step
4. Delete any existing code in the newly created build step and add the following code
5. Add this script:
5. Add this script, depending upon the shell you picked earlier:

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

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

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

Xcode will now automatically run the accessibility scan during builds.

### 2. Projects created with Swift package manager
Expand Down Expand Up @@ -120,22 +134,22 @@ Run the following command at the **root of your repository**

Zsh
```zsh
curl -L -o browserstack-a11y-scan-spm.sh "https://raw.githubusercontent.com/browserstack/AccessibilityDevTools/refs/heads/main/scripts/zsh/spm.sh" && chmod 0775 browserstack-a11y-scan-spm.sh
curl -L -o browserstack-a11y-scan-spm-zsh.sh "https://raw.githubusercontent.com/browserstack/AccessibilityDevTools/refs/heads/main/scripts/zsh/spm.sh" && chmod 0775 browserstack-a11y-scan-spm-zsh.sh
```

Bash
```bash
curl -L -o browserstack-a11y-scan-spm.sh "https://raw.githubusercontent.com/browserstack/AccessibilityDevTools/refs/heads/main/scripts/bash/spm.sh" && chmod 0775 browserstack-a11y-scan-spm.sh
curl -L -o browserstack-a11y-scan-spm-bash.sh "https://raw.githubusercontent.com/browserstack/AccessibilityDevTools/refs/heads/main/scripts/bash/spm.sh" && chmod 0775 browserstack-a11y-scan-spm-bash.sh
```

Fish
```fish
curl -L -o browserstack-a11y-scan-spm.sh "https://raw.githubusercontent.com/browserstack/AccessibilityDevTools/refs/heads/main/scripts/fish/spm.sh" && chmod 0775 browserstack-a11y-scan-spm.sh
```bash
curl -L -o browserstack-a11y-scan-spm-fish.sh "https://raw.githubusercontent.com/browserstack/AccessibilityDevTools/refs/heads/main/scripts/fish/spm.sh" && chmod 0775 browserstack-a11y-scan-spm-fish.sh
```

#### Disable Sandboxing
- In Xcode, select first item (project root) in the left folder tree and go to Build Settings tab
- Search for `sandbox` > Set `User script sandboxing` to “NO”
1. In Xcode project, select first item (project root) in the left folder tree and go to Build Settings tab
2. Search for sandbox > Set user script sandboxing to “NO”

#### Add a Build Phase
Repeat these steps for each target in your project
Expand All @@ -145,10 +159,23 @@ Repeat these steps for each target in your project
![Build Phase](./resources/build-phase.png "Build Phase")
3. Drag this newly created build phase above **Compile Sources** step
4. Delete any existing code in the newly created build step and add the following code.
5. Add this script:
5. Add this script, depending upon the shell you picked earlier:

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

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

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

Xcode will now automatically run the accessibility scan during builds.

---
Expand All @@ -163,9 +190,22 @@ Press Cmd + B to build the project.
---
## Register pre-commit hook
You can run accessibility checks automatically before each commit by running the following command.

Zsh
```zsh
./browserstack-a11y-scan-spm-zsh.sh register-pre-commit-hook
```

Bash
```bash
./browserstack-a11y-scan-spm.sh register-pre-commit-hook
./browserstack-a11y-scan-spm-bash.sh register-pre-commit-hook
```

Fish
```bash
./browserstack-a11y-scan-spm-fish.sh register-pre-commit-hook
```

You can then edit the `.git/hooks/pre-commit` file to customise the registered pre-commit hook.

---
Expand Down