holmusk/rwe-elm-ci

Elm-CI替代版本镜像文档

镜像概述和主要用途

本镜像为elm-ci的替代版本，基于node:12-buster基础镜像构建，并集成了elm-format工具。主要用于为Elm项目提供持续集成（CI）环境，支持Elm代码的构建、格式化检查及相关自动化流程。

核心功能和特性

• 基础环境：基于node:12-buster，提供稳定的Node.js 12运行环境，兼容多数Elm项目依赖
• 工具集成：内置elm-format，支持Elm代码的自动格式化与格式验证
• 兼容性：可作为标准elm-ci的替代方案，适用于需要特定Node.js版本的场景
• 轻量设计：优化镜像体积，适合CI/CD流水线快速部署和执行

使用场景和适用范围

• Elm项目的持续集成流程（如GitHub Actions、GitLab CI、Jenkins等）
• 需要自动化检查和修复Elm代码格式的开发场景
• 基于Node.js 12环境构建的Elm应用项目
• 对标准elm-ci版本有定制化需求的开发团队

使用方法和配置说明

基本使用方式

通过docker run命令启动容器，挂载Elm项目目录并执行相关操作：

bash
docker run -v /本地/elm项目路径:/app -w /app [镜像名称] elm-format --validate src/

参数说明：

• -v /本地/elm项目路径:/app：将本地Elm项目目录挂载到容器内的/app工作目录
• -w /app：设置容器工作目录为/app
• elm-format --validate src/：执行Elm代码格式验证，检查src/目录下的文件格式

常用命令示例

1. 验证代码格式

检查指定目录的Elm代码是否符合格式规范（不修改文件）：

bash
docker run -v /path/to/elm/project:/app -w /app [镜像名称] elm-format --validate src/

2. 自动格式化代码

自动修复指定目录的Elm代码格式问题：

bash
docker run -v /path/to/elm/project:/app -w /app [镜像名称] elm-format src/ --yes

3. 配合npm脚本使用

若项目package.json中定义了格式检查脚本（如"format:check"），可直接执行：

bash
docker run -v /path/to/elm/project:/app -w /app [镜像名称] npm run format:check

配置说明

本镜像无需额外环境变量配置，主要通过挂载项目目录和执行命令参数实现功能定制。建议在CI配置文件中根据项目需求编写相应的执行命令。