mirror of
				https://github.com/joho/godotenv.git
				synced 2025-10-31 04:52:44 +00:00 
			
		
		
		
	Compare commits
	
		
			33 Commits
		
	
	
		
			v1.3.0
			...
			release-te
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| c142d16052 | |||
| 4e2d182c9a | |||
| 65218afbaa | |||
| aa035a1808 | |||
| 23296b91aa | |||
| e57c08db27 | |||
| 573e9186b2 | |||
| 5451d82b77 | |||
| 0da8ce72f0 | |||
| 3e4069b9b2 | |||
| a4d9cf1d6d | |||
| 7fbe752d59 | |||
| 46ee0dcae8 | |||
| bc7d5cd181 | |||
| 6e653f9adf | |||
| fccdfd265d | |||
| f4e7418908 | |||
| 63ea8bf09b | |||
| 29b5be9cdc | |||
| d6ee6871f2 | |||
| dbcf4b53b8 | |||
| b09de681dc | |||
| 992ab0ec47 | |||
| 5c0e6c6ab1 | |||
| 61baafa627 | |||
| 823f94bb9a | |||
| 263a1dda9d | |||
| 79711eebaf | |||
| 69ed1d913a | |||
| 2841430efc | |||
| 5917dd2291 | |||
| c0b86d615e | |||
| 3896766f7d | 
							
								
								
									
										62
									
								
								.github/workflows/ci.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										62
									
								
								.github/workflows/ci.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,62 @@ | ||||
