Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/artginzburg/dotenv-extended-prepare
:package: Auto-creating .env files based on .env.defaults and .env.schema from dotenv-extended
https://github.com/artginzburg/dotenv-extended-prepare
environment npm
Last synced: 3 months ago
JSON representation
:package: Auto-creating .env files based on .env.defaults and .env.schema from dotenv-extended
- Host: GitHub
- URL: https://github.com/artginzburg/dotenv-extended-prepare
- Owner: artginzburg
- License: mit
- Created: 2021-08-08T17:34:08.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-25T19:50:45.000Z (over 2 years ago)
- Last Synced: 2024-07-22T03:03:17.171Z (4 months ago)
- Topics: environment, npm
- Language: TypeScript
- Homepage: https://npm.im/dotenv-extended-prepare
- Size: 55.7 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [dotenv-extended](https://www.npmjs.com/package/dotenv-extended)-prepare
[](# 'zero dependency')
[](https://github.com/artginzburg/dotenv-extended-prepare/actions/workflows/test.yml)
Protects developers from manually doing boring stuff — isn't that what we're here for?
Just run it on a cloned repo, and `.env` preset will be sitting in the top-level directory for you to fill it.
> .env is created based on `.env.defaults` and `.env.schema`
## Preview
```ps1
NODE_ENV=
# PORT=
# npm_package_name=
TOKEN=
```
> Variables from `.env.defaults` are taken as _optional_ — commented out with `#` on line start.
> The `.env.schema` variables definitely want you to **fill them** in.
## Quick start
### For personal usage
Simply run it after cloning another genius repo telling you to scrap around the files looking for variable names
```ps1
npx dotenv-extended-prepare
```
### For automatically respecting the time of other developers
1. Install `dotenv-extended-prepare` as a development dependency:
```ps1
npm i -D dotenv-extended-prepare
```
2. Specify a `postinstall` script in your package file — it will run on `npm i`
> e.g. `"scripts": { "postinstall": "dotenv-extended-prepare" }` in package.json
```ps1
npm set-script postinstall "dotenv-extended-prepare"
```
#### TODO
> If you need to specify a custom path or name to schemas/defaults, or you don't use `dotenv-extended` at all, or you prefer using regular OG `dotenv` like our grandpas did and your env sample is named `.env.example` — just wait a couple of days. I'm planning to add more names for auto-search and some configuration.
## Experimental
Auto-generate `.env.schema` if a repo doesn't specify one
> In the future, we could make it also generate .env.defaults
```ps1
npx dotenv-extended-prepare generate
```
## Why?
I like high development convenience. Almost every new project has its .env schemas/examples/samples or defaults. Usually, after cloning a new repository, the developer has to not just enter environment variables, but also search for their names, check which ones are already set by default and create an .env file.
This package is actively maintained. Give it a star, and maybe share some thoughts by opening an issue.
## Caught a Bug?
1. [Fork](https://help.github.com/articles/fork-a-repo/) this [repository](https://github.com/artginzburg/dotenv-extended-prepare/fork) to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device
2. Link the package to the global module directory: `npm link`
3. Within the Node app you want to test your local development instance of dotenv-extended-prepare, just link it to the dependencies: `npm link dotenv-extended-prepare` (Skip this step if you're using it via `npx` only). Instead of the default one from npm, Node.js will now use your clone of the tool!