babel-plugin-transform-inline-environment-variables

What is babel-plugin-transform-inline-environment-variables?

The babel-plugin-transform-inline-environment-variables package is a Babel plugin that allows you to inline environment variables into your code at build time. This can be useful for injecting configuration values directly into your JavaScript code, making it easier to manage environment-specific settings.

What are babel-plugin-transform-inline-environment-variables's main functionalities?

Inline Environment Variables

This feature allows you to replace occurrences of process.env.<VARIABLE_NAME> with the actual value of the environment variable at build time. For example, if you have an environment variable named API_URL, it will be inlined into your code.

const apiUrl = process.env.API_URL;

Configuration via Babel Config

You can configure the plugin in your Babel configuration file (e.g., .babelrc or babel.config.js). This makes it easy to integrate into your existing Babel setup.

{
  "plugins": [
    "transform-inline-environment-variables"
  ]
}

Other packages similar to babel-plugin-transform-inline-environment-variables

dotenv

dotenv is a popular package for loading environment variables from a .env file into process.env. Unlike babel-plugin-transform-inline-environment-variables, dotenv does not inline the variables at build time but loads them at runtime.

babel-plugin-transform-define

babel-plugin-transform-define allows you to replace identifiers with constant values at build time. It is more general-purpose compared to babel-plugin-transform-inline-environment-variables, which is specifically designed for inlining environment variables.

README

babel-plugin-transform-inline-environment-variables

Inline environment variables

Example

In

// assuming process.env.NODE_ENV is actually "development"
process.env.NODE_ENV;

Out

"development";

Installation

npm install babel-plugin-transform-inline-environment-variables --save-dev

Usage

Via .babelrc (Recommended)

.babelrc

// without options
{
  "plugins": ["transform-inline-environment-variables"]
}

// with options
{
  "plugins": [
    ["transform-inline-environment-variables", {
      "include": [
        "NODE_ENV"
      ]
    }]
  ]
}

Via CLI

babel --plugins transform-inline-environment-variables script.js

Via Node API

require("@babel/core").transform("code", {
  plugins: ["transform-inline-environment-variables"]
});

Options

• include - array of environment variables to include
• exclude - array of environment variables to exclude