gherkin/format

Gherkin文件格式化工具

镜像概述和主要用途

该Docker镜像提供了一个用于格式化Gherkin文件的工具，能够标准化Gherkin文件（.feature文件）的格式，支持自定义模板和批量处理。通过Docker容器运行可避免本地环境依赖，适用于开发团队统一Gherkin文件格式、自动化测试流程中的文件预处理等场景。

核心功能和特性

• 文件格式化：对Gherkin文件进行标准化格式处理
• 文件替换：支持直接替换原文件为格式化后的版本
• 错误详情：提供详细的错误信息输出，便于问题排查
• 自定义模板：支持通过ERB模板自定义格式化输出格式
• 预定义模板：内置两种预定义模板：markdown和multi_markdown

使用场景和适用范围

• 开发团队统一Gherkin文件编码规范和格式
• 自动化测试流程中对.feature文件进行预处理
• 将Gherkin用例转换为Markdown等文档格式
• CI/CD流水线中集成Gherkin文件格式检查

使用方法和配置说明

基本命令行使用

通过命令行运行工具，对指定的Gherkin文件进行格式化：

bash
gherkin_format FEATURE_FILES

常用选项

• --replace：直接替换原文件为格式化后的版本
• --verbose：输出详细错误信息，便于调试
• --template TEMPLATE：使用自定义ERB模板进行格式化，内置模板包括markdown和multi_markdown

Docker使用方法

假设当前目录下有待格式化的.feature文件，通过以下命令运行Docker容器：

bash
docker run -ti -v $(pwd):/src -w /src gherkin/format *.feature

参数说明

• -v $(pwd):/src：将当前目录挂载到容器内的/src目录
• -w /src：设置工作目录为/src（即挂载的当前目录）
• gherkin/format：Docker镜像名称
• *.feature：要格式化的Gherkin文件（可指定具体文件名或通配符）

示例：使用Markdown模板并替换原文件

bash
docker run -ti -v $(pwd):/src -w /src gherkin/format --replace --template markdown *.feature

本地安装（非Docker方式）

如需在本地直接安装使用，可通过RubyGems安装：

bash
sudo gem install gherkin_format

安装后，gherkin_format可执行命令将直接可用。