npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@penfold/validate-env-vars-webpack-plugin

v1.1.0

Published

> A webpack plugin to validate usage of environment variables

Downloads

1,919

Readme

validate-env-vars-webpack-plugin

A webpack plugin to validate usage of environment variables

Webpack version support

This plugin has only been tested with webpack >= 5.6.0.

Options

knownEnvVars

  • type: see the sections below for supported values
  • default: Object.keys(process.env)

Defines the list of known environment variables.

The plugin will produce an error for any environment variable used that is not in this list.

The field supports different sources for the list of env vars.

Array

Validate against a list of environment variables.

Example:

knownEnvVars: ["PROJECT_NAME", "SECRET"]

AWS SecretsManager

Validate environment variables against a secret in AWS SecretsManager.

The secret should be a key/value secret rather than plain text.

Give knownEnvVars an object with the properties:

  • secretId (required) - the name of the secret in SecretsManager
  • accessKeyId (required)
  • secretAccessKey (required)
  • region (required)
  • sessionToken (optional)
  • secretVersionId (optional)
  • secretVersionStage (optional)

Example:

knownEnvVars: {
    secretId: "api-env-vars",
    accessKeyId: process.env.AWS_ACCESS_KEY_ID,
    secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
    region: "eu-west-1"
}

.env file

Validate environment variables against an .env file.

Give knownEnvVars a string file path to the .env file.

For example:

knownEnvVars: path.resolve(__dirname, "../.env")

includePaths

  • type: [String|RegExp]
  • default: []

Defines the file paths to include in the validation.

includePaths: [path.resolve(__dirname, "src")]

excludePaths

  • type: [String|RegExp]
  • default: []

Defines the file paths to ignore in the validation.

Example:

excludePaths: [path.resolve(__dirname, "src/generated")]

ignoreEnvVars

  • type: String[]
  • default: []

A list of environment variable names to exclude from the validation.

Example:

ignoreEnvVars: ["RUNTIME_VALUE"]

knownEnvVarsTimeout

  • type: Number
  • default: 5000

When using an external source (eg. AWS SecretsManager) for knownEnvVars, this defines the amount of time in milliseconds to wait for the list of environment variables to be resolved before exiting with an error.

Example:

knownEnvVarsTimeout: 2000 // 2 seconds

Usage

Add the plugin to your webpack plugins array. For example:

plugins: [
    new ValidateEnvVarsPlugin({
        knownEnvVars: ["PROJECT_NAME", "SECRET"],
        includePaths: [path.resolve(__dirname, "src")]
    })
]

Example error

ERROR in ./src/app/api.ts
Unrecognised environment variable: WEBSITE_URL
 @ ./src/setup.ts 27:15-35
 @ ./src/index.ts 15:33-55

Author & License

validate-env-vars-webpack-plugin was created by Penfold and is released under the MIT license.