@mcptoolshop/a11y-ci 0.2.0 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -35
- package/package.json +35 -35
- package/bin/a11y-ci.js +0 -26
- package/postinstall.js +0 -11
package/README.md
CHANGED
|
@@ -1,35 +1,47 @@
|
|
|
1
|
-
# @
|
|
2
|
-
|
|
3
|
-
npm
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
a11y-ci
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
- **
|
|
31
|
-
- **
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
1
|
+
# @mcptoolshop/a11y-ci
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@mcptoolshop/a11y-ci)
|
|
4
|
+
[](https://github.com/mcp-tool-shop-org/accessibility-suite/blob/main/LICENSE)
|
|
5
|
+
|
|
6
|
+
**npm wrapper for [a11y-ci](https://github.com/mcp-tool-shop-org/accessibility-suite/tree/main/src/a11y-ci) — CI gate for accessibility scorecards.**
|
|
7
|
+
|
|
8
|
+
## Install
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm install @mcptoolshop/a11y-ci
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
This package provides a CLI wrapper that installs and delegates to the Python `a11y-ci` tool from the [accessibility-suite](https://github.com/mcp-tool-shop-org/accessibility-suite) monorepo.
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npx @mcptoolshop/a11y-ci --help
|
|
20
|
+
npx @mcptoolshop/a11y-ci scan ./my-site
|
|
21
|
+
npx @mcptoolshop/a11y-ci report --format json
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## What is a11y-ci?
|
|
25
|
+
|
|
26
|
+
a11y-ci is a CI/CD integration for accessibility checks. It runs WCAG compliance scans and generates scorecards that can be used as quality gates in your CI pipeline.
|
|
27
|
+
|
|
28
|
+
### Features
|
|
29
|
+
|
|
30
|
+
- **CI-ready**: Designed for automated pipelines (GitHub Actions, GitLab CI, etc.)
|
|
31
|
+
- **WCAG compliance**: Tests against WCAG 2.1 AA guidelines
|
|
32
|
+
- **Scorecard output**: Machine-readable reports for pass/fail gating
|
|
33
|
+
- **Part of accessibility-suite**: Works alongside a11y-assist, a11y-lint, and a11y-evidence-engine
|
|
34
|
+
|
|
35
|
+
## Requirements
|
|
36
|
+
|
|
37
|
+
- Node.js >= 18
|
|
38
|
+
- Python 3.10+ (installed automatically via postinstall if needed)
|
|
39
|
+
|
|
40
|
+
## Links
|
|
41
|
+
|
|
42
|
+
- [GitHub Repository](https://github.com/mcp-tool-shop-org/accessibility-suite)
|
|
43
|
+
- [a11y-ci Source](https://github.com/mcp-tool-shop-org/accessibility-suite/tree/main/src/a11y-ci)
|
|
44
|
+
|
|
45
|
+
## License
|
|
46
|
+
|
|
47
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,35 +1,35 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@mcptoolshop/a11y-ci",
|
|
3
|
-
"version": "0.2.
|
|
4
|
-
"description": "npm wrapper for a11y-ci - CI gate for accessibility scorecards",
|
|
5
|
-
"bin": {
|
|
6
|
-
"a11y-ci": "./bin/a11y-ci.js"
|
|
7
|
-
},
|
|
8
|
-
"scripts": {
|
|
9
|
-
"postinstall": "node postinstall.js"
|
|
10
|
-
},
|
|
11
|
-
"keywords": [
|
|
12
|
-
"accessibility",
|
|
13
|
-
"a11y",
|
|
14
|
-
"ci",
|
|
15
|
-
"testing",
|
|
16
|
-
"wcag",
|
|
17
|
-
"python",
|
|
18
|
-
"wrapper"
|
|
19
|
-
],
|
|
20
|
-
"author": "mcp-tool-shop <64996768+mcp-tool-shop@users.noreply.github.com>",
|
|
21
|
-
"license": "MIT",
|
|
22
|
-
"repository": {
|
|
23
|
-
"type": "git",
|
|
24
|
-
"url": "https://github.com/mcp-tool-shop/
|
|
25
|
-
"directory": "npm"
|
|
26
|
-
},
|
|
27
|
-
"homepage": "https://github.com/mcp-tool-shop/
|
|
28
|
-
"engines": {
|
|
29
|
-
"node": ">=18.0.0"
|
|
30
|
-
},
|
|
31
|
-
"publishConfig": {
|
|
32
|
-
"access": "public",
|
|
33
|
-
"registry": "https://registry.npmjs.org"
|
|
34
|
-
}
|
|
35
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@mcptoolshop/a11y-ci",
|
|
3
|
+
"version": "0.2.2",
|
|
4
|
+
"description": "npm wrapper for a11y-ci - CI gate for accessibility scorecards",
|
|
5
|
+
"bin": {
|
|
6
|
+
"a11y-ci": "./bin/a11y-ci.js"
|
|
7
|
+
},
|
|
8
|
+
"scripts": {
|
|
9
|
+
"postinstall": "node postinstall.js"
|
|
10
|
+
},
|
|
11
|
+
"keywords": [
|
|
12
|
+
"accessibility",
|
|
13
|
+
"a11y",
|
|
14
|
+
"ci",
|
|
15
|
+
"testing",
|
|
16
|
+
"wcag",
|
|
17
|
+
"python",
|
|
18
|
+
"wrapper"
|
|
19
|
+
],
|
|
20
|
+
"author": "mcp-tool-shop <64996768+mcp-tool-shop@users.noreply.github.com>",
|
|
21
|
+
"license": "MIT",
|
|
22
|
+
"repository": {
|
|
23
|
+
"type": "git",
|
|
24
|
+
"url": "git+https://github.com/mcp-tool-shop-org/accessibility-suite.git",
|
|
25
|
+
"directory": "src/a11y-ci/npm"
|
|
26
|
+
},
|
|
27
|
+
"homepage": "https://github.com/mcp-tool-shop-org/accessibility-suite#readme",
|
|
28
|
+
"engines": {
|
|
29
|
+
"node": ">=18.0.0"
|
|
30
|
+
},
|
|
31
|
+
"publishConfig": {
|
|
32
|
+
"access": "public",
|
|
33
|
+
"registry": "https://registry.npmjs.org"
|
|
34
|
+
}
|
|
35
|
+
}
|
package/bin/a11y-ci.js
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
2
|
-
const { spawn } = require('child_process');
|
|
3
|
-
|
|
4
|
-
async function main() {
|
|
5
|
-
const args = process.argv.slice(2);
|
|
6
|
-
const a11yCi = spawn('a11y-ci', args, {
|
|
7
|
-
stdio: 'inherit',
|
|
8
|
-
shell: true
|
|
9
|
-
});
|
|
10
|
-
|
|
11
|
-
a11yCi.on('close', (code) => {
|
|
12
|
-
process.exit(code || 0);
|
|
13
|
-
});
|
|
14
|
-
|
|
15
|
-
a11yCi.on('error', (err) => {
|
|
16
|
-
console.error('❌ a11y-ci is not installed.');
|
|
17
|
-
console.error('');
|
|
18
|
-
console.error('Please install a11y-ci using pip:');
|
|
19
|
-
console.error(' pip install a11y-ci');
|
|
20
|
-
console.error('');
|
|
21
|
-
console.error('PyPI: https://pypi.org/project/a11y-ci/');
|
|
22
|
-
process.exit(1);
|
|
23
|
-
});
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
main();
|
package/postinstall.js
DELETED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
2
|
-
console.log('');
|
|
3
|
-
console.log('📦 @mikeyfrilot/a11y-ci installed!');
|
|
4
|
-
console.log('');
|
|
5
|
-
console.log('⚠️ This is an npm wrapper for the Python package "a11y-ci".');
|
|
6
|
-
console.log('');
|
|
7
|
-
console.log('To use a11y-ci, install the Python package:');
|
|
8
|
-
console.log(' pip install a11y-ci');
|
|
9
|
-
console.log('');
|
|
10
|
-
console.log('PyPI: https://pypi.org/project/a11y-ci/');
|
|
11
|
-
console.log('');
|