Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bjarneo/dotenvjson

Convert .env files to JSON - Golang
https://github.com/bjarneo/dotenvjson

Last synced: 3 days ago
JSON representation

Convert .env files to JSON - Golang

Host: GitHub
URL: https://github.com/bjarneo/dotenvjson
Owner: bjarneo
License: mit
Created: 2022-07-08T19:52:18.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-09-08T11:56:03.000Z (about 1 year ago)
Last Synced: 2024-06-21T13:04:50.570Z (5 months ago)
Language: Go
Size: 322 KB
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# dotenvjson

Convert .env files to JSON. 📄

![dotenvjson](./dotenvjson.gif)

## About

I have used principles from creating a programming language to transform a .env file to JSON. It is kind of an tweaked approach, but works fine. 🔥

`This is overengineered`
Yes, I know. This is the fun factor. I am aware this can be solved in an easier way, but as many other things on github, I created this tool for fun in a way that is challenging.

Don't you go look at my messy tokenizer.go file 😏

## Usage

```bash
dotenvjson -h
Usage of dotenvjson:
-o string Save the output to file. -o=file.json
-p bool Pretty print the output. (default false)
-pt bool Print to terminal. (default true)
-y bool Transform it to YAML
-kv string Define the key-value pair. -kv=name,value. (default "")
```

## Build

```bash
go build -o bin/dotenvjson
```

## Releases

Have a look at the releases page for binaries.

## Example

```bash
###############################
# .env.example content #
###############################
cat .env.example

# Environment variables.
STATUS=production
#Development port
DEV_PORT=1337
# Production port
PROD_PORT=8080

# DB CONFIG
HOST=db.host
USER=root
PASSWORD=betterlucknexttime!
DB =hackers_exposed
DIALECT = mysql # wow working comment

WOW = "such nice # work"

INTERPOLATED="Multiple\nLines and variable substitution: ${SIMPLE}"
NON_INTERPOLATED='raw text without variable interpolation'

JSON='{"key":"value","nested":{"key":"value"},"number":1}'

###############################
# Now run the transformation #
###############################
dotenvjson -p -o=demo.json .env.example

# or pipe the data such as this:
# cat .env.example | dotenvjson -p -o=demo.json
{
"DB": "hackers_exposed",
"DEV_PORT": "1337",
"DIALECT": "mysql",
"HOST": "db.host",
"INTERPOLATED": "\"Multiple\\nLines and variable substitution: ${SIMPLE}\"",
"JSON": "'{\"key\":\"value\",\"nested\":{\"key\":\"value\"},\"number\":1}'",
"NON_INTERPOLATED": "'raw text without variable interpolation'",
"PASSWORD": "betterlucknexttime!",
"PROD_PORT": "8080",
"STATUS": "production",
"USER": "root",
"WOW": "\"such nice # work\""
}

###############################
# demo.json content #
###############################
cat demo.json
{
"DB": "hackers_exposed",
"DEV_PORT": "1337",
"DIALECT": "mysql",
"HOST": "db.host",
"INTERPOLATED": "\"Multiple\\nLines and variable substitution: ${SIMPLE}\"",
"JSON": "'{\"key\":\"value\",\"nested\":{\"key\":\"value\"},\"number\":1}'",
"NON_INTERPOLATED": "'raw text without variable interpolation'",
"PASSWORD": "betterlucknexttime!",
"PROD_PORT": "8080",
"STATUS": "production",
"USER": "root",
"WOW": "\"such nice # work\""
}

###############################
# Transform to YAML #
###############################
cat .env.example | dotenvjson -y

DB: hackers_exposed
DEV_PORT: 1337
DIALECT: mysql
HOST: db.host
INTERPOLATED: '"Multiple\nLines and variable substitution: ${SIMPLE}"'
JSON: '''{"key":"value","nested":{"key":"value"},"number":1}'''
NON_INTERPOLATED: '''raw text without variable interpolation'''
PASSWORD: betterlucknexttime!
PROD_PORT: 8080
STATUS: production
USER: root
WOW: '"such nice # work"'

###################################
# Define your own key value pairs #
###################################
dotenvjson -kv=name,value -p .env.example

[
{
"name": "NON_INTERPOLATED",
"value": "'raw text without variable interpolation'"
},
{
"name": "PROD_PORT",
"value": 8080
},
{
"name": "USER",
"value": "root"
},
{
"name": "PASSWORD",
"value": "betterlucknexttime!"
},
{
"name": "DB",
"value": "hackers_exposed"
},
{
"name": "WOW",
"value": "\"such nice # work\""
},
{
"name": "INTERPOLATED",
"value": "\"Multiple\\nLines and variable substitution: ${SIMPLE}\""
},
{
"name": "STATUS",
"value": "production"
},
{
"name": "DEV_PORT",
"value": 1337
},
{
"name": "TRY_ME",
"value": "12woop"
},
{
"name": "HOST",
"value": "db.host"
},
{
"name": "DIALECT",
"value": "mysql"
},
{
"name": "JSON",
"value": "'{\"key\":\"value\",\"nested\":{\"key\":\"value\"},\"number\":1}'"
}
]
```

## Missing, but coming

- multiline parsing support

## License

See [LICENSE](LICENSE)