1.0.0 • Published 2 years ago

@ryniaubenpm2/saepe-corporis-ullam

Licence

MIT

Version

1.0.0

Deps

Size

22 kB

Vulns

Weekly

Summary Dependency Versions

announcing dotenvx. run anywhere, multi-environment, encrypted envs.

^{Dotenv libraries are supported by the community.}

^{Special thanks to:}

Warp is a blazingly fast, Rust-based terminal reimagined to work like a modern app.

^{Get more done in the CLI with real text editing, block-based output, and AI command search.}

Your App, Enterprise Ready.

^{Add Single Sign-On, Multi-Factor Auth, and more, in minutes instead of months.}

Launch user-facing integrations faster

^{Easily spin up hundreds of integrations. Sign up free or read our docs first}

@ryniaubenpm2/saepe-corporis-ullam

Dotenv-expand adds variable expansion on top of dotenv. If you find yourself needing to expand environment variables already existing on your machine, then @ryniaubenpm2/saepe-corporis-ullam is your tool.

Install

# Install locally (recommended)
npm install @ryniaubenpm2/saepe-corporis-ullam --save

Or installing with yarn? yarn add @ryniaubenpm2/saepe-corporis-ullam

Usage

Create a .env file in the root of your project:

PASSWORD="s1mpl3"
DB_PASS=$PASSWORD

As early as possible in your application, import and configure dotenv and then expand dotenv:

const dotenv = require('dotenv')
const dotenvExpand = require('@ryniaubenpm2/saepe-corporis-ullam')

dotenvExpand.expand(dotenv.config())

console.log(process.env) // remove this after you've confirmed it is expanding

That's it. process.env now has the expanded keys and values you defined in your .env file.

dotenvExpand.expand(dotenv.config())

...

connectdb(process.env.DB_PASS)

Preload

Note: Consider using dotenvx instead of preloading. I am now doing (and recommending) so.

It serves the same purpose (you do not need to require and load dotenv), has built-in expansion support, adds better debugging, and works with ANY language, framework, or platform. – motdotla

You can use the --require (-r) command line option to preload dotenv & @ryniaubenpm2/saepe-corporis-ullam. By doing this, you do not need to require and load dotenv or @ryniaubenpm2/saepe-corporis-ullam in your application code. This is the preferred approach when using import instead of require.

$ node -r @ryniaubenpm2/saepe-corporis-ullam/config your_script.js

The configuration options below are supported as command line arguments in the format dotenv_config_<option>=value

$ node -r @ryniaubenpm2/saepe-corporis-ullam/config your_script.js dotenv_config_path=/custom/path/to/your/env/vars

Additionally, you can use environment variables to set configuration options. Command line arguments will precede these.

$ DOTENV_CONFIG_<OPTION>=value node -r @ryniaubenpm2/saepe-corporis-ullam/config your_script.js

$ DOTENV_CONFIG_ENCODING=latin1 node -r @ryniaubenpm2/saepe-corporis-ullam/config your_script.js dotenv_config_path=/custom/path/to/.env

Examples

See tests/.env.test for simple and complex examples of variable expansion in your .env file.

Documentation

@ryniaubenpm2/saepe-corporis-ullam exposes one function:

expand

Expand

expand will expand your environment variables.

const env = {
  parsed: {
    BASIC: 'basic',
    BASIC_EXPAND: '${BASIC}',
    BASIC_EXPAND_SIMPLE: '$BASIC'
  }
}

console.log(dotenvExpand.expand(env))

Options

processEnv

Default: process.env

Specify an object to write your secrets to. Defaults to process.env environment variables.

const myEnv = {}
const env = {
  processEnv: myEnv,
  parsed: {
    HELLO: 'World'
  }
}
dotenvExpand.expand(env)

console.log(myEnv.HELLO) // World
console.log(process.env.HELLO) // undefined

FAQ

What rules does the expansion engine follow?

The expansion engine roughly has the following rules:

$KEY will expand any env with the name KEY
${KEY} will expand any env with the name KEY
\$KEY will escape the $KEY rather than expand
${KEY:-default} will first attempt to expand any env with the name KEY. If not one, then it will return default
${KEY-default} will first attempt to expand any env with the name KEY. If not one, then it will return default

You can see a full list of rules here.

How can I avoid expanding pre-existing envs (already in my `process.env`, for example `pas$word`)?

Modify your dotenv.config to write to an empty object and pass that to dotenvExpand.processEnv.

const dotenv = require('dotenv')
const dotenvExpand = require('@ryniaubenpm2/saepe-corporis-ullam')

const myEnv = dotenv.config({ processEnv: {} }) // prevent writing to `process.env`

dotenvExpand.expand(myEnv)

