equall-cli 0.1.3 → 0.1.4
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 +15 -4
- package/dist/chunk-CMP4ST3J.js +88532 -0
- package/dist/cli.js +43 -2
- package/dist/index.js +1 -1
- package/package.json +3 -1
- package/dist/chunk-5YPLWCOT.js +0 -40531
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Equall
|
|
2
2
|
|
|
3
|
-
Open-source accessibility scoring for dev teams. Aggregates axe-core, eslint-plugin-jsx-a11y, and more into a unified score.
|
|
3
|
+
Open-source accessibility scoring for dev teams. Aggregates axe-core, eslint-plugin-jsx-a11y, text-readability, and more into a unified score.
|
|
4
4
|
|
|
5
5
|
**One command. Real score. No config.**
|
|
6
6
|
|
|
@@ -94,7 +94,18 @@ It automatically skips: `node_modules`, `dist`, `build`, `.next`, test files, st
|
|
|
94
94
|
| Scanner | What it checks | WCAG criteria covered |
|
|
95
95
|
|---------|---------------|----------------------|
|
|
96
96
|
| **axe-core** | HTML structure, ARIA, landmarks, forms, media | 24 |
|
|
97
|
-
| **eslint-plugin-jsx-a11y** | JSX/React-specific a11y patterns |
|
|
97
|
+
| **eslint-plugin-jsx-a11y** | JSX/React-specific a11y patterns | 16 |
|
|
98
|
+
| **readability** | Required reading level of text content (Flesch, ARI, SMOG, etc.) | 1 (WCAG 3.1.5 AAA) |
|
|
99
|
+
|
|
100
|
+
### Readability scoring
|
|
101
|
+
|
|
102
|
+
The readability scanner checks [WCAG 3.1.5 (Reading Level)](https://www.w3.org/WAI/WCAG22/Understanding/reading-level) — text should be understandable at a lower secondary education level (approximately Grade 9).
|
|
103
|
+
|
|
104
|
+
It runs 6 formulas (Flesch-Kincaid, Coleman-Liau, ARI, Gunning Fog, SMOG, Dale-Chall) and uses the **median grade** across all formulas to reduce single-formula bias. If the median exceeds Grade 9, an issue is reported with the full breakdown.
|
|
105
|
+
|
|
106
|
+
- Scans `.html` and `.vue` files only — JSX/TSX excluded because regex extraction captures `className` attributes and `{expressions}` that pollute scores
|
|
107
|
+
- Skips files with fewer than 30 words (formulas are statistically invalid on short text)
|
|
108
|
+
- Skips non-English files (detected via `lang` attribute) — formulas are English-calibrated
|
|
98
109
|
|
|
99
110
|
## Scoring
|
|
100
111
|
|
|
@@ -131,15 +142,15 @@ Some issues are false positives (e.g. an orphan `<li>` in a component that's alw
|
|
|
131
142
|
<img src="decorative.png" />
|
|
132
143
|
```
|
|
133
144
|
|
|
134
|
-
Add `// equall-ignore-file` in the first 5 lines to ignore an entire file.
|
|
135
|
-
|
|
136
145
|
Or use the CLI to inject/manage comments without opening the file:
|
|
137
146
|
|
|
138
147
|
```bash
|
|
148
|
+
equall ignore src/Modal.tsx # ignore an entire file
|
|
139
149
|
equall ignore src/Modal.tsx:89 # ignore all rules at line 89
|
|
140
150
|
equall ignore src/Modal.tsx:89 jsx-a11y/alt-text # ignore a specific rule
|
|
141
151
|
equall ignore . # list all ignores
|
|
142
152
|
equall ignore --remove src/Modal.tsx:89 # remove an ignore
|
|
153
|
+
equall ignore --remove src/Modal.tsx # remove all ignores in a file
|
|
143
154
|
equall ignore --clear # remove all ignores
|
|
144
155
|
```
|
|
145
156
|
|