dotenvlinter/dotenv-linter

镜像概述

该镜像是一个用Rust编写的针对.env文件的快速检查工具（linter），旨在高效检测.env文件中的语法错误、格式问题及潜在配置风险，确保环境变量配置文件的正确性和规范性。

主要用途

• 检查.env文件的语法正确性，如键值对格式、引号使用、特殊字符处理等
• 识别.env文件中的常见格式问题，如重复键、未使用的变量、无效注释等
• 为开发和部署流程提供自动化的.env文件质量保障

核心功能和特性

• 闪电般快速的检查速度：基于Rust语言开发，具备高效的性能和低资源占用，可在毫秒级完成对大型.env文件的检查
• 专注于.env文件：专门针对.env文件格式优化，支持标准.env文件语法及常见扩展格式
• 轻量级设计：镜像体积小巧，启动快速，易于集成到各类工作流中
• 全面的错误检测：覆盖常见的.env文件问题，如语法错误、格式不规范、潜在的安全隐患（如敏感信息暴露风险提示）等

使用场景和适用范围

• 开发环境：开发人员本地检查.env配置文件，在提交代码前确保格式正确
• CI/CD流程：集成到持续集成/持续部署管道中，自动检查提交的.env文件，防止错误配置进入部署流程
• 团队协作：作为团队编码规范的一部分，统一.env文件格式，减少因配置差异导致的问题
• 项目维护：定期检查项目中的.env文件，确保长期维护过程中的配置文件质量

使用方法和配置说明

基本使用

通过Docker运行该镜像，挂载本地.env文件到容器中进行检查：

bash
docker run --rm -v $(pwd)/.env:/app/.env [镜像名称] /app/.env

参数说明：

• --rm：容器运行完成后自动删除
• -v $(pwd)/.env:/app/.env：将本地当前目录下的.env文件挂载到容器内的/app/.env路径
• [镜像名称]：替换为实际的Docker镜像名称
• /app/.env：指定容器内待检查的.env文件路径

配置参数

该工具支持通过命令行参数调整检查行为，常见参数包括：

• --strict：启用严格模式，对格式问题报错（默认仅警告）
• --quiet：仅输出错误信息，不显示警告和信息日志
• --verbose：显示详细检查过程和调试信息
• --ignore <pattern>：忽略符合指定模式的键或行（可多次使用）

示例（启用严格模式并忽略以_OLD结尾的键）：

bash
docker run --rm -v $(pwd)/.env:/app/.env [镜像名称] /app/.env --strict --ignore "*_OLD"

输出说明

检查完成后，工具将输出检查结果，包括：

• 检查状态（成功/失败）
• 错误数量和警告数量
• 详细的问题描述及位置（文件名、行号）

错误退出码：

• 0：检查通过，未发现错误
• 1：发现警告但无错误
• 2：发现错误