Function WriteProjectEnvFile

pkg/ddevapp/envfile.go:30–61

WriteProjectEnvFile writes the passed envText into the envFilePath .env file changing items in envMap changed in envText there

(envFilePath string, envMap map[string]string, envText string)

// WriteProjectEnvFile writes the passed envText into the envFilePath .env file
// changing items in envMap changed in envText there
func WriteProjectEnvFile(envFilePath string, envMap map[string]string, envText string) error {
	for k, v := range envMap {
		v = EscapeEnvFileValue(v)
		// If the item is already in envText, use regex to replace it
		// otherwise, append it to the envText.
		// (^|[\r\n]+) - first group $1 matches the start of a line or newline characters
		// #*[ \t]* - matches optional comments with spaces/tabs, i.e. find lines like '# FOO=BAR'
		// (%s) - second group $2 matches the variable name (QuoteMeta escapes dots and other
		//        regex special chars, e.g. for CodeIgniter's "database.default.hostname")
		// [ \t]*=[ \t]* - matches equals sign with optional spaces/tabs
		exp := regexp.MustCompile(fmt.Sprintf(`(^|[\r\n]+)#*[ \t]*(%s)[ \t]*=[ \t]*(.*)`, regexp.QuoteMeta(k)))
		if exp.MatchString(envText) {
			// To insert a literal $ in the output, use $$ in the template.
			// See https://pkg.go.dev/regexp?utm_source=godoc#Regexp.Expand
			v = strings.ReplaceAll(v, `$`, `$$`)
			// Remove comments with whitespaces here using only $1 and $2 groups
			envText = exp.ReplaceAllString(envText, fmt.Sprintf(`$1$2=%s`, v))
		} else {
			envText = strings.TrimSuffix(envText, "\n")
			if envText != "" {
				envText = fmt.Sprintf("%s\n%s=%s\n", envText, k, v)
			} else {
				envText = fmt.Sprintf("%s=%s\n", k, v)
			}
		}
	}
	err := fileutil.TemplateStringToFile(envText, nil, envFilePath)
	if err != nil {
		return err
	}
	return nil
}

// EscapeEnvFileValue escapes the value so it can be used in an .env file
// The value is wrapped in double quotes for correct work with spaces.