Skip to content
/ ngrv Public

Engrave build information to the build output. Set environment variables automatically.

Notifications You must be signed in to change notification settings

thilllon/ngrv

Repository files navigation

ngrv

npm issues size download license

ngrv (engrave) engraves build information and registers those as environment variables to process.env.

Basic usage

CLI

  • Create .ngrv file which contains build information
# That's it! Nothing else. Default outputs will be stored in `./.ngrv`
npx ngrv

# You can pass the output directory where outputs will be stored
npx ngrv --directory my_directory

# shortly,
npx ngrv -d my_directory
  • Read .ngrv file and load values as environment variables
npx ngrv read [--directory my_directory]

# or shortly,
npx ngrv r -d my_directory

Programmatically

  • Create ngrv
import { engrave } from 'ngrv';

// Create outputs with build information
const ngrvs = engrave();

console.log(ngrvs);
  • Read ngrv
import { readEngrave } from 'ngrv';

// Read the files and set information into the process.env
const ngrvs = readEngrave();

console.log(ngrvs);

Example

cd example
pnpm install
pnpm dev # or pnpm cli

About

Engrave build information to the build output. Set environment variables automatically.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published