mrsauravsahu / gen-env-template Goto Github PK

View Code? Open in Web Editor NEW

14.0 3.0 4.0 816 KB

Generate documentation for your environment variables

Home Page: https://npmjs.com/gen-env-template

License: MIT License

JavaScript 98.20% Shell 1.17% Dockerfile 0.63%

environment-variables dotenv env highlighted

gen-env-template's Introduction

gen-env-template

Generate template .env.example file from your .env file.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Saurav Sahu}
💻

_{Abishek Aditya}
🐛

_{Ram Prasad Agarwal}
💻

_{Tobias Büschel}
📖

Why?

A well documented template .env file helps set up the app.

How to use?

This package exposes both a CLI and an SDK.

CLI Usage

Install the tool

You can install gen-env-template as a devDependency.

$ npm i -D gen-env-template

$ pnpm i -D gen-env-template

$ yarn add --dev gen-env-template

You can now use the command like so:

$ ./node_modules/.bin/gen-env-template [path to input .env]=.env [path to output .env]=.env.example

Usage with npx:

$ npx gen-env-template [path to input .env]=.env [path to output .env]=.env.example

(genv is a shorthand command which can be used interchangeably.)

This will write the output to the path specified.

SDK Usage

The main import exposes a function with takes in the string contents of the .env file and returns the template string output

const genEnvTemplate = require('gen-env-template')

const inputString = 'NODE_ENV=development'

console.log(genEnvTemplate(inputString))

>> NODE_ENV=

Licensing

This project uses the MIT license as explained here.

Contributing

This project is Open-Source and I'm happy to hear feedback and receive improvements through Issues and PRs. For quick response, I'm the most active on twitter @mrsauravsahu

This project follows the all-contributors specification. Contributions of any kind welcome!

What's new? 🎉 🥳

v2.1.1 - Audit fixes and dependency updates
v2.1.0 - Improv: Ability to read multiline variables
v2.0.7 - Feat: Ability to remove region comments #region safe, #endregion safe
v2.0.6 - CI: Improvement (Use matrix builds to test on Windows, Linux and Mac)
v2.0.5 - Fix npm audit issues & bump node version
v2.0.4 - Update npm dependencies
v2.0.3 - Fix @oclif/command not found - move to dependencies
v2.0.2 - Bump all npm package versions
v2.0.1 - NPM audit fixes
v2.0.0 - Add format -f switch. Generate template-env or markdown format
v1.0.10 - Preserve LF or CRLF line endings from the input env file
v1.0.9 - Add -d or --dry-run switch to output to console
v1.0.8 - Remove whitespaces around key
v1.0.7 - Add safe region to keep sample values
v1.0.6 - Create CLI with OCLIF
v1.0.5 - Add alias command genv
v1.0.4 - Use gen-env-template through npx or pnpx
v1.0.3 - No usage change. Setup CI/CD
v1.0.2 - Trim bundle by ignoring files in .npmignore
v1.0.0 - Basic template generator

gen-env-template's People

Contributors

Stargazers

Watchers

Forkers

meloncola sachin-kumar-ik8 tobiasbueschel

gen-env-template's Issues

Add a workflow to publish to npmjs

Feat: Provide a POSIX compliant CLI interface

http://www.iitk.ac.in/esc101/05Aug/tutorial/essential/attributes/_posix.html

BUG: Variables with breakline isn't supported

In my .env file, I have a few private keys that require a line break in order to work with my server:

PRIVATE_KEY="-----BEGIN PRIVATE KEY-----
129812791827981whatheveristhevaluehere91092381029830192/
etc"

When I gen-env-template .env .env.example the output is

PRIVATE_KEY=
129812791827981whatheveristhevaluehere91092381029830192/
etc

When I expect

PRIVATE_KEY=

Test: If package works for malformed .env files

Enhancement: Ability to generate Markdown tables for ENV documentation

Currently the template file works great, but if we could generate markdown strings, this can be programmatically added to readme files like a table, similar to how allcontributors bot injects markdown.

Ignore unnecessary files when publishing

Docs: Update Readme to show how to use Safe Regions

Feat: Add an alias command

gen-env-template is too wordy 😫 genv is a good alias.

Feat: Ability to remove #region comments from the output template.envrc

Test: If the package works on Windows (native)

Install and test if the package works for Windows; which has node installed natively.

Using gen-env-template as a CLI causes an Error: Cannot find module '@oclif/command'

This can be fixed by making @oclif/command be a required dependency(or maybe just make it documented as people who don't use the CLI won't need it?), although I'm unsure if it's meant to actually end up being included or not.

In the mean time, I've created a fork which moves the dependency over and works: https://github.com/MelonCola/gen-env-template
Not sure if I should make a PR for this as I'm really not sure if this is the correct move to fix the issue.

Edit: Actually looks as though the full fleet of oclif packages might be necessary. Guess I didn't properly remove them all when testing.

Feat: Ability to retain values for certain keys

Some key=value pairs are supposed to have values in template files. They have safe values and can be committed to source control.

I have a couple of ideas for this.

Option 1

Use named regions in the .env file to mark that an area in the file contains safe values. This is similar to regions in C# files

#region safe This region contains keys which are safe to be added to source control
NODE_ENV=development 

APP_KEY=randomvalue123
#endregion safe

API_KEY=1234567890

This would result in the following template file

#region safe This region contains keys which are safe to be added to source control
NODE_ENV=development 

APP_KEY=randomvalue123
#endregion safe

API_KEY=

Option 2

This adds an -s flag in the CLI command to accept keys which are safe.

Given the following .env file below,

NODE_ENV=development 

APP_KEY=randomvalue123

API_KEY=1234567890

We can use $ genv .env template.env -s 'API_KEY' to achieve the same template as shown in Option 1's example.

Test: If the Package works with .envrc files

Test if the package will work with .envrc files - this is for files which are used by direnv

Error when running through npx

OS: macOS
node: 14.16.1

Trying to run the command through npx gives a command not found. 🤔

➜ npx gen-env-template .env template.env
npx: command not found: gen-env-template

# region safe

set -a

K8S_NAMESPACE=local

set +a

# endregion

generates

# region safe

set -a=set -a

K8S_NAMESPACE=local

set +a=set +a 

# endregion

set +a=set +a line is wrong.

Improv: As a user, I should be able to get warnings about environment variables I’ve skipped in my .env file

Description: Option to pass source control root directory and code language, and genv will earn any missing env variables from the .env file.

Experimental feature coming in 2.1.0-alpha.x releases

Enhanc: Configure whether or not to write empty quotes for variables in the template

Do not break current behavior of no-quotes by default.

Error Handling: When input file is missing

Write better error message.

Scenario: .env file has both CLRF and LF line endings

Questions

If one of the lines was copy pasted with \r\n and other lines are \n. should it be treated as malformed or should it be fixed?

Proposed Solution

use regex to split based on (\r\n|\n)