@govtechsg/oobee 0.10.21 → 0.10.28
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/.github/workflows/docker-test.yml +1 -1
- package/DETAILS.md +40 -25
- package/Dockerfile +41 -47
- package/LICENSE-3RD-PARTY-REPORT.txt +448 -0
- package/LICENSE-3RD-PARTY.txt +19913 -0
- package/README.md +10 -2
- package/__mocks__/mock-report.html +1503 -1360
- package/package.json +8 -4
- package/scripts/decodeUnzipParse.js +29 -0
- package/scripts/install_oobee_dependencies.command +2 -2
- package/scripts/install_oobee_dependencies.ps1 +3 -3
- package/src/cli.ts +3 -2
- package/src/constants/cliFunctions.ts +16 -2
- package/src/constants/common.ts +29 -5
- package/src/constants/constants.ts +28 -26
- package/src/constants/questions.ts +4 -1
- package/src/crawlers/commonCrawlerFunc.ts +114 -152
- package/src/crawlers/crawlDomain.ts +25 -25
- package/src/crawlers/crawlIntelligentSitemap.ts +7 -1
- package/src/crawlers/crawlLocalFile.ts +1 -1
- package/src/crawlers/crawlSitemap.ts +1 -1
- package/src/crawlers/custom/flagUnlabelledClickableElements.ts +546 -472
- package/src/crawlers/customAxeFunctions.ts +1 -1
- package/src/index.ts +0 -2
- package/src/mergeAxeResults.ts +569 -219
- package/src/screenshotFunc/pdfScreenshotFunc.ts +3 -3
- package/src/static/ejs/partials/components/wcagCompliance.ejs +10 -29
- package/src/static/ejs/partials/footer.ejs +10 -13
- package/src/static/ejs/partials/scripts/categorySummary.ejs +2 -2
- package/src/static/ejs/partials/scripts/decodeUnzipParse.ejs +3 -0
- package/src/static/ejs/partials/scripts/reportSearch.ejs +1 -0
- package/src/static/ejs/partials/scripts/ruleOffcanvas.ejs +54 -52
- package/src/static/ejs/partials/styles/styles.ejs +4 -0
- package/src/static/ejs/partials/summaryMain.ejs +15 -42
- package/src/static/ejs/report.ejs +21 -12
- package/src/utils.ts +10 -2
- package/src/xPathToCss.ts +186 -0
- package/a11y-scan-results.zip +0 -0
- package/src/types/xpath-to-css.d.ts +0 -3
package/README.md
CHANGED
|
@@ -346,8 +346,9 @@ Options:
|
|
|
346
346
|
ks
|
|
347
347
|
[string] [choices: "default", "disable-oobee", "enable-wcag-aaa", "disable-oob
|
|
348
348
|
ee,enable-wcag-aaa"] [default: "default"]
|
|
349
|
-
-g, --generateJsonFiles Generate two
|
|
350
|
-
results of the
|
|
349
|
+
-g, --generateJsonFiles Generate two gzipped and base64-encoded
|
|
350
|
+
JSON files containing the results of the
|
|
351
|
+
accessibility scan:
|
|
351
352
|
1. `scanData.json`: Provides an overview of
|
|
352
353
|
the scan, including:
|
|
353
354
|
- WCAG compliance score
|
|
@@ -363,6 +364,13 @@ Options:
|
|
|
363
364
|
- URL of the pages violated the WCAG clauses
|
|
364
365
|
Useful for in-depth analysis or integration
|
|
365
366
|
with external reporting tools.
|
|
367
|
+
|
|
368
|
+
To obtain the JSON files, you need to base64-decode
|
|
369
|
+
the file followed by gunzip. For example:
|
|
370
|
+
(macOS) base64 -D -i scanData.json.gz.b64 |
|
|
371
|
+
gunzip > scanData.json\n
|
|
372
|
+
(linux) base64 -d scanData.json.gz.b64 |
|
|
373
|
+
gunzip > scanData.json\n
|
|
366
374
|
[string] [choices: "yes", "no"] [default: "no"]
|
|
367
375
|
|
|
368
376
|
Examples:
|