Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

esbuild-envfile-plugin

Package Overview
Dependencies
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

esbuild-envfile-plugin

esbuild plugin to load a .env file from the current directory or any parent. It will combine the environment variables with existing/system-wide process.env variables.

  • 1.0.7
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

Description:

This package is a plugin for esbuild. When used, it will look for a .env file in the current project file's directory, or any parent, until it finds one. It will combine the found .env variables with the system-wide process.env variables, which can all be used from the project file. It uses the 'dotenv' package to parse the .env file (the package isn't loaded into your project, only into the esbuild script).

Installation:

npm install esbuild esbuild-envfile-plugin dotenv --save-dev

In esbuild script:

const envFilePlugin = require('esbuild-envfile-plugin');

require('esbuild').build({
    plugins: [envFilePlugin]
});

Usage in project:

import { SOME_ENV_VARIABLE } from 'env';
// or:
import * as env from 'env';
//env.SOME_ENV_VARIABLE;

Example esbuild script:

// Config: relative to where npm command is run:
const APP_BASE = 'src';
const ENTRY_FILE = 'index.ts';
const OUTPUT_DIR = 'build';
const OUTPUT_FILE = 'app.js';
const IS_DEV = true;
const TARGET = 'es2018';

function build(entryFile, outFile) {
    require('esbuild').build({
        entryPoints: [entryFile],
        outfile: outFile,
        platform: 'node',
        bundle: true,
        define: { "process.env.NODE_ENV": IS_DEV ? "\"development\"" : "\"product\"" },
        target: TARGET,
        logLevel: 'silent',
        plugins: [envFilePlugin]   // <**************** USAGE ****************
    })
    .then(r => { console.log("Build succeeded.") })
    .catch((e) => {
        console.log("Error building:", e.message);
        process.exit(1)
    })
}

build(`${APP_BASE}/${ENTRY_FILE}`, `${OUTPUT_DIR}/${OUTPUT_FILE}`);

Keywords

FAQs

Package last updated on 08 May 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc