@jackdbd/eleventy-plugin-ensure-env-vars

Eleventy plugin that checks environment variables before Eleventy builds your site.

• Installation
• Usage
• Configuration
  • Plugin options
• Troubleshooting
• Dependencies
• License

Installation

npm install @jackdbd/eleventy-plugin-ensure-env-vars

Note: this library was tested on Node.js >=18. It might work on other Node.js versions though.

Usage

In your Eleventy config file:

import { ensureEnvVarsPlugin } from '@jackdbd/eleventy-plugin-ensure-env-vars'

export default function (eleventyConfig) {
  // some eleventy configuration...

  eleventyConfig.addPlugin(ensureEnvVarsPlugin, {
    envVars: ['DEBUG', 'NODE_ENV']
  })

  // some more eleventy configuration...
}

Configuration

Plugin options

| Key | Default | Description | |---|---|---| | envVars | undefined | Environment variables you want to be set when building your Eleventy site |

Troubleshooting

This plugin uses the debug library for logging. You can control what's logged using the DEBUG environment variable.

For example, if you set your environment variables in a .envrc file, you can do:

# print all logging statements
export DEBUG=11ty-plugin:*

Dependencies

| Package | Version | |---|---| | zod | ^3.23.0 | | zod-validation-error | ^3.1.0 |

⚠️ Peer Dependencies

This package defines 2 peer dependencies.

| Peer | Version range | |---|---| | @11ty/eleventy | >=2.0.0 or 3.0.0-alpha.6 | | debug | >=4.0.0 |

License

© 2022 - 2024 Giacomo Debidda // MIT License