drevops/shellvar

shellvar工具镜像

镜像概述

本镜像提供shell变量处理工具，支持对shell脚本中的变量进行格式检查与修复，以及提取变量信息并生成多种格式的输出文档，适用于脚本规范化与文档自动化场景。

核心功能

1. 变量格式检查与修复
   • 检测脚本中未使用${VAR}格式的变量
   • 自动修复非规范格式的变量
2. 变量提取与输出
   • 扫描文件/目录提取变量（含注释、赋值）
   • 支持过滤（排除局部变量、按前缀排除等）
   • 输出格式：CSV、Markdown表格、Markdown块
   • 可扩展自定义过滤器与格式化器

使用场景

• 规范shell脚本变量格式，提升代码可读性
• 自动生成脚本变量文档（如API文档、配置说明）
• 批量提取项目中所有shell变量进行审计

配置说明

Docker部署示例

基本运行

bash
docker run -v $(pwd):/app docker.xuanyuan.run/drevops/shellvar [command] [options] path/to/script.sh

检查变量格式

bash
docker run -v $(pwd):/app docker.xuanyuan.run/drevops/shellvar lint path/to/script.sh

修复变量格式

bash
docker run -v $(pwd):/app docker.xuanyuan.run/drevops/shellvar lint --fix path/to/script.sh

提取变量为Markdown表格

bash
docker run -v $(pwd):/app docker.xuanyuan.run/drevops/shellvar extract --format=md-table path/to/script.sh

关键选项

• 提取阶段：--skip-text（跳过含指定文本的变量）、--skip-description-prefix（跳过指定前缀的描述）
• 过滤阶段：--exclude-local（排除局部变量）、--exclude-prefix（按前缀排除）
• 输出格式：--format（指定输出格式：csv/md-table/md-blocks）、--sort（按名称排序）

维护说明

镜像标签说明：

• XX.YY.ZZ：正式版本（对应GitHub release）
• latest：最新正式版本
• canary：主分支每日构建版本

如需自定义扩展，可通过添加自定义过滤器/格式化器类实现。