chabad360/htmlproofer

HTML文件准确性测试镜像

镜像概述

该Docker镜像提供了HTML文件测试功能，旨在验证已渲染HTML文件的内容准确性。通过自动化测试流程，确保HTML文件在渲染后符合预期的内容、格式及结构要求，适用于前端开发、静态网站构建等场景中的质量验证环节。

核心功能和特性

• 内容验证：检查HTML文件中的文本内容、链接、图片引用等是否符合预期
• 格式检查：验证HTML结构是否完整、标签是否正确闭合
• 轻量便捷：基于精简基础镜像构建，部署和运行简单高效
• 灵活集成：支持与CI/CD流程整合，实现自动化测试

使用场景和适用范围

• 前端开发中验证HTML模板渲染结果
• 静态网站生成工具（如Jekyll、Hugo）输出文件的质量检查
• 文档网站构建后的内容准确性验证
• 自动化测试流程中对HTML产物的批量校验

使用方法和配置说明

基本使用（docker run）

bash
# 测试指定目录下的HTML文件
docker run -v /本地/html文件目录:/app/html your-image-name

高级配置

环境变量

自定义测试规则

1. 创建JSON格式的测试规则文件（如custom-rules.json）：

json
{
  "checks": [
    "text-content",
    "link-validity",
    "image-references"
  ],
  "exclusions": [
    "temp/*.html"
  ]
}

2. 挂载自定义规则文件并运行：

bash
docker run -v /本地/html文件目录:/app/html \
           -v /本地/custom-rules.json:/app/rules/custom.json \
           -e TEST_RULES=/app/rules/custom.json \
           your-image-name

docker-compose配置示例

yaml
version: '3'
services:
  html-test:
    image: your-image-name
    volumes:
      - ./html-files:/app/html
      - ./custom-rules.json:/app/rules/custom.json
    environment:
      - TEST_RULES=/app/rules/custom.json
      - REPORT_OUTPUT=/app/html/test-report.html

输出说明

测试完成后，默认在挂载目录下生成test-report.html报告文件，包含测试结果摘要、通过/失败项详情及错误原因分析。