mirror of
				https://github.com/joho/godotenv.git
				synced 2025-10-31 21:12:36 +00:00 
			
		
		
		
	Compare commits
	
		
			12 Commits
		
	
	
		
			v1.5.1
			...
			multiline-
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 1e1ed32207 | |||
| d4cc462af7 | |||
| 02a6516148 | |||
| 08d75deb23 | |||
| c723940cb5 | |||
| 687a37d9c9 | |||
| a4061f306a | |||
| 22f9782344 | |||
| 2f66a86dc9 | |||
| 77e8b7d7d6 | |||
| dd57617d18 | |||
| 15b4dd39bb | 
							
								
								
									
										2
									
								
								.github/workflows/ci.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.github/workflows/ci.yml
									
									
									
									
										vendored
									
									
								
							| @ -8,7 +8,7 @@ jobs: | ||||
|     strategy: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         go: [ '1.20', '1.19', '1.18', '1.17', '1.16' ] | ||||
|         go: [ '1.19', '1.18', '1.17', '1.16', '1.15' ] | ||||
|         os: [ ubuntu-latest, macOS-latest, windows-latest ] | ||||
|     name: ${{ matrix.os }} Go ${{ matrix.go }} Tests | ||||
|     steps: | ||||
|  | ||||
| @ -75,8 +75,8 @@ import _ "github.com/joho/godotenv/autoload" | ||||
| While `.env` in the project root is the default, you don't have to be constrained, both examples below are 100% legit | ||||
|  | ||||
| ```go | ||||
| godotenv.Load("somerandomfile") | ||||
| godotenv.Load("filenumberone.env", "filenumbertwo.env") | ||||
| _ = godotenv.Load("somerandomfile") | ||||
| _ = godotenv.Load("filenumberone.env", "filenumbertwo.env") | ||||
| ``` | ||||
|  | ||||
| If you want to be really fancy with your env file you can do comments and exports (below is a valid env file) | ||||
| @ -153,8 +153,6 @@ godotenv -f /some/path/to/.env some_command with some args | ||||
|  | ||||
| If you don't specify `-f` it will fall back on the default of loading `.env` in `PWD` | ||||
|  | ||||
| By default, it won't override existing environment variables; you can do that with the `-o` flag. | ||||
|  | ||||
| ### Writing Env Files | ||||
|  | ||||
| Godotenv can also write a map representing the environment to a correctly-formatted and escaped file | ||||
|  | ||||
| @ -15,15 +15,13 @@ func main() { | ||||
| 	flag.BoolVar(&showHelp, "h", false, "show help") | ||||
| 	var rawEnvFilenames string | ||||
| 	flag.StringVar(&rawEnvFilenames, "f", "", "comma separated paths to .env files") | ||||
| 	var overload bool | ||||
| 	flag.BoolVar(&overload, "o", false, "override existing .env variables") | ||||
|  | ||||
| 	flag.Parse() | ||||
|  | ||||
| 	usage := ` | ||||
| Run a process with an env setup from a .env file | ||||
|  | ||||
| godotenv [-o] [-f ENV_FILE_PATHS] COMMAND_ARGS | ||||
| godotenv [-f ENV_FILE_PATHS] COMMAND_ARGS | ||||
|  | ||||
| ENV_FILE_PATHS: comma separated paths to .env files | ||||
| COMMAND_ARGS: command and args you want to run | ||||
| @ -49,7 +47,7 @@ example | ||||
| 	cmd := args[0] | ||||
| 	cmdArgs := args[1:] | ||||
|  | ||||
| 	err := godotenv.Exec(envFilenames, cmd, cmdArgs, overload) | ||||
| 	err := godotenv.Exec(envFilenames, cmd, cmdArgs) | ||||
| 	if err != nil { | ||||
| 		log.Fatal(err) | ||||
| 	} | ||||
|  | ||||
| @ -1 +1,2 @@ | ||||
| export OPTION_A='postgres://localhost:5432/database?sslmode=disable' | ||||
|  | ||||
|  | ||||
| @ -5,4 +5,3 @@ OPTION_D =4 | ||||
| OPTION_E = 5 | ||||
| OPTION_F =  | ||||
| OPTION_G= | ||||
| OPTION_H=1 2 | ||||
							
								
								
									
										143
									
								
								godotenv.go
									
									
									
									
									
								
							
							
						
						
									
										143
									
								
								godotenv.go
									
									
									
									
									
								
							| @ -14,11 +14,13 @@ | ||||
| package godotenv | ||||
|  | ||||
| import ( | ||||
| 	"bytes" | ||||
| 	"errors" | ||||
| 	"fmt" | ||||
| 	"io" | ||||
| 	"io/ioutil" | ||||
| 	"os" | ||||
| 	"os/exec" | ||||
| 	"regexp" | ||||
| 	"sort" | ||||
| 	"strconv" | ||||
| 	"strings" | ||||
| @ -28,13 +30,12 @@ const doubleQuoteSpecialChars = "\\\n\r\"!$`" | ||||
|  | ||||
| // Parse reads an env file from io.Reader, returning a map of keys and values. | ||||
| func Parse(r io.Reader) (map[string]string, error) { | ||||
| 	var buf bytes.Buffer | ||||
| 	_, err := io.Copy(&buf, r) | ||||
| 	data, err := ioutil.ReadAll(r) | ||||
| 	if err != nil { | ||||
| 		return nil, err | ||||
| 	} | ||||
|  | ||||
| 	return UnmarshalBytes(buf.Bytes()) | ||||
| 	return UnmarshalBytes(data) | ||||
| } | ||||
|  | ||||
| // Load will read your env file(s) and load them into ENV for this process. | ||||
| @ -124,13 +125,9 @@ func UnmarshalBytes(src []byte) (map[string]string, error) { | ||||
| // 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 | ||||
| // that you use `Load()`, `Overload()` or `Read()` and the `os/exec` package yourself. | ||||
| func Exec(filenames []string, cmd string, cmdArgs []string, overload bool) error { | ||||
| 	op := Load | ||||
| 	if overload { | ||||
| 		op = Overload | ||||
| 	} | ||||
| 	if err := op(filenames...); err != nil { | ||||
| // that you use `Load()` or `Read()` and the `os/exec` package yourself. | ||||
| func Exec(filenames []string, cmd string, cmdArgs []string) error { | ||||
| 	if err := Load(filenames...); err != nil { | ||||
| 		return err | ||||
| 	} | ||||
|  | ||||
| @ -213,6 +210,130 @@ 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") | ||||
| 		return | ||||
| 	} | ||||
|  | ||||
| 	// ditch the comments (but keep quoted hashes) | ||||
| 	if strings.Contains(line, "#") { | ||||
| 		segmentsBetweenHashes := strings.Split(line, "#") | ||||
| 		quotesAreOpen := false | ||||
| 		var segmentsToKeep []string | ||||
| 		for _, segment := range segmentsBetweenHashes { | ||||
| 			if strings.Count(segment, "\"") == 1 || strings.Count(segment, "'") == 1 { | ||||
| 				if quotesAreOpen { | ||||
| 					quotesAreOpen = false | ||||
| 					segmentsToKeep = append(segmentsToKeep, segment) | ||||
| 				} else { | ||||
| 					quotesAreOpen = true | ||||
| 				} | ||||
| 			} | ||||
|  | ||||
| 			if len(segmentsToKeep) == 0 || quotesAreOpen { | ||||
| 				segmentsToKeep = append(segmentsToKeep, segment) | ||||
| 			} | ||||
| 		} | ||||
|  | ||||
| 		line = strings.Join(segmentsToKeep, "#") | ||||
| 	} | ||||
|  | ||||
| 	firstEquals := strings.Index(line, "=") | ||||
| 	firstColon := strings.Index(line, ":") | ||||
| 	splitString := strings.SplitN(line, "=", 2) | ||||
| 	if firstColon != -1 && (firstColon < firstEquals || firstEquals == -1) { | ||||
| 		//this is a yaml-style line | ||||
| 		splitString = strings.SplitN(line, ":", 2) | ||||
| 	} | ||||
|  | ||||
| 	if len(splitString) != 2 { | ||||
| 		err = errors.New("can't separate key from value") | ||||
| 		return | ||||
| 	} | ||||
|  | ||||
| 	// Parse the key | ||||
| 	key = splitString[0] | ||||
|  | ||||
| 	key = strings.TrimPrefix(key, "export") | ||||
|  | ||||
| 	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 | ||||
| 	value = strings.Trim(value, " ") | ||||
|  | ||||
| 	// check if we've got quoted values or possible escapes | ||||
| 	if len(value) > 1 { | ||||
| 		singleQuotes := singleQuotesRegex.FindStringSubmatch(value) | ||||
|  | ||||
| 		doubleQuotes := doubleQuotesRegex.FindStringSubmatch(value) | ||||
|  | ||||
| 		if singleQuotes != nil || doubleQuotes != nil { | ||||
| 			// pull the quotes off the edges | ||||
| 			value = value[1 : len(value)-1] | ||||
| 		} | ||||
|  | ||||
| 		if doubleQuotes != nil { | ||||
| 			// expand newlines | ||||
| 			value = escapeRegex.ReplaceAllStringFunc(value, func(match string) string { | ||||
| 				c := strings.TrimPrefix(match, `\`) | ||||
| 				switch c { | ||||
| 				case "n": | ||||
| 					return "\n" | ||||
| 				case "r": | ||||
| 					return "\r" | ||||
| 				default: | ||||
| 					return match | ||||
| 				} | ||||
| 			}) | ||||
| 			// unescape characters | ||||
| 			value = unescapeCharsRegex.ReplaceAllString(value, "$1") | ||||
| 		} | ||||
|  | ||||
| 		if singleQuotes == nil { | ||||
| 			value = expandVariables(value, envMap) | ||||
| 		} | ||||
| 	} | ||||
|  | ||||
| 	return value | ||||
| } | ||||
|  | ||||
| var expandVarRegex = regexp.MustCompile(`(\\)?(\$)(\()?\{?([A-Z0-9_]+)?\}?`) | ||||
|  | ||||
| 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 | ||||
| 		} | ||||
| 		if submatch[1] == "\\" || submatch[2] == "(" { | ||||
| 			return submatch[0][1:] | ||||
| 		} else if submatch[4] != "" { | ||||
| 			return m[submatch[4]] | ||||
| 		} | ||||
| 		return s | ||||
| 	}) | ||||
| } | ||||
|  | ||||
| func doubleQuoteEscape(line string) string { | ||||
| 	for _, c := range doubleQuoteSpecialChars { | ||||
| 		toReplace := "\\" + string(c) | ||||
|  | ||||
| @ -12,14 +12,9 @@ import ( | ||||
| var noopPresets = make(map[string]string) | ||||
|  | ||||
| func parseAndCompare(t *testing.T, rawEnvLine string, expectedKey string, expectedValue string) { | ||||
| 	result, err := Unmarshal(rawEnvLine) | ||||
|  | ||||
| 	if err != nil { | ||||
| 		t.Errorf("Expected %q to parse as %q: %q, errored %q", rawEnvLine, expectedKey, expectedValue, err) | ||||
| 		return | ||||
| 	} | ||||
| 	if result[expectedKey] != expectedValue { | ||||
| 		t.Errorf("Expected '%v' to parse as '%v' => '%v', got %q instead", rawEnvLine, expectedKey, expectedValue, result) | ||||
| 	key, value, _ := parseLine(rawEnvLine, noopPresets) | ||||
| 	if key != expectedKey || value != expectedValue { | ||||
| 		t.Errorf("Expected '%v' to parse as '%v' => '%v', got '%v' => '%v' instead", rawEnvLine, expectedKey, expectedValue, key, value) | ||||
| 	} | ||||
| } | ||||
|  | ||||
| @ -85,7 +80,6 @@ func TestReadPlainEnv(t *testing.T) { | ||||
| 		"OPTION_E": "5", | ||||
| 		"OPTION_F": "", | ||||
| 		"OPTION_G": "", | ||||
| 		"OPTION_H": "1 2", | ||||
| 	} | ||||
|  | ||||
| 	envMap, err := Read(envFileName) | ||||
| @ -159,7 +153,6 @@ func TestLoadPlainEnv(t *testing.T) { | ||||
| 		"OPTION_C": "3", | ||||
| 		"OPTION_D": "4", | ||||
| 		"OPTION_E": "5", | ||||
| 		"OPTION_H": "1 2", | ||||
| 	} | ||||
|  | ||||
| 	loadEnvAndCompareValues(t, Load, envFileName, expectedValues, noopPresets) | ||||
| @ -279,6 +272,7 @@ func TestExpanding(t *testing.T) { | ||||
| 			} | ||||
| 		}) | ||||
| 	} | ||||
|  | ||||
| } | ||||
|  | ||||
| func TestVariableStringValueSeparator(t *testing.T) { | ||||
| @ -375,9 +369,6 @@ func TestParsing(t *testing.T) { | ||||
| 	// expect(env('foo=bar ')).to eql('foo' => 'bar') # not 'bar ' | ||||
| 	parseAndCompare(t, "FOO=bar ", "FOO", "bar") | ||||
|  | ||||
| 	// unquoted internal whitespace is preserved | ||||
| 	parseAndCompare(t, `KEY=value value`, "KEY", "value value") | ||||
|  | ||||
| 	// it 'ignores inline comments' do | ||||
| 	// expect(env("foo=bar # this is foo")).to eql('foo' => 'bar') | ||||
| 	parseAndCompare(t, "FOO=bar # this is foo", "FOO", "bar") | ||||
| @ -400,8 +391,10 @@ func TestParsing(t *testing.T) { | ||||
| 	parseAndCompare(t, `FOO="bar\\r\ b\az"`, "FOO", "bar\\r baz") | ||||
|  | ||||
| 	parseAndCompare(t, `="value"`, "", "value") | ||||
| 	parseAndCompare(t, `KEY="`, "KEY", "\"") | ||||
| 	parseAndCompare(t, `KEY="value`, "KEY", "\"value") | ||||
|  | ||||
| 	// unquoted whitespace around keys should be ignored | ||||
| 	// leading whitespace should be ignored | ||||
| 	parseAndCompare(t, " KEY =value", "KEY", "value") | ||||
| 	parseAndCompare(t, "   KEY=value", "KEY", "value") | ||||
| 	parseAndCompare(t, "\tKEY=value", "KEY", "value") | ||||
| @ -409,7 +402,7 @@ func TestParsing(t *testing.T) { | ||||
| 	// it 'throws an error if line format is incorrect' do | ||||
| 	// expect{env('lol$wut')}.to raise_error(Dotenv::FormatError) | ||||
| 	badlyFormattedLine := "lol$wut" | ||||
| 	_, err := Unmarshal(badlyFormattedLine) | ||||
| 	_, _, err := parseLine(badlyFormattedLine, noopPresets) | ||||
| 	if err == nil { | ||||
| 		t.Errorf("Expected \"%v\" to return error, but it didn't", badlyFormattedLine) | ||||
| 	} | ||||
| @ -527,49 +520,3 @@ func TestRoundtrip(t *testing.T) { | ||||
|  | ||||
| 	} | ||||
| } | ||||
|  | ||||
| func TestTrailingNewlines(t *testing.T) { | ||||
| 	cases := map[string]struct { | ||||
| 		input string | ||||
| 		key   string | ||||
| 		value string | ||||
| 	}{ | ||||
| 		"Simple value without trailing newline": { | ||||
| 			input: "KEY=value", | ||||
| 			key:   "KEY", | ||||
| 			value: "value", | ||||
| 		}, | ||||
| 		"Value with internal whitespace without trailing newline": { | ||||
| 			input: "KEY=value value", | ||||
| 			key:   "KEY", | ||||
| 			value: "value value", | ||||
| 		}, | ||||
| 		"Value with internal whitespace with trailing newline": { | ||||
| 			input: "KEY=value value\n", | ||||
| 			key:   "KEY", | ||||
| 			value: "value value", | ||||
| 		}, | ||||
| 		"YAML style - value with internal whitespace without trailing newline": { | ||||
| 			input: "KEY: value value", | ||||
| 			key:   "KEY", | ||||
| 			value: "value value", | ||||
| 		}, | ||||
| 		"YAML style - value with internal whitespace with trailing newline": { | ||||
| 			input: "KEY: value value\n", | ||||
| 			key:   "KEY", | ||||
| 			value: "value value", | ||||
| 		}, | ||||
| 	} | ||||
|  | ||||
| 	for n, c := range cases { | ||||
| 		t.Run(n, func(t *testing.T) { | ||||
| 			result, err := Unmarshal(c.input) | ||||
| 			if err != nil { | ||||
| 				t.Errorf("Input: %q Unexpected error:\t%q", c.input, err) | ||||
| 			} | ||||
| 			if result[c.key] != c.value { | ||||
| 				t.Errorf("Input %q Expected:\t %q/%q\nGot:\t %q", c.input, c.key, c.value, result) | ||||
| 			} | ||||
| 		}) | ||||
| 	} | ||||
| } | ||||
|  | ||||
							
								
								
									
										80
									
								
								parser.go
									
									
									
									
									
								
							
							
						
						
									
										80
									
								
								parser.go
									
									
									
									
									
								
							| @ -4,7 +4,6 @@ import ( | ||||
| 	"bytes" | ||||
| 	"errors" | ||||
| 	"fmt" | ||||
| 	"regexp" | ||||
| 	"strings" | ||||
| 	"unicode" | ||||
| ) | ||||
| @ -70,13 +69,7 @@ func getStatementStart(src []byte) []byte { | ||||
| // locateKeyName locates and parses key name and returns rest of slice | ||||
| func locateKeyName(src []byte) (key string, cutset []byte, err error) { | ||||
| 	// trim "export" and space at beginning | ||||
| 	src = bytes.TrimLeftFunc(src, isSpace) | ||||
| 	if bytes.HasPrefix(src, []byte(exportPrefix)) { | ||||
| 		trimmed := bytes.TrimPrefix(src, []byte(exportPrefix)) | ||||
| 		if bytes.IndexFunc(trimmed, isSpace) == 0 { | ||||
| 			src = bytes.TrimLeftFunc(trimmed, isSpace) | ||||
| 		} | ||||
| 	} | ||||
| 	src = bytes.TrimLeftFunc(bytes.TrimPrefix(src, []byte(exportPrefix)), isSpace) | ||||
|  | ||||
| 	// locate key name end and validate it in single loop | ||||
| 	offset := 0 | ||||
| @ -95,8 +88,8 @@ loop: | ||||
| 			break loop | ||||
| 		case '_': | ||||
| 		default: | ||||
| 			// variable name should match [A-Za-z0-9_.] | ||||
| 			if unicode.IsLetter(rchar) || unicode.IsNumber(rchar) || rchar == '.' { | ||||
| 			// variable name should match [A-Za-z0-9_] | ||||
| 			if unicode.IsLetter(rchar) || unicode.IsNumber(rchar) { | ||||
| 				continue | ||||
| 			} | ||||
|  | ||||
| @ -120,41 +113,13 @@ loop: | ||||
| func extractVarValue(src []byte, vars map[string]string) (value string, rest []byte, err error) { | ||||
| 	quote, hasPrefix := hasQuotePrefix(src) | ||||
| 	if !hasPrefix { | ||||
| 		// unquoted value - read until end of line | ||||
| 		endOfLine := bytes.IndexFunc(src, isLineEnd) | ||||
|  | ||||
| 		// Hit EOF without a trailing newline | ||||
| 		if endOfLine == -1 { | ||||
| 			endOfLine = len(src) | ||||
|  | ||||
| 			if endOfLine == 0 { | ||||
| 				return "", nil, nil | ||||
| 			} | ||||
| 		// unquoted value - read until whitespace | ||||
| 		end := bytes.IndexFunc(src, unicode.IsSpace) | ||||
| 		if end == -1 { | ||||
| 			return expandVariables(string(src), vars), nil, nil | ||||
| 		} | ||||
|  | ||||
| 		// Convert line to rune away to do accurate countback of runes | ||||
| 		line := []rune(string(src[0:endOfLine])) | ||||
|  | ||||
| 		// Assume end of line is end of var | ||||
| 		endOfVar := len(line) | ||||
| 		if endOfVar == 0 { | ||||
| 			return "", src[endOfLine:], nil | ||||
| 		} | ||||
|  | ||||
| 		// Work backwards to check if the line ends in whitespace then | ||||
| 		// a comment (ie asdasd # some comment) | ||||
| 		for i := endOfVar - 1; i >= 0; i-- { | ||||
| 			if line[i] == charComment && i > 0 { | ||||
| 				if isSpace(line[i-1]) { | ||||
| 					endOfVar = i | ||||
| 					break | ||||
| 				} | ||||
| 			} | ||||
| 		} | ||||
|  | ||||
| 		trimmed := strings.TrimFunc(string(line[0:endOfVar]), isSpace) | ||||
|  | ||||
| 		return expandVariables(trimmed, vars), src[endOfLine:], nil | ||||
| 		return expandVariables(string(src[0:end]), vars), src[end:], nil | ||||
| 	} | ||||
|  | ||||
| 	// lookup quoted string terminator | ||||
| @ -240,32 +205,3 @@ func isSpace(r rune) bool { | ||||
| 	} | ||||
| 	return false | ||||
| } | ||||
|  | ||||
| func isLineEnd(r rune) bool { | ||||
| 	if r == '\n' || r == '\r' { | ||||
| 		return true | ||||
| 	} | ||||
| 	return false | ||||
| } | ||||
|  | ||||
| var ( | ||||
| 	escapeRegex        = regexp.MustCompile(`\\.`) | ||||
| 	expandVarRegex     = regexp.MustCompile(`(\\)?(\$)(\()?\{?([A-Z0-9_]+)?\}?`) | ||||
| 	unescapeCharsRegex = regexp.MustCompile(`\\([^$])`) | ||||
| ) | ||||
|  | ||||
| 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 | ||||
| 		} | ||||
| 		if submatch[1] == "\\" || submatch[2] == "(" { | ||||
| 			return submatch[0][1:] | ||||
| 		} else if submatch[4] != "" { | ||||
| 			return m[submatch[4]] | ||||
| 		} | ||||
| 		return s | ||||
| 	}) | ||||
| } | ||||
|  | ||||
		Reference in New Issue
	
	Block a user
	