Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eliasgcf/typeenv
⚙️ With this command you can create the Type definitions for an .env file
https://github.com/eliasgcf/typeenv
dotenv env oclif typescript
Last synced: 16 days ago
JSON representation
⚙️ With this command you can create the Type definitions for an .env file
- Host: GitHub
- URL: https://github.com/eliasgcf/typeenv
- Owner: EliasGcf
- License: mit
- Created: 2020-06-20T00:17:35.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T19:18:06.000Z (almost 2 years ago)
- Last Synced: 2024-10-04T16:12:59.132Z (about 1 month ago)
- Topics: dotenv, env, oclif, typescript
- Language: TypeScript
- Homepage:
- Size: 214 KB
- Stars: 13
- Watchers: 2
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typeEnv
create a .d.ts file to your .env file
[](https://oclif.io)
Without a Type definition |
With a Type definition |
Getting started |
How to contribute |
License
## Without a Type definition
## With a Type definition
## ⚙️ Getting Started
### Requirements
- [Node.js](https://nodejs.org/en/)
- [Yarn](https://classic.yarnpkg.com/) or [npm](https://www.npmjs.com/)
### Instalation
```bash
$ yarn global add @eliasgcf/type-env
# or
$ npm install -g @eliasgcf/type-env
```
## ⚡ Usage
### Path
> create the env.d.ts inside another folder: --path/-p
```bash
$ typeEnv --path=src/my-types
```
---
### File
> change the default env file (.env): --file/-f
```bash
$ typeEnv --file .other.env
```
---
### Show
> just show the results and not create the d.ts file: --show/-s
```bash
$ typeEnv --show
```
### Config
> You can now check the settings for each environment, be it with typescript or javascript.
```bash
$ typeEnv -c ts
# or
$ typeEnv -c js
```
## 🤔 How to contribute
**Make a fork of this repository**
```bash
# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.
$ gh repo fork EliasGcf/typeEnv
```
**Follow the steps below**
```bash
# Clone your fork
$ git clone your-fork-url && cd typeEnv
# Create a branch with your feature
$ git checkout -b my-feature
# Make the commit with your changes
$ git commit -m 'feat: My new feature'
# Send the code to your remote branch
$ git push origin my-feature
```
After your pull request is merged, you can delete your branch
## 📝 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
Made with 💜 by Elias Gabriel 👋 [See my linkedin](https://www.linkedin.com/in/eliasgcf/)