DSH VERTICAL KIT · 环境变量示例检查 / .env 检查

环境变量示例检查清单

它决定一件事:这份示例文件是否只含占位符、键不重复、有用途说明。

检查规则

规则判定
empty没有任何 KEY=value 行 → error
literal-value某键带了字面值(从 .env 复制过来的典型形态)→ error,报行号
duplicate-key同一个键出现两次 → error,同时报两行
line-unparsed既不是 KEY=value 也不是注释 → warn
key-case键名不是全大写下划线 → warn(shell 里大小写是两个变量)
comment-missing / no-comment没有任何注释行 → warn(--require-comment 时升级为 error)

用法

npx env-example-check .env.example --json
npx env-example-check .env.example --require-comment

真实输入输出

输入
DATABASE_URL=postgres://user:pass@prod-db:5432/app
PORT=8080
API_KEY=sk-live-abc123
$ env-example-check env-sample
error literal-value 第1行 第 1 行 DATABASE_URL 带了字面值「postgres://user:pass」——示例文件只放占位符,真值进 .env(不提交)
error literal-value 第2行 第 2 行 PORT 带了字面值「8080」——示例文件只放占位符,真值进 .env(不提交)
error literal-value 第3行 第 3 行 API_KEY 带了字面值「sk-live-abc123」——示例文件只放占位符,真值进 .env(不提交)
warn comment-missing 第0行 没有任何注释行——说明每个键的用途,读者才知道该填什么
fail: 3 keys, 3 errors, 1 warnings

出口码:1。输出为真实 CLI 运行的逐字结果,由测试与工具保持同步。

出口码:0 干净、1 有发现、2 用法或读文件错误。--json 输出机器可读结果。DSH 内同样的函数在 POST /env-example-check/api({"text":"…"} 或 {"path":"…"}),面板与 CI 调同一实现。

这是清单,不是专业人士。合同检查不是法律意见,发票检查不判税务合规,listing 检查不判商业价值。每条发现都是文本里可判定的结构缺陷,带行号。
认的占位符形态:空值、<尖括号>、${VAR} 引用、your-…、changeme、xxx、TODO、placeholder、example、dummy、test、none、null;其余都算「真值已提交」。只验示例文件的形状,看不见仓库历史与 CI 密钥。 · dsh-vertical-kit · 通用检查(哈希/引用/结构/表格/数字)在 dsh-verify-kit