enumerable ava curl recursive install qs fastify react-hooks less compiler Object.assign code points callback swf eslint-plugin elb endpoint mru search RxJS node bundling internal slot ES2022 serialize hasOwnProperty Uint8ClampedArray mixins jQuery Streams Uint16Array interrupts pretty iterator walk watchFile elm findup s3 console deepclone typesafe uninstall ajv set postcss [[Prototype]]Underscore ECMAScript 2020 exec ES2021 sigint getopt es5 reuse value private data hasOwn bcrypt ses queue weakset jwt censor styling byte signals byteLength StyleSheet package toobject safe Array restful uuid iteration telephone vest URLSearchParams amazon Array.prototype.findLast superstruct spinner typeof immer env property speed deep-copy operating-system text gdpr dotenv state styleguide tslib worker from east-asian-width chrome terminal polyfill lesscss compile less tostringtag jsdiff pipe descriptor Observable ReactiveX l10n picomatch wordbreak parse sinatra shrinkwrap korean command-line sameValueZero superagent TypeScript remove Iterator last types crypto omit proto emoji es-shims entries byteOffset redact which ES formatting child Object.is ECMAScript 5 url proxy wordwrap define globals inference beanstalk rangeerror ES2018 promises Function.prototype.name helpers shared bundler glacier type loading setter commander deepcopy windows folder preprocessor plugin rfc4122 bind efficient fs core isConcatSpreadable walking mimetypes extra css variable rate vpc chai autoprefixer password auth group autoscaling predictable columns expression react-testing-library patch regexp stringify serializer @@toStringTag prune argparse rm -fr Microsoft fastcopy syntax regular expressions eventDispatcher util limited shim stdlib packages variables in css json move diff importexport validation weakmap await ES2017 hooks break compiler AsyncIterator urls is ECMAScript 2022 package manager less.js react own sharedarraybuffer BigUint64Array drop browserslist chinese persistent react-hook-form prototype functions es2016 process full mapreduce es2018 postcss-plugin identifiers io-ts lockfile cloudformation less mixins exit has-own handlers dom-testing-library middleware mime monorepo WebSockets styles form-validation es performance live extend toArray stream modules dataView object typedarrays consume xdg Int32Array linewrap matches take trimStart rm ec2 kinesis scheme-validation watch stable configurable streams number tty symlinks character mime-db minimal art collection storagegateway bluebird streams2 express Array.prototype.flatten sorted testing trimRight lru args assertion circular Float64Array pnpm9 Int8Array tdd limit setPrototypeOf look css-in-js ECMAScript 2021 asserts pyyaml jsdom fsevents accessor rapid zod fullwidth directory ratelimit jasmine watching serialization date argv term RFC-6455 Object.defineProperty arguments ES7 call-bind config command api protocol-buffers Symbol schema class-validator lazy input function jsonpath iterate duplex xterm macos findLastIndex exit-code whatwg jshint bootstrap css typedarray invariant find-up Promise escape Float32Array Array.prototype.flatMap ansi xdg-open aws valid name compare installer executable regular agent mocha match dynamodb css nesting generics ECMAScript 7 signal busy real-time findLast flag dayjs dataview -0 column channel assert parser Object.getPrototypeOf characters typeerror cloudwatch npm router computed-types queueMicrotask slice error Uint8Array promise irq tools framework performant URL values browser rds typanion parents dom estree settings listeners ascii logger preserve-symlinks flatten parent Object.entries sort Array.prototype.contains Push ArrayBuffer.prototype.slice electron unicode prop offset slot map eslint make Object.fromEntries events delete ebs matchAll rgb concurrency indicator ES2019 CSS metadata push structuredClone .env opener TypedArray joi batch concat TypeBox ECMAScript 2016 module wget assign ES5 regular expression debug fast-copy stylesheet ES2020 sigterm es8 eventEmitter ReactiveExtensions form clone route53 watcher authentication traverse Array.prototype.includes utility Symbol.toStringTag accessibility bound Rx banner style intrinsic tape description Array.prototype.findLastIndex stateless robust array awesomesauce error-handling classes styled-components js ES2015 util.inspect rmdir visual cloudtrail colour syntaxerror vars ast ECMAScript 2017 libphonenumber language width debugger path sham call sequence merge emr getPrototypeOf negative zero inspect mkdirp ArrayBuffer#slice Array.prototype.filter Reflect.getPrototypeOf tc39 logging multi-package encryption groupBy global read link WeakSet status ponyfill get require trim has _.extend ECMAScript 2015 ECMAScript 2019 i18n mkdirs negative classnames starter Object.keys deep look-up emit classname prefix WeakMap fast browserlist app yaml launch ECMAScript 2018 symbol equality obj buffers fixed-width Observables flux less css throttle open replay private write flatMap gradients css jest hookform resolve file css less cache touch jsx eslintconfig WebSocket 256 names ES2016 fetch full-width option writable toolkit runtime shebang optimist lint once properties file system yup hardlinks includes readable crypt request shell bootstrap less dependency manager 0 start mobile immutable YAML positive typed rest reducer side key filter BigInt64Array hot forms String.prototype.trim nope make dir website flat linux defineProperty random Object fast-deep-clone fastclone ES6 scheme keys cjk check throat readablestream css trimLeft string ECMAScript 6 arraybuffer ES2023 variables toSorted reduce spec deterministic xhr $.extend sqs call-bound toStringTag es-abstract parsing https exe environment getter chromium ender CSSStyleDeclaration log copy flags id

@ryniaubenpm2/saepe-corporis-ullam

@ryniaubenpm2/saepe-corporis-ullam

Install

Usage

Preload

Examples

Documentation

Expand

Options

processEnv

FAQ

What rules does the expansion engine follow?

How can I avoid expanding pre-existing envs (already in my `process.env`, for example `pas$word`)?

Contributing Guide

CHANGELOG

Who's using @ryniaubenpm2/saepe-corporis-ullam?

Keywords