a11ywatch/pagemind

pagemind 镜像文档

概述

pagemind是一款专注于网页可访问性检测与页面洞察的工具，能够识别网页中的可访问性问题（如WCAG标准合规性）、分析页面性能指标（如加载时间），并生成包含详细问题分类、可访问性得分及优化建议的综合报告。

核心功能和特性

• 可访问性检测：遵循WCAG标准，识别网页中的可访问性问题，分类展示错误、警告和提示信息
• 页面性能分析：测量页面加载时间，提供加载时长、性能等级及视觉化标识
• 综合报告生成：包含可访问性得分（adaScore）、问题统计（错误数、警告数等）、页面截图链接及HTML内容
• API接口支持：通过POST请求提交检测任务，支持自定义检测URL和用户ID参数

使用场景和适用范围

• 网站开发团队：在开发过程中检测网页可访问性问题，确保产品符合无障碍标准
• QA测试人员：自动化测试网页的可访问性和性能指标，提升测试效率
• 网站维护人员：定期监控网页健康状态，及时发现并修复可访问性缺陷

使用方法和配置说明

Docker环境配置

在Docker环境中使用时，需创建.env文件并配置环境变量：

DOCKER_ENV=true

安装依赖

bash
npm install

启动服务

bash
npm run dev

服务启动后默认运行在8080端口。

API使用示例

通过POST请求调用API获取页面问题数据：

bash
curl --location --request POST 'http://localhost:8040/api/getPageIssues' \
--header 'Content-Type: application/json' \
--data-raw '{ "url": "https://www.drake.com", "userId": 0 }'

响应示例

json
{
    "webPage": {
        "domain": "drake.com",
        "url": "https://www.drake.com",
        "adaScore": 64,
        "cdnConnected": false,
        "screenshot": "http://127.0.0.1:8090/screenshots/drake.com/www-drake-com-ada-fix-0.png",
        "screenshotStill": "http://127.0.0.1:8090/screenshots/drake.com/www-drake-com-ada-fix-0-still.png",
        "pageLoadTime": {
            "duration": 1272,
            "durationFormated": "Standard",
            "color": "#A5D6A7"
        },
        "html": "<omited>",
        "htmlIncluded": true,
        "issuesInfo": {
            "possibleIssuesFixedByCdn": 10,
            "totalIssues": 25,
            "issuesFixedByCdn": 0,
            "errorCount": 11,
            "warningCount": 14,
            "noticeCount": 0,
            "adaScore": 64,
            "issueMeta": {
                "skipContentIncluded": false
            }
        },
        "lastScanDate": "Tue, 30 Mar 2021 21:55:38 GMT",
        "userId": 0
    },
    "issues": {
        "documentTitle": "Drake Industries | Custom, Durable, High-Quality Labels, Asset Tags and Custom Server Bezels",
        "pageUrl": "https://www.drake.com",
        "issues": [
            {
                "code": "WCAG2A.Principle1.Guideline2.4",
                "type": "warning",
                "typeCode": 2,
                "message": "Skip to content link not found. Use skip to content links to help shortcut to the main content.",
                "context": "<a id=\"content\">Skip Content</a>",
                "selector": "a",
                "runner": "a11yWatch",
                "runnerExtras": {}
            }
        ],
        "domain": "drake.com",
        "userId": 0
    },
    "script": {
        "pageUrl": "https://www.drake.com",
        "domain": "drake.com",
        "script": "<omited>",
        "cdnUrlMinified": "drake.com/www-drake-com-ada-fix-0.min.js",
        "cdnUrl": "drake.com/www-drake-com-ada-fix-0.js",
        "cdnConnected": false,
        "userId": 0,
        "issueMeta": {
            "skipContentIncluded": false
        }
    }
}

许可证

详见项目根目录下的LICENSE文件。