| name: CI | ||||
|  | ||||
| on: [push] | ||||
|  | ||||
| jobs: | ||||
|   test: | ||||
|     runs-on: ${{ matrix.os }} | ||||
|     strategy: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         go: [ '1.15', '1.14' ] | ||||
|         os: [ ubuntu-latest, macOS-latest, windows-latest ] | ||||
|     name: ${{ matrix.os }} Go ${{ matrix.go }} Tests | ||||
|     steps: | ||||
|       - uses: actions/checkout@v2 | ||||
|       - name: Setup go | ||||
|         uses: actions/setup-go@v2 | ||||
|         with: | ||||
|           go-version: ${{ matrix.go }} | ||||
|       - run: go test | ||||
|  | ||||
|   test-non-amd64: | ||||
|     strategy: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         arch: | ||||
|           # For some reasons this is segfaulting on go env | ||||
|           # - name: IBM Z and LinuxONE | ||||
|           #   architecture: "s390x" | ||||
|           - name: POWER8 | ||||
|             architecture: "ppc64le" | ||||
|      | ||||
|     runs-on: ubuntu-latest | ||||
|     name: Test on ${{ matrix.arch.name }}  | ||||
|     steps: | ||||
|       - uses: actions/checkout@v2 | ||||
|       - uses: uraimo/run-on-arch-action@master | ||||
|         with: | ||||
|           arch: ${{ matrix.arch.architecture }} | ||||
|           distro: ubuntu20.04 | ||||
|           env: | # YAML pipe | ||||
|             GOARCH: ${{ matrix.arch.architecture }} | ||||
|             CGO_ENABLED: 0 | ||||
|           run: | | ||||
|             apt-get update | ||||
|             apt-get install -q -y curl wget git | ||||
|             latestGo=$(curl "https://golang.org/VERSION?m=text") | ||||
|             wget "https://dl.google.com/go/${latestGo}.linux-${GOARCH}.tar.gz" | ||||
|             rm -f $(which go) | ||||
|             rm -rf /usr/local/go | ||||
|             tar -C /usr/local -xzf "${latestGo}.linux-${GOARCH}.tar.gz" | ||||
|             export PATH=/usr/local/go/bin:$PATH | ||||
|             printf "Using go at: $(which go)\n" | ||||
|             printf "Go version: $(go version)\n" | ||||
|             printf "\n\nGo environment:\n\n" | ||||
|             go env | ||||
|             printf "\n\nSystem environment:\n\n" | ||||
|             env | ||||
|             go get -insecure -v -t -d ./... | ||||
|             go test ./... | ||||
|             cd ./cmd/godotenv | ||||
|             go build -trimpath -ldflags="-w -s" -v | ||||
							
								
								
									
										32
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										32
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,32 @@ | ||||
| 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@v2 | ||||
|       - name: Generate build files | ||||
|         uses: thatisuday/go-cross-build@v1 | ||||
|         with: | ||||
|             platforms: 'linux/amd64, linux/ppc64le, darwin/amd64, 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 }} | ||||
|           name: Release ${{ github.ref }} | ||||
|           tag: ${{ github.ref }} | ||||
|           file: dist/* | ||||
|           file_glob: true | ||||
|           overwrite: true | ||||
|            | ||||
| @ -1,8 +0,0 @@ | ||||
| language: go | ||||
|  | ||||
| go: | ||||
|   - 1.x | ||||
|  | ||||
| os: | ||||
|   - linux | ||||
|   - osx | ||||
							
								
								
									
										27
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										27
									
								
								README.md
									
									
									
									
									
								
							| @ -1,4 +1,4 @@ | ||||
| # GoDotEnv [](https://travis-ci.org/joho/godotenv) [](https://ci.appveyor.com/project/joho/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 project (which loads env vars from a .env file) | ||||
|  | ||||
| @ -110,6 +110,31 @@ content := getRemoteFileContent() | ||||
| myEnv, err := godotenv.Unmarshal(content) | ||||
| ``` | ||||
|  | ||||
| ### Precedence & Conventions | ||||
|  | ||||
| Existing envs take precedence of envs that are loaded later. | ||||
|  | ||||
| The [convention](https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use) | ||||
| for managing multiple environments (i.e. development, test, production) | ||||
| is to create an env named `{YOURAPP}_ENV` and load envs in this order: | ||||
|  | ||||
| ```go | ||||
| env := os.Getenv("FOO_ENV") | ||||
| if "" == env { | ||||
|   env = "development" | ||||
| } | ||||
|  | ||||
| godotenv.Load(".env." + env + ".local") | ||||
| if "test" != env { | ||||
|   godotenv.Load(".env.local") | ||||
| } | ||||
| godotenv.Load(".env." + env) | ||||
| godotenv.Load() // The Original .env | ||||
| ``` | ||||
|  | ||||
| If you need to, you can also use `godotenv.Overload()` to defy this convention | ||||
| and overwrite existing envs instead of only supplanting them. Use with caution. | ||||
|  | ||||
| ### Command Mode | ||||
|  | ||||
| Assuming you've installed the command as above and you've got `$GOPATH/bin` in your `$PATH` | ||||
|  | ||||
| @ -19,7 +19,7 @@ func main() { | ||||
| 	flag.Parse() | ||||
|  | ||||
| 	usage := ` | ||||
| Run a process with a env setup from a .env file | ||||
| Run a process with an env setup from a .env file | ||||
|  | ||||
| godotenv [-f ENV_FILE_PATHS] COMMAND_ARGS | ||||
|  | ||||
|  | ||||
							
								
								
									
										59
									
								
								godotenv.go
									
									
									
									
									
								
							
							
						
						
									
										59
									
								
								godotenv.go
									
									
									
									
									
								
							| @ -22,6 +22,7 @@ import ( | ||||
| 	"os/exec" | ||||
| 	"regexp" | ||||
| 	"sort" | ||||
| 	"strconv" | ||||
| 	"strings" | ||||
| ) | ||||
|  | ||||
| @ -147,15 +148,20 @@ func Exec(filenames []string, cmd string, cmdArgs []string) error { | ||||
|  | ||||
| // Write serializes the given environment and writes it to a file | ||||
| func Write(envMap map[string]string, filename string) error { | ||||
| 	content, error := Marshal(envMap) | ||||
| 	if error != nil { | ||||
| 		return error | ||||
| 	content, err := Marshal(envMap) | ||||
| 	if err != nil { | ||||
| 		return err | ||||
| 	} | ||||
| 	file, error := os.Create(filename) | ||||
| 	if error != nil { | ||||
| 		return error | ||||
| 	file, err := os.Create(filename) | ||||
| 	if err != nil { | ||||
| 		return err | ||||
| 	} | ||||
| 	_, err := file.WriteString(content) | ||||
| 	defer file.Close() | ||||
| 	_, err = file.WriteString(content) | ||||
| 	if err != nil { | ||||
| 		return err | ||||
| 	} | ||||
| 	file.Sync() | ||||
| 	return err | ||||
| } | ||||
|  | ||||
| @ -164,7 +170,11 @@ func Write(envMap map[string]string, filename string) error { | ||||
| func Marshal(envMap map[string]string) (string, error) { | ||||
| 	lines := make([]string, 0, len(envMap)) | ||||
| 	for k, v := range envMap { | ||||
| 		lines = append(lines, fmt.Sprintf(`%s="%s"`, k, doubleQuoteEscape(v))) | ||||
| 		if d, err := strconv.Atoi(v); err == nil { | ||||
| 			lines = append(lines, fmt.Sprintf(`%s=%d`, k, d)) | ||||
| 		} else { | ||||
| 			lines = append(lines, fmt.Sprintf(`%s="%s"`, k, doubleQuoteEscape(v))) | ||||
| 		} | ||||
| 	} | ||||
| 	sort.Strings(lines) | ||||
| 	return strings.Join(lines, "\n"), nil | ||||
| @ -209,6 +219,8 @@ func readFile(filename string) (envMap map[string]string, err error) { | ||||
| 	return Parse(file) | ||||
| } | ||||
|  | ||||
| var exportRegex = regexp.MustCompile(`^\s*(?:export\s+)?(.*?)\s*$`) | ||||
|  | ||||
| func parseLine(line string, envMap map[string]string) (key string, value string, err error) { | ||||
| 	if len(line) == 0 { | ||||
| 		err = errors.New("zero length string") | ||||
| @ -256,13 +268,22 @@ func parseLine(line string, envMap map[string]string) (key string, value string, | ||||
| 	if strings.HasPrefix(key, "export") { | ||||
| 		key = strings.TrimPrefix(key, "export") | ||||
| 	} | ||||
| 	key = strings.Trim(key, " ") | ||||
| 	key = strings.TrimSpace(key) | ||||
|  | ||||
| 	key = exportRegex.ReplaceAllString(splitString[0], "$1") | ||||
|  | ||||
| 	// Parse the value | ||||
| 	value = parseValue(splitString[1], envMap) | ||||
| 	return | ||||
| } | ||||
|  | ||||
| var ( | ||||
| 	singleQuotesRegex  = regexp.MustCompile(`\A'(.*)'\z`) | ||||
| 	doubleQuotesRegex  = regexp.MustCompile(`\A"(.*)"\z`) | ||||
| 	escapeRegex        = regexp.MustCompile(`\\.`) | ||||
| 	unescapeCharsRegex = regexp.MustCompile(`\\([^$])`) | ||||
| ) | ||||
|  | ||||
| func parseValue(value string, envMap map[string]string) string { | ||||
|  | ||||
| 	// trim | ||||
| @ -270,11 +291,9 @@ func parseValue(value string, envMap map[string]string) string { | ||||
|  | ||||
| 	// check if we've got quoted values or possible escapes | ||||
| 	if len(value) > 1 { | ||||
| 		rs := regexp.MustCompile(`\A'(.*)'\z`) | ||||
| 		singleQuotes := rs.FindStringSubmatch(value) | ||||
| 		singleQuotes := singleQuotesRegex.FindStringSubmatch(value) | ||||
|  | ||||
| 		rd := regexp.MustCompile(`\A"(.*)"\z`) | ||||
| 		doubleQuotes := rd.FindStringSubmatch(value) | ||||
| 		doubleQuotes := doubleQuotesRegex.FindStringSubmatch(value) | ||||
|  | ||||
| 		if singleQuotes != nil || doubleQuotes != nil { | ||||
| 			// pull the quotes off the edges | ||||
| @ -283,7 +302,6 @@ func parseValue(value string, envMap map[string]string) string { | ||||
|  | ||||
| 		if doubleQuotes != nil { | ||||
| 			// expand newlines | ||||
| 			escapeRegex := regexp.MustCompile(`\\.`) | ||||
| 			value = escapeRegex.ReplaceAllStringFunc(value, func(match string) string { | ||||
| 				c := strings.TrimPrefix(match, `\`) | ||||
| 				switch c { | ||||
| @ -296,8 +314,7 @@ func parseValue(value string, envMap map[string]string) string { | ||||
| 				} | ||||
| 			}) | ||||
| 			// unescape characters | ||||
| 			e := regexp.MustCompile(`\\([^$])`) | ||||
| 			value = e.ReplaceAllString(value, "$1") | ||||
| 			value = unescapeCharsRegex.ReplaceAllString(value, "$1") | ||||
| 		} | ||||
|  | ||||
| 		if singleQuotes == nil { | ||||
| @ -308,11 +325,11 @@ func parseValue(value string, envMap map[string]string) string { | ||||
| 	return value | ||||
| } | ||||
|  | ||||
| func expandVariables(v string, m map[string]string) string { | ||||
| 	r := regexp.MustCompile(`(\\)?(\$)(\()?\{?([A-Z0-9_]+)?\}?`) | ||||
| var expandVarRegex = regexp.MustCompile(`(\\)?(\$)(\()?\{?([A-Z0-9_]+)?\}?`) | ||||
|  | ||||
| 	return r.ReplaceAllStringFunc(v, func(s string) string { | ||||
| 		submatch := r.FindStringSubmatch(s) | ||||
| func expandVariables(v string, m map[string]string) string { | ||||
| 	return expandVarRegex.ReplaceAllStringFunc(v, func(s string) string { | ||||
| 		submatch := expandVarRegex.FindStringSubmatch(s) | ||||
|  | ||||
| 		if submatch == nil { | ||||
| 			return s | ||||
| @ -327,7 +344,7 @@ func expandVariables(v string, m map[string]string) string { | ||||
| } | ||||
|  | ||||
| func isIgnoredLine(line string) bool { | ||||
| 	trimmedLine := strings.Trim(line, " \n\t") | ||||
| 	trimmedLine := strings.TrimSpace(line) | ||||
| 	return len(trimmedLine) == 0 || strings.HasPrefix(trimmedLine, "#") | ||||
| } | ||||
|  | ||||
|  | ||||
| @ -5,8 +5,8 @@ import ( | ||||
| 	"fmt" | ||||
| 	"os" | ||||
| 	"reflect" | ||||
| 	"testing" | ||||
| 	"strings" | ||||
| 	"testing" | ||||
| ) | ||||
|  | ||||
| var noopPresets = make(map[string]string) | ||||
| @ -313,6 +313,13 @@ func TestParsing(t *testing.T) { | ||||
| 	// parses export keyword | ||||
| 	parseAndCompare(t, "export OPTION_A=2", "OPTION_A", "2") | ||||
| 	parseAndCompare(t, `export OPTION_B='\n'`, "OPTION_B", "\\n") | ||||
| 	parseAndCompare(t, "export exportFoo=2", "exportFoo", "2") | ||||
| 	parseAndCompare(t, "exportFOO=2", "exportFOO", "2") | ||||
| 	parseAndCompare(t, "export_FOO =2", "export_FOO", "2") | ||||
| 	parseAndCompare(t, "export.FOO= 2", "export.FOO", "2") | ||||
| 	parseAndCompare(t, "export\tOPTION_A=2", "OPTION_A", "2") | ||||
| 	parseAndCompare(t, "  export OPTION_A=2", "OPTION_A", "2") | ||||
| 	parseAndCompare(t, "\texport OPTION_A=2", "OPTION_A", "2") | ||||
|  | ||||
| 	// it 'expands newlines in quoted strings' do | ||||
| 	// expect(env('FOO="bar\nbaz"')).to eql('FOO' => "bar\nbaz") | ||||
| @ -355,6 +362,11 @@ func TestParsing(t *testing.T) { | ||||
| 	parseAndCompare(t, `KEY="`, "KEY", "\"") | ||||
| 	parseAndCompare(t, `KEY="value`, "KEY", "\"value") | ||||
|  | ||||
| 	// leading whitespace should be ignored | ||||
| 	parseAndCompare(t, " KEY =value", "KEY", "value") | ||||
| 	parseAndCompare(t, "   KEY=value", "KEY", "value") | ||||
| 	parseAndCompare(t, "\tKEY=value", "KEY", "value") | ||||
|  | ||||
| 	// it 'throws an error if line format is incorrect' do | ||||
| 	// expect{env('lol$wut')}.to raise_error(Dotenv::FormatError) | ||||
| 	badlyFormattedLine := "lol$wut" | ||||
| @ -371,6 +383,10 @@ func TestLinesToIgnore(t *testing.T) { | ||||
| 		t.Error("Line with nothing but line break wasn't ignored") | ||||
| 	} | ||||
|  | ||||
| 	if !isIgnoredLine("\r\n") { | ||||
| 		t.Error("Line with nothing but windows-style line break wasn't ignored") | ||||
| 	} | ||||
|  | ||||
| 	if !isIgnoredLine("\t\t ") { | ||||
| 		t.Error("Line full of whitespace wasn't ignored") | ||||
| 	} | ||||
| @ -429,6 +445,8 @@ func TestWrite(t *testing.T) { | ||||
| 	writeAndCompare(`foo="\n\r\\r!"`, `foo="\n\r\\r\!"`) | ||||
| 	// lines should be sorted | ||||
| 	writeAndCompare("foo=bar\nbaz=buzz", "baz=\"buzz\"\nfoo=\"bar\"") | ||||
| 	// integers should not be quoted | ||||
| 	writeAndCompare(`key="10"`, `key=10`) | ||||
|  | ||||
| } | ||||
|  | ||||
|  | ||||
		Reference in New Issue
	
	Block a user
	