jbzoo/csv-blueprint

JBZoo / CSV Blueprint

镜像概述和主要用途

CSV Blueprint 是一款强大且灵活的工具，旨在根据 YAML 格式的预定义 schema 验证 CSV 文件。该工具支持在本地和 Docker 环境中运行，是集成到 CI/CD 流水线（如 GitHub Actions）的理想选择，可有效确保项目中 CSV 数据的完整性。

更多详细信息和最新文档，请参见 https://github.com/JBZoo/Csv-Blueprint%E3%80%82

核心功能和特性

• 基于 YAML 格式的自定义 schema 验证 CSV 文件
• 支持本地运行和 Docker 容器化部署
• 提供详细的命令行参数，满足灵活验证需求
• 适合集成到 CI/CD 流程，实现 CSV 数据验证自动化

使用场景和适用范围

• 项目开发中确保 CSV 数据符合预定义格式规范
• CI/CD 流水线（如 GitHub Actions）中自动化 CSV 数据验证步骤
• 需要批量或定期验证多个 CSV 文件的场景
• 团队协作中统一 CSV 数据格式标准，减少格式错误

使用方法和配置说明

前提条件

确保本地已安装 Docker 环境。

Docker 镜像拉取

sh
docker pull jbzoo/csv-blueprint:latest

Docker 容器运行示例

sh
docker run --rm                                  \
    --workdir=/parent-host                       \
    -v $(pwd):/parent-host                       \
    jbzoo/csv-blueprint:latest                   \
    validate:csv                                 \
    --csv=./tests/fixtures/demo.csv              \
    --schema=./tests/schemas/demo_schema.yml     \
    --ansi -vvv

参数说明

• --rm: 容器运行结束后自动删除容器，避免残留
• --workdir=/parent-host: 设置容器内工作目录为 /parent-host
• -v $(pwd):/parent-host: 将主机当前目录挂载到容器内的 /parent-host 目录，使工具可访问主机上的 CSV 文件和 schema 文件
• validate:csv: 执行 CSV 文件验证命令
• --csv: 指定待验证的 CSV 文件路径（相对于挂载的工作目录）
• --schema: 指定 YAML 格式的 schema 文件路径（相对于挂载的工作目录）
• --ansi: 启用 ANSI 颜色输出，增强日志可读性
• -vvv: 启用最高级别详细日志输出，便于问题排查