peterdavehello/shfmt

shfmt

镜像概述和主要用途

本镜像为Docker化的https://github.com/mvdan/sh#shfmt shell脚本格式化工具。shfmt是一个功能强大的shell脚本格式化工具，能够统一shell脚本的代码风格。

注意：最初创建此Docker镜像的原因是当时没有官方镜像，但现在官方已提供shfmt Docker镜像，且官方镜像参考了本仓库的Dockerfile（详见https://github.com/mvdan/sh/issues/68%EF%BC%89%E3%80%82%E5%9B%A0%E6%AD%A4%EF%BC%8C%E6%9C%AC%E4%BB%93%E5%BA%93%E5%8F%AF%E8%83%BD%E4%B8%8D%E5%86%8D%E7%A7%AF%E6%9E%81%E7%BB%B4%E6%8A%A4%E3%80%82

核心功能和特性

• 基于shfmt工具，提供专业的shell脚本格式化能力
• 支持通过命令行参数自定义格式化规则（如缩进、空格、语法检查等）
• 轻量级Docker镜像，易于部署和跨平台使用
• 可无缝集成到CI/CD流程中，实现自动化格式检查

使用场景和适用范围

• 本地开发环境：格式化shell脚本，统一团队代码风格
• CI/CD流程：作为代码检查步骤，确保提交的shell脚本符合格式规范
• 跨平台场景：避免因本地环境差异导致的shfmt使用问题

使用方法和配置说明

命令行使用

通过https://hub.docker.com/r/peterdavehello/shfmt%E9%95%9C%E5%83%8F%E8%BF%90%E8%A1%8CDocker%E5%AE%B9%E5%99%A8%EF%BC%9A

sh
docker run --rm -it -v /本地脚本路径:/容器内路径 docker.xuanyuan.run/peterdavehello/shfmt:2.6.4 shfmt --version

将--version替换为所需参数，例如格式化当前目录下的脚本：

sh
docker run --rm -it -v "$(pwd)":/scripts docker.xuanyuan.run/peterdavehello/shfmt:2.6.4 shfmt -sr -i 2 -d -ci /scripts

注意：请将2.6.4替换为最新标签或您需要的版本。

GitLab CI配置示例

yaml
shfmt:
  stage: test
  image: peterdavehello/shfmt:2.6.4
  before_script:
    - shfmt -version
  script:
    - shfmt -sr -i 2 -d -ci .
  tags:
    - docker