forked from coop-cloud-mirrors/godotenv
Compare commits
1 Commits
fix-godoc-
...
go-modules
Author | SHA1 | Date | |
---|---|---|---|
9eb454e589 |
10
.github/dependabot.yml
vendored
10
.github/dependabot.yml
vendored
@ -1,10 +0,0 @@
|
|||||||
version: 2
|
|
||||||
updates:
|
|
||||||
- package-ecosystem: "gomod"
|
|
||||||
directory: /
|
|
||||||
schedule:
|
|
||||||
interval: "daily"
|
|
||||||
- package-ecosystem: "github-actions"
|
|
||||||
directory: "/"
|
|
||||||
schedule:
|
|
||||||
interval: "daily"
|
|
9
.github/workflows/ci.yml
vendored
9
.github/workflows/ci.yml
vendored
@ -3,18 +3,17 @@ name: CI
|
|||||||
on: [push]
|
on: [push]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
test:
|
build:
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
matrix:
|
||||||
go: [ '1.18', '1.17', '1.16', '1.15' ]
|
go: [ '1.15', '1.14' ]
|
||||||
os: [ ubuntu-latest, macOS-latest, windows-latest ]
|
os: [ ubuntu-latest, macOS-latest, windows-latest ]
|
||||||
name: ${{ matrix.os }} Go ${{ matrix.go }} Tests
|
name: ${{ matrix.os }} Go ${{ matrix.go }} Tests
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v2
|
||||||
- name: Setup go
|
- name: Setup go
|
||||||
uses: actions/setup-go@v3
|
uses: actions/setup-go@v2
|
||||||
with:
|
with:
|
||||||
go-version: ${{ matrix.go }}
|
go-version: ${{ matrix.go }}
|
||||||
- run: go test
|
- run: go test
|
72
.github/workflows/codeql-analysis.yml
vendored
72
.github/workflows/codeql-analysis.yml
vendored
@ -1,72 +0,0 @@
|
|||||||
# For most projects, this workflow file will not need changing; you simply need
|
|
||||||
# to commit it to your repository.
|
|
||||||
#
|
|
||||||
# You may wish to alter this file to override the set of languages analyzed,
|
|
||||||
# or to provide custom queries or build logic.
|
|
||||||
#
|
|
||||||
# ******** NOTE ********
|
|
||||||
# We have attempted to detect the languages in your repository. Please check
|
|
||||||
# the `language` matrix defined below to confirm you have the correct set of
|
|
||||||
# supported CodeQL languages.
|
|
||||||
#
|
|
||||||
name: "CodeQL"
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [ "main" ]
|
|
||||||
pull_request:
|
|
||||||
# The branches below must be a subset of the branches above
|
|
||||||
branches: [ "main" ]
|
|
||||||
schedule:
|
|
||||||
- cron: '31 4 * * 2'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
analyze:
|
|
||||||
name: Analyze
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
actions: read
|
|
||||||
contents: read
|
|
||||||
security-events: write
|
|
||||||
|
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
language: [ 'go' ]
|
|
||||||
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
|
|
||||||
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checkout repository
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
|
|
||||||
# Initializes the CodeQL tools for scanning.
|
|
||||||
- name: Initialize CodeQL
|
|
||||||
uses: github/codeql-action/init@v2
|
|
||||||
with:
|
|
||||||
languages: ${{ matrix.language }}
|
|
||||||
# If you wish to specify custom queries, you can do so here or in a config file.
|
|
||||||
# By default, queries listed here will override any specified in a config file.
|
|
||||||
# Prefix the list here with "+" to use these queries and those in the config file.
|
|
||||||
|
|
||||||
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
|
|
||||||
# queries: security-extended,security-and-quality
|
|
||||||
|
|
||||||
|
|
||||||
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
|
|
||||||
# If this step fails, then you should remove it and run the build manually (see below)
|
|
||||||
- name: Autobuild
|
|
||||||
uses: github/codeql-action/autobuild@v2
|
|
||||||
|
|
||||||
# ℹ️ Command-line programs to run using the OS shell.
|
|
||||||
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
|
|
||||||
|
|
||||||
# If the Autobuild fails above, remove it and uncomment the following three lines.
|
|
||||||
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
|
|
||||||
|
|
||||||
# - run: |
|
|
||||||
# echo "Run, Build Application using script"
|
|
||||||
# ./location_of_script_within_repo/buildscript.sh
|
|
||||||
|
|
||||||
- name: Perform CodeQL Analysis
|
|
||||||
uses: github/codeql-action/analyze@v2
|
|
31
.github/workflows/release.yml
vendored
31
.github/workflows/release.yml
vendored
@ -1,31 +0,0 @@
|
|||||||
on:
|
|
||||||
push:
|
|
||||||
tags:
|
|
||||||
- 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
|
|
||||||
|
|
||||||
name: Upload Release Assets
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
name: Upload Release Assets
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
- name: Generate build files
|
|
||||||
uses: thatisuday/go-cross-build@v1.0.2
|
|
||||||
with:
|
|
||||||
platforms: 'linux/amd64, linux/ppc64le, darwin/amd64, darwin/arm64, windows/amd64'
|
|
||||||
package: 'cmd/godotenv'
|
|
||||||
name: 'godotenv'
|
|
||||||
compress: 'true'
|
|
||||||
dest: 'dist'
|
|
||||||
- name: Publish Binaries
|
|
||||||
uses: svenstaro/upload-release-action@v2
|
|
||||||
with:
|
|
||||||
repo_token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
release_name: Release ${{ github.ref }}
|
|
||||||
tag: ${{ github.ref }}
|
|
||||||
file: dist/*
|
|
||||||
file_glob: true
|
|
||||||
overwrite: true
|
|
32
README.md
32
README.md
@ -1,6 +1,6 @@
|
|||||||
# GoDotEnv  [](https://goreportcard.com/report/github.com/joho/godotenv)
|
# GoDotEnv  [](https://goreportcard.com/report/github.com/joho/godotenv)
|
||||||
|
|
||||||
A Go (golang) port of the Ruby [dotenv](https://github.com/bkeepers/dotenv) project (which loads env vars from a .env file).
|
A Go (golang) port of the Ruby dotenv project (which loads env vars from a .env file)
|
||||||
|
|
||||||
From the original Library:
|
From the original Library:
|
||||||
|
|
||||||
@ -8,9 +8,9 @@ From the original Library:
|
|||||||
>
|
>
|
||||||
> But it is not always practical to set environment variables on development machines or continuous integration servers where multiple projects are run. Dotenv load variables from a .env file into ENV when the environment is bootstrapped.
|
> But it is not always practical to set environment variables on development machines or continuous integration servers where multiple projects are run. Dotenv load variables from a .env file into ENV when the environment is bootstrapped.
|
||||||
|
|
||||||
It can be used as a library (for loading in env for your own daemons etc.) or as a bin command.
|
It can be used as a library (for loading in env for your own daemons etc) or as a bin command.
|
||||||
|
|
||||||
There is test coverage and CI for both linuxish and Windows environments, but I make no guarantees about the bin version working on Windows.
|
There is test coverage and CI for both linuxish and windows environments, but I make no guarantees about the bin version working on windows.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@ -21,13 +21,6 @@ go get github.com/joho/godotenv
|
|||||||
```
|
```
|
||||||
|
|
||||||
or if you want to use it as a bin command
|
or if you want to use it as a bin command
|
||||||
|
|
||||||
go >= 1.17
|
|
||||||
```shell
|
|
||||||
go install github.com/joho/godotenv/cmd/godotenv@latest
|
|
||||||
```
|
|
||||||
|
|
||||||
go < 1.17
|
|
||||||
```shell
|
```shell
|
||||||
go get github.com/joho/godotenv/cmd/godotenv
|
go get github.com/joho/godotenv/cmd/godotenv
|
||||||
```
|
```
|
||||||
@ -47,10 +40,9 @@ Then in your Go app you can do something like
|
|||||||
package main
|
package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"github.com/joho/godotenv"
|
||||||
"log"
|
"log"
|
||||||
"os"
|
"os"
|
||||||
|
|
||||||
"github.com/joho/godotenv"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
@ -171,17 +163,9 @@ content, err := godotenv.Marshal(env)
|
|||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Contributions are welcome, but with some caveats.
|
Contributions are most welcome! The parser itself is pretty stupidly naive and I wouldn't be surprised if it breaks with edge cases.
|
||||||
|
|
||||||
This library has been declared feature complete (see [#182](https://github.com/joho/godotenv/issues/182) for background) and will not be accepting issues or pull requests adding new functionality or breaking the library API.
|
*code changes without tests will not be accepted*
|
||||||
|
|
||||||
Contributions would be gladly accepted that:
|
|
||||||
|
|
||||||
* bring this library's parsing into closer compatibility with the mainline dotenv implementations, in particular [Ruby's dotenv](https://github.com/bkeepers/dotenv) and [Node.js' dotenv](https://github.com/motdotla/dotenv)
|
|
||||||
* keep the library up to date with the go ecosystem (ie CI bumps, documentation changes, changes in the core libraries)
|
|
||||||
* bug fixes for use cases that pertain to the library's purpose of easing development of codebases deployed into twelve factor environments
|
|
||||||
|
|
||||||
*code changes without tests and references to peer dotenv implementations will not be accepted*
|
|
||||||
|
|
||||||
1. Fork it
|
1. Fork it
|
||||||
2. Create your feature branch (`git checkout -b my-new-feature`)
|
2. Create your feature branch (`git checkout -b my-new-feature`)
|
||||||
@ -195,6 +179,10 @@ Releases should follow [Semver](http://semver.org/) though the first couple of r
|
|||||||
|
|
||||||
Use [annotated tags for all releases](https://github.com/joho/godotenv/issues/30). Example `git tag -a v1.2.1`
|
Use [annotated tags for all releases](https://github.com/joho/godotenv/issues/30). Example `git tag -a v1.2.1`
|
||||||
|
|
||||||
|
## CI
|
||||||
|
|
||||||
|
Linux: [](https://travis-ci.org/joho/godotenv) Windows: [](https://ci.appveyor.com/project/joho/godotenv)
|
||||||
|
|
||||||
## Who?
|
## Who?
|
||||||
|
|
||||||
The original library [dotenv](https://github.com/bkeepers/dotenv) was written by [Brandon Keepers](http://opensoul.org/), and this port was done by [John Barton](https://johnbarton.co/) based off the tests/fixtures in the original library.
|
The original library [dotenv](https://github.com/bkeepers/dotenv) was written by [Brandon Keepers](http://opensoul.org/), and this port was done by [John Barton](https://johnbarton.co/) based off the tests/fixtures in the original library.
|
||||||
|
26
godotenv.go
26
godotenv.go
@ -1,6 +1,6 @@
|
|||||||
// Package godotenv is a go port of the ruby dotenv library (https://github.com/bkeepers/dotenv)
|
// Package godotenv is a go port of the ruby dotenv library (https://github.com/bkeepers/dotenv)
|
||||||
//
|
//
|
||||||
// Examples/readme can be found on the GitHub page at https://github.com/joho/godotenv
|
// Examples/readme can be found on the github page at https://github.com/joho/godotenv
|
||||||
//
|
//
|
||||||
// The TL;DR is that you make a .env file that looks something like
|
// The TL;DR is that you make a .env file that looks something like
|
||||||
//
|
//
|
||||||
@ -30,15 +30,15 @@ const doubleQuoteSpecialChars = "\\\n\r\"!$`"
|
|||||||
|
|
||||||
// Load will read your env file(s) and load them into ENV for this process.
|
// Load will read your env file(s) and load them into ENV for this process.
|
||||||
//
|
//
|
||||||
// Call this function as close as possible to the start of your program (ideally in main).
|
// Call this function as close as possible to the start of your program (ideally in main)
|
||||||
//
|
//
|
||||||
// If you call Load without any args it will default to loading .env in the current path.
|
// If you call Load without any args it will default to loading .env in the current path
|
||||||
//
|
//
|
||||||
// You can otherwise tell it which files to load (there can be more than one) like:
|
// You can otherwise tell it which files to load (there can be more than one) like
|
||||||
//
|
//
|
||||||
// godotenv.Load("fileone", "filetwo")
|
// godotenv.Load("fileone", "filetwo")
|
||||||
//
|
//
|
||||||
// It's important to note that it WILL NOT OVERRIDE an env variable that already exists - consider the .env file to set dev vars or sensible defaults.
|
// It's important to note that it WILL NOT OVERRIDE an env variable that already exists - consider the .env file to set dev vars or sensible defaults
|
||||||
func Load(filenames ...string) (err error) {
|
func Load(filenames ...string) (err error) {
|
||||||
filenames = filenamesOrDefault(filenames)
|
filenames = filenamesOrDefault(filenames)
|
||||||
|
|
||||||
@ -53,15 +53,15 @@ func Load(filenames ...string) (err error) {
|
|||||||
|
|
||||||
// Overload will read your env file(s) and load them into ENV for this process.
|
// Overload will read your env file(s) and load them into ENV for this process.
|
||||||
//
|
//
|
||||||
// Call this function as close as possible to the start of your program (ideally in main).
|
// Call this function as close as possible to the start of your program (ideally in main)
|
||||||
//
|
//
|
||||||
// If you call Overload without any args it will default to loading .env in the current path.
|
// If you call Overload without any args it will default to loading .env in the current path
|
||||||
//
|
//
|
||||||
// You can otherwise tell it which files to load (there can be more than one) like:
|
// You can otherwise tell it which files to load (there can be more than one) like
|
||||||
//
|
//
|
||||||
// godotenv.Overload("fileone", "filetwo")
|
// godotenv.Overload("fileone", "filetwo")
|
||||||
//
|
//
|
||||||
// It's important to note this WILL OVERRIDE an env variable that already exists - consider the .env file to forcefully set all vars.
|
// It's important to note this WILL OVERRIDE an env variable that already exists - consider the .env file to forcefilly set all vars.
|
||||||
func Overload(filenames ...string) (err error) {
|
func Overload(filenames ...string) (err error) {
|
||||||
filenames = filenamesOrDefault(filenames)
|
filenames = filenamesOrDefault(filenames)
|
||||||
|
|
||||||
@ -124,7 +124,7 @@ func Parse(r io.Reader) (envMap map[string]string, err error) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Unmarshal reads an env file from a string, returning a map of keys and values.
|
//Unmarshal reads an env file from a string, returning a map of keys and values.
|
||||||
func Unmarshal(str string) (envMap map[string]string, err error) {
|
func Unmarshal(str string) (envMap map[string]string, err error) {
|
||||||
return Parse(strings.NewReader(str))
|
return Parse(strings.NewReader(str))
|
||||||
}
|
}
|
||||||
@ -132,7 +132,7 @@ func Unmarshal(str string) (envMap map[string]string, err error) {
|
|||||||
// Exec loads env vars from the specified filenames (empty map falls back to default)
|
// Exec loads env vars from the specified filenames (empty map falls back to default)
|
||||||
// then executes the cmd specified.
|
// then executes the cmd specified.
|
||||||
//
|
//
|
||||||
// Simply hooks up os.Stdin/err/out to the command and calls Run().
|
// Simply hooks up os.Stdin/err/out to the command and calls Run()
|
||||||
//
|
//
|
||||||
// If you want more fine grained control over your command it's recommended
|
// If you want more fine grained control over your command it's recommended
|
||||||
// that you use `Load()` or `Read()` and the `os/exec` package yourself.
|
// that you use `Load()` or `Read()` and the `os/exec` package yourself.
|
||||||
@ -146,7 +146,7 @@ func Exec(filenames []string, cmd string, cmdArgs []string) error {
|
|||||||
return command.Run()
|
return command.Run()
|
||||||
}
|
}
|
||||||
|
|
||||||
// Write serializes the given environment and writes it to a file.
|
// Write serializes the given environment and writes it to a file
|
||||||
func Write(envMap map[string]string, filename string) error {
|
func Write(envMap map[string]string, filename string) error {
|
||||||
content, err := Marshal(envMap)
|
content, err := Marshal(envMap)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@ -157,7 +157,7 @@ func Write(envMap map[string]string, filename string) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
defer file.Close()
|
defer file.Close()
|
||||||
_, err = file.WriteString(content + "\n")
|
_, err = file.WriteString(content)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
@ -131,7 +131,7 @@ func TestLoadDoesNotOverride(t *testing.T) {
|
|||||||
loadEnvAndCompareValues(t, Load, envFileName, expectedValues, presets)
|
loadEnvAndCompareValues(t, Load, envFileName, expectedValues, presets)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestOverloadDoesOverride(t *testing.T) {
|
func TestOveroadDoesOverride(t *testing.T) {
|
||||||
envFileName := "fixtures/plain.env"
|
envFileName := "fixtures/plain.env"
|
||||||
|
|
||||||
// ensure NO overload
|
// ensure NO overload
|
||||||
@ -325,11 +325,11 @@ func TestParsing(t *testing.T) {
|
|||||||
// expect(env('FOO="bar\nbaz"')).to eql('FOO' => "bar\nbaz")
|
// expect(env('FOO="bar\nbaz"')).to eql('FOO' => "bar\nbaz")
|
||||||
parseAndCompare(t, `FOO="bar\nbaz"`, "FOO", "bar\nbaz")
|
parseAndCompare(t, `FOO="bar\nbaz"`, "FOO", "bar\nbaz")
|
||||||
|
|
||||||
// it 'parses variables with "." in the name' do
|
// it 'parses varibales with "." in the name' do
|
||||||
// expect(env('FOO.BAR=foobar')).to eql('FOO.BAR' => 'foobar')
|
// expect(env('FOO.BAR=foobar')).to eql('FOO.BAR' => 'foobar')
|
||||||
parseAndCompare(t, "FOO.BAR=foobar", "FOO.BAR", "foobar")
|
parseAndCompare(t, "FOO.BAR=foobar", "FOO.BAR", "foobar")
|
||||||
|
|
||||||
// it 'parses variables with several "=" in the value' do
|
// it 'parses varibales with several "=" in the value' do
|
||||||
// expect(env('FOO=foobar=')).to eql('FOO' => 'foobar=')
|
// expect(env('FOO=foobar=')).to eql('FOO' => 'foobar=')
|
||||||
parseAndCompare(t, "FOO=foobar=", "FOO", "foobar=")
|
parseAndCompare(t, "FOO=foobar=", "FOO", "foobar=")
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user