outrigger/cli

Outrigger cli

向 https://github.com/docksal/service-cli 添加 pa11y 和其他常用工具的 Docker 镜像。

镜像概述和主要用途

此镜像基于Docksal CLI镜像构建，扩展了开发工具集，特别适用于需要 accessibility（可访问性）测试和自动化浏览器操作的Web开发项目。通过集成pa11y和puppeteer，提供了便捷的可访问性测试和页面自动化能力。

核心功能和特性

向docksal/cli镜像添加了以下工具：

• https://github.com/pa11y/pa11y - Web可访问性测试工具
• https://github.com/puppeteer/puppeteer - 无头Chrome Node API（需测试v2.x版本兼容性）
• vim - 文本编辑器

使用场景和适用范围

适用于基于Docksal的Web开发项目，特别是需要：

• 执行Web可访问性合规性测试
• 实现浏览器自动化操作（如截图、页面交互）
• 在容器环境中进行文本编辑

使用方法和配置说明

DockerHub 集成

• 要为最新Docksal版本生成新镜像，需在master分支下添加类似2.12的新标签
• 如需启用更多PHP版本（如php7.4），需在DockerHub中添加自动构建目标：
  • 源类型：Tag
  • 源：`^[0-9.]+# Outrigger cli

向 https://github.com/docksal/service-cli 添加 pa11y 和其他常用工具的 Docker 镜像。

镜像概述和主要用途

此镜像基于Docksal CLI镜像构建，扩展了开发工具集，特别适用于需要 accessibility（可访问性）测试和自动化浏览器操作的Web开发项目。通过集成pa11y和puppeteer，提供了便捷的可访问性测试和页面自动化能力。

核心功能和特性

向docksal/cli镜像添加了以下工具：

• https://github.com/pa11y/pa11y - Web可访问性测试工具
• https://github.com/puppeteer/puppeteer - 无头Chrome Node API（需测试v2.x版本兼容性）
• vim - 文本编辑器

使用场景和适用范围

适用于基于Docksal的Web开发项目，特别是需要：

• 执行Web可访问性合规性测试
• 实现浏览器自动化操作（如截图、页面交互）
• 在容器环境中进行文本编辑

使用方法和配置说明

DockerHub 集成

• 要为最新Docksal版本生成新镜像，需在master分支下添加类似2.12的新标签
• 如需启用更多PHP版本（如php7.4），需在DockerHub中添加自动构建目标：
  • 源类型：Tag
  • 源：
  • Docker标签：{sourceref}-php7.4
  • Dockerfile位置：Dockerfile
  • 构建上下文：/
  • 自动构建：开启
  • 构建缓存：关闭
• DockerHub已配置自动构建，监控https://github.com/phase2/docker-cli/tags%E6%9B%B4%E6%96%B0
• 自动匹配格式为[0-9.]+的标签，以同步Docksal的#.##版本格式
• DockerHub使用hooks/build覆盖CLI_VERSION值，将匹配的标签应用于自动构建列表中的各PHP版本

在Docksal中使用pa11y

1. 在项目的.docksal/docksal.env中设置：

   CLI_IMAGE='outrigger/cli'
   

2. 启动项目：

   bash
   fin start
   

3. 容器启动后，为主题运行webpack-dev-server：

   bash
   cd THEME_PATH
   fin exec npm run theme
   

   其中theme任务在package.json中定义为：

   json
   "scripts": {
       "theme": "cross-env-shell NODE_ENV=development \"webpack-dev-server --config ./webpack.config.js --hot\""
   }
   

   此命令将使用webpack配置并进入监视模式，在主题文件更改时重新编译。

4. 主题编译完成且webpack-dev-server运行后，执行pa11y测试：

   bash
   fin exec npm run pa11y
   

   其中pa11y任务在package.json中定义为：

   json
   "scripts": {
     "pa11y": "pa11y-ci --config pa11y.js"
   }
   

资源

• 关于Docksal的一般问题请参考 docksal 文档
• 关于Puppeteer的一般问题请查看 https://hub.docker.com/r/alekzonder/puppeteer/%E3%80%82%E6%B3%A8%E6%84%8F%EF%BC%9A%E5%8F%AF%E6%8C%89%E7%85%A7%E8%AF%A5README%E4%B8%AD%E7%9A%84%E8%AF%B4%E6%98%8E%E8%BF%9B%E8%A1%8C%E6%88%AA%E5%9B%BE%E6%93%8D%E4%BD%9C%EF%BC%8C%E7%94%B1%E4%BA%8E%E6%9C%AC%E9%95%9C%E5%83%8F%E5%9F%BA%E4%BA%8E%E6%AD%A4%E6%9E%84%E5%BB%BA%EF%BC%8C%E6%97%A0%E9%9C%80%E9%A2%9D%E5%A4%96%E4%B8%8B%E8%BD%BDDocker%E9%95%9C%E5%83%8F%E3%80%82
• https://github.com/GoogleChrome/puppeteer
• https://github.com/GoogleChrome/puppeteer/blob/master/docs/troubleshooting.md#running-puppeteer-in-docker
• https://github.com/pa11y/pa11y

安全报告

请将安全问题发送至 ***。

维护者

![Phase2 Logo]([***]