A `.env.example` in a repository opens as the variables an app needs: name, example value and its comment per row #11130

A .env.example, .env.sample or .env.template now opens as a table with columns name, example value and comment, drawn on the server. The new tests, tsc, the gate, design-lint, test/tui-workspace.test.ts and test/check-list.test.ts pass. I did not run the whole suite. scripts/fast.ts called the diff too broad to name (1766 of 2698 files), so I picked the tests that cover it.

What changed

• Matching: only those three exact basenames match, at any depth. A plain .env or .env.local keeps today's source view, and ?view=source shows the raw text.
• Table: an empty value or comment shows —. Every cell is escaped. A # block followed by a blank line becomes a group heading row, and a # block directly above a variable is its comment. An inline # note joins the comment.
• Parsing: export is accepted, quoted values keep any # inside the quotes, and a # in a URL fragment stays part of the value.
• Masking: a value is shown as ••• when the name ends in _KEY, _SECRET or _TOKEN, or contains PASSWORD. An empty secret still shows —.
• Cap: at most 500 rows, then one line N more not shown. A file with no variables falls back to the source with a reason.
• Terminal: the workspace opens the same table, and s flips to the source.
• Code:

- src/web/render/env.ts is new. - A new env kind is registered in kinds.ts and renderers.ts. - The terminal's envTable is in workspace.ts and shares the web parser.

• Tests:

- test/render-env.test.ts is new and covers parsing, masking, escaping, the cap and the plain .env exclusion. It is gated automatically. - test/tui-workspace.test.ts gains one case for the terminal.

• Docs: docs/features/file-env.md is new, with a section in docs/design/areas/render.md. There is no new CSS and no dependency.

Left out

• .env.local.example and similar names are not matched, by design.
• Multi-line quoted values are not joined; the first line is shown.
• A commented-out # FOO=bar is read as a comment, not a variable.

Try it Open any repository's .env.example in the file view, and add ?view=source for the raw text. In the terminal workspace, press s to flip.

The Try: empty commit is only there because the pre-push hook asked for one.

Closes #11109

A .env.example, .env.sample or .env.template now opens as a table with columns name, example value and comment, drawn on the server. The new tests, tsc, the gate, design-lint, test/tui-workspace.test.ts and test/check-list.test.ts pass. I did not run the whole suite. scripts/fast.ts called the diff too broad to name (1766 of 2698 files), so I picked the tests that cover it.

What changed

• Matching: only those three exact basenames match, at any depth. A plain .env or .env.local keeps today's source view, and ?view=source shows the raw text.
• Table: an empty value or comment shows —. Every cell is escaped. A # block followed by a blank line becomes a group heading row, and a # block directly above a variable is its comment. An inline # note joins the comment.
• Parsing: export is accepted, quoted values keep any # inside the quotes, and a # in a URL fragment stays part of the value.
• Masking: a value is shown as ••• when the name ends in _KEY, _SECRET or _TOKEN, or contains PASSWORD. An empty secret still shows —.
• Cap: at most 500 rows, then one line N more not shown. A file with no variables falls back to the source with a reason.
• Terminal: the workspace opens the same table, and s flips to the source.
• Code:

- src/web/render/env.ts is new. - A new env kind is registered in kinds.ts and renderers.ts. - The terminal's envTable is in workspace.ts and shares the web parser.

• Tests:

- test/render-env.test.ts is new and covers parsing, masking, escaping, the cap and the plain .env exclusion. It is gated automatically. - test/tui-workspace.test.ts gains one case for the terminal.

• Docs: docs/features/file-env.md is new, with a section in docs/design/areas/render.md. There is no new CSS and no dependency.

Left out

• .env.local.example and similar names are not matched, by design.
• Multi-line quoted values are not joined; the first line is shown.
• A commented-out # FOO=bar is read as a comment, not a variable.

Try it Open any repository's .env.example in the file view, and add ?view=source for the raw text. In the terminal workspace, press s to flip.

The Try: empty commit is only there because the pre-push hook asked for one.

The preview is up and I changed nothing, so there is nothing new to push. The deploy log shows the forge starting with no errors. /healthz and / both answer 200 on https://lab--11130--forge-trevato-apps.open-platform.sh.

The "no tests declared, none run" line is an observation, not a failure. forge.json declares no tests under app, and the checks run under check. That file is the same as on main and my pull didn't touch it, so the failure verdict isn't something my change can have caused.

The gate, tsc, design-lint and the new .env.example tests passed before the push. I did not run the whole suite; scripts/fast.ts said the diff was too broad to name, so I ran the covering tests. If the preview still shows as failed, the verdict comes from the forge's deploy step, not from the code.

I merged main into the branch and pushed it. It had conflicted in docs/design/areas/render.md, src/web/render/kinds.ts and src/web/render/renderers.ts.

All three conflicts had the same shape: main added an openapi file kind next to the env kind this pull adds. I kept both sides everywhere. In kinds.ts the file kind is detected from the file name, and I kept both the isEnvExample and the isOpenApiName checks in that function. In renderers.ts both renderers are registered. In render.md both sections stay.

• Tests: after fixing the merge I ran the render and TUI workspace test files: 302 pass, 0 fail. I did not run the whole suite; the forge runs the full check on the push.
• Type check and design lint: tsc --noEmit is clean and design-lint passed.
• bun scripts/fast.ts: it reported that 1767 of 2700 test files are affected, a run of about 150 minutes. So I picked the render and workspace files myself.
• Gate: the first run failed its "pipeline first" rule, because this pull adds docs/features/file-env.md and no pipeline change. I added a Direction: line to the merge commit message saying why a user-facing renderer goes ahead of the pipeline items. After that the gate produced no output. I did not check its exit code separately.