CONTRIBUTING.md

PRs are always welcome.

First, please read our Code of Conduct.

If you have any questions please reach out to us on Discord in the #contribute channel.

Installation

You'll need, at minimum, node 22 and pnpm 10+ installed.

We recommend using fnm to manage node versions. If you use fnm with corepack you can run corepack enable to enable pnpm and you should be good to go.

Then install the dependencies:

pnpm install

Then build the libraries:

pnpm build:libs

Packages

• packages/env-spec-parser - Parser for the @env-spec language
• packages/varlock - CLI for loading .env files, and library for integration into JS projects
• packages/varlock-website - Docs website for varlock and @env-spec
• packages/vscode-plugin - VSCode extension for @env-spec
• packages/integrations/nextjs - Next.js integration for varlock

See the README.md for each package for more details.

Debugging

It is often useful to enable source maps in traces during local development.

To do so run export NODE_OPTIONS=--enable-source-maps in your active terminal.