[Feature Request] Configurable schema filename

Open
#976 4 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
1-2 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript

Research direction

Start by reading the implementation of varlock load and how it locates .env.schema; the issue does not name specific files or tests. Compare the existing --path behavior with other load call sites, then identify where a shared configurable filename would need to be read. Done means the schema filename can be configured through a project wide mechanism and works across varlock load call sites.

Written by the indexing model from the issue text.

Description

Description

Allow the schema filename to be something other than .env.schema — via an env var, a package.json field, or a config key.

Motivation

Coding agents are commonly sandboxed with a deny rule on .env* so they can't read secret-bearing dotenv files. That rule catches .env.schema too, even though it's committed and holds no values — so the agent can't read or edit the one file it's most useful for it to maintain.

Proposed Solution

No preference on mechanism.

Alternatives

Naming the real file .env-schema and symlinking .env.schema to it. Works, but the symlink has to be explained to everyone who sees it.

--path .env-schema also appears to work, but only applies to that one call site — anything else running varlock load sees no schema.

Dominant language
TypeScript
Stars
4.9k
Forks
140
Avg merge
2d 3h
Merged PRs (30d)
35

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dmno-dev/varlock

All issues in dmno-dev/varlock

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.