feat!: use godotenv and --unescape flag (#2)

Author: u-yas

README.md

@@ -1,10 +1,9 @@
 
-# ennbu 
+# ennbu
 
+![ennbu logo](./docs/ennbu-logo.png)
 
-<img src="./docs/ennbu-logo.png" alt="logo" />
-
-**.env utility CLI**
+## .env utility CLI
 
 `ennbu` is a command-line interface (CLI) tool for managing .env files in your projects, written in Go. It allows you to easily set, replace, list, and get values of keys within your .env files.
 
@@ -60,7 +59,7 @@ jobs:
       - name: go mod download
         run: go mod download
       - name: replace APP_ENV
-        uses: u-yas/[email protected].1
+        uses: u-yas/[email protected].4
         with:
           envPath: .env
           commands: |
@@ -78,37 +77,58 @@ jobs:
 To get the value of a specific key in a .env file, use the `get` command:
 
 ```bash
-ennbu get -k KEY_NAME -e .env
+ennbu get KEY_NAME -f .env
+```
+
+`--unescape` or `-u`
+
+```text
+# .env
+KEY_NAME="aa\nbbb\n\tccc"
+```
+
+```bash
+# normally
+ennbu get KEY_NAME
+# aa\nbbb\n\tccc
+
+# unescape
+ennbu get KEY_NAME -u
+#aa
+#bb
+# cc
 ```
 
 #### List
 
 To list all key-value pairs in a .env file, use the `list` command:
 
 ```bash
-ennbu list -e .env
+ennbu list -f .env
 ```
 
 To list the key-value pairs in JSON format, use the `--json` flag:
 
 ```bash
-ennbu list --json -e .env
+ennbu list --json -f .env
 ```
 
+![ennbu list --json output](./docs/list-json.png)
+
 #### Set
 
 To set a new value for a key in a .env file, use the `set` command:
 
 ```bash
-ennbu set -e .env -k KEY_NAME VALUE
+ennbu set -f .env -k KEY_NAME VALUE
 ```
 
 #### Replace
 
 To replace a value for an existing key in a .env file, use the `replace` command:
 
 ```bash
-echo NEW_VALUE | ennbu replace  -e .env -k KEY_NAME
+echo NEW_VALUE | ennbu replace  -f .env -k KEY_NAME
 ```
 
 ## Contributing

cmd/get.go

@@ -15,14 +15,14 @@ var getCmd = &cobra.Command{
 	Use:   "get",
 	Short: "Get the value of a specified key in .env file",
 	Example: heredoc.Doc(`
-$ ennbu get KEY
-$ ennbu get -e .env.development
+		$ ennbu get KEY
+		$ ennbu get -e .env.development
 `),
 	RunE: get.Run,
 }
 
 func init() {
 	_ = getCmd.MarkFlagRequired(flags.FlagKey)
-
+	getCmd.Flags().BoolP(get.FlagUnescape, "u", false, "Unescape special characters")
 	rootCmd.AddCommand(getCmd)
 }

docs/list-json.png

@@ -0,0 +1,14 @@
+package env
+
+import (
+	"github.com/joho/godotenv"
+)
+
+func ReadEnv(envFilePath string) (map[string]string, error) {
+	env, err := godotenv.Read(envFilePath)
+	if err != nil {
+		return nil, err
+	}
+
+	return env, nil
+}

env/value.go env/escape.go

@@ -0,0 +1,14 @@
+package env
+
+import (
+	"github.com/joho/godotenv"
+)
+
+func WriteEnv(content map[string]string, envFilePath string) error {
+	err := godotenv.Write(content, envFilePath)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

env/read.go

@@ -0,0 +1,5 @@
+package get
+
+const (
+	FlagUnescape string = "unescape"
+)

env/write.go

@@ -1,47 +1,37 @@
 package get
 
 import (
-	"bufio"
 	"fmt"
-	"os"
-	"path/filepath"
+	"strconv"
 	"strings"
 
 	"github.com/spf13/cobra"
+	"github.com/u-yas/ennbu/env"
 	"github.com/u-yas/ennbu/flags"
 )
 
 func Run(cmd *cobra.Command, args []string) error {
 	key := args[0]
 	envFilePath, _ := cmd.Flags().GetString(flags.FlagEnvFile)
-
-	envFile, err := os.Open(envFilePath)
-	envFileName := filepath.Base(envFilePath)
+	unescapeFlag, _ := cmd.Flags().GetBool(FlagUnescape)
+	e, err := env.ReadEnv(envFilePath)
 	if err != nil {
-		return fmt.Errorf("error opening %s file: %w", envFileName, err)
+		return fmt.Errorf("failed to read env file: %w", err)
 	}
-	defer envFile.Close()
-
-	scanner := bufio.NewScanner(envFile)
-	found := false
 
-	for scanner.Scan() {
-		line := scanner.Text()
-		if strings.HasPrefix(line, key+"=") {
-			value := strings.TrimPrefix(line, key+"=")
-			fmt.Println(value)
-			found = true
-			break
-		}
+	if _, ok := e[key]; !ok {
+		return fmt.Errorf("key not found: %s", key)
 	}
 
-	if err := scanner.Err(); err != nil {
-		return fmt.Errorf("error reading %s file: %w", envFileName, err)
+	value := e[key]
+	if !unescapeFlag {
+		value = strconv.Quote(value)
 	}
 
-	if !found {
-		return fmt.Errorf("key not found in %s file", envFileName)
+	if strings.HasPrefix(value, "\"") && strings.HasSuffix(value, "\"") {
+		value = strings.TrimSuffix(strings.TrimPrefix(value, "\""), "\"")
 	}
 
+	fmt.Println(value)
 	return nil
 }

get/flag.go

@@ -10,5 +10,6 @@ require (
 
 require (
 	github.com/inconshreveable/mousetrap v1.0.1 // indirect
+	github.com/joho/godotenv v1.5.1 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
 )

get/run.go

@@ -3,6 +3,8 @@ github.com/MakeNowJust/heredoc/v2 v2.0.1/go.mod h1:6/2Abh5s+hc3g9nbWLe9ObDIOhaRr
 github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/inconshreveable/mousetrap v1.0.1 h1:U3uMjPSQEBMNp1lFxmllqCPM6P5u/Xq7Pgzkat/bFNc=
 github.com/inconshreveable/mousetrap v1.0.1/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0=
+github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/spf13/cobra v1.6.1 h1:o94oiPyS4KD1mPy2fmcYYHHfCxLqYjJOhGsCHFZtEzA=
 github.com/spf13/cobra v1.6.1/go.mod h1:IOw/AERYS7UzyrGinqmz6HLUo219MORXGxhbaJUqzrY=

go.mod

@@ -1,50 +1,48 @@
 package list
 
 import (
+	"bytes"
 	"encoding/json"
 	"fmt"
-	"os"
-	"path/filepath"
-	"strings"
 
+	"github.com/joho/godotenv"
 	"github.com/spf13/cobra"
 	"github.com/tidwall/pretty"
+	"github.com/u-yas/ennbu/env"
 	"github.com/u-yas/ennbu/flags"
 )
 
 func Run(cmd *cobra.Command, args []string) error {
 	envFilePath, _ := cmd.Flags().GetString(flags.FlagEnvFile)
 	jsonOutput, _ := cmd.Flags().GetBool(FlagJson)
 
-	envfileName := filepath.Base(envFilePath)
-	envContent, err := os.ReadFile(envFilePath)
+	e, err := env.ReadEnv(envFilePath)
 	if err != nil {
-		return fmt.Errorf("error reading %s file: %w", envfileName, err)
+		return fmt.Errorf("failed to read env file: %w", err)
 	}
 
-	lines := strings.Split(string(envContent), "\n")
-	envMap := make(map[string]string)
+	if jsonOutput {
+		var buffer bytes.Buffer
+		enc := json.NewEncoder(&buffer)
+		enc.SetEscapeHTML(false)
+		enc.SetIndent("", "  ")
 
-	for _, line := range lines {
-		if strings.TrimSpace(line) == "" || strings.HasPrefix(line, "#") {
-			continue
-		}
-		kv := strings.SplitN(line, "=", 2)
-		if len(kv) == 2 {
-			envMap[kv[0]] = kv[1]
+		if err := enc.Encode(e); err != nil {
+			return fmt.Errorf("error generating JSON output: %w", err)
 		}
-	}
 
-	if jsonOutput {
-		jsonData, err := json.MarshalIndent(envMap, "", "  ")
+		jVal := buffer.Bytes()
 		if err != nil {
 			return fmt.Errorf("error generating JSON output: %w", err)
 		}
-		fmt.Println(string(pretty.Color(jsonData, nil)))
+
+		fmt.Println(string(pretty.Color(jVal, nil)))
 	} else {
-		for key, value := range envMap {
-			fmt.Printf("%s=%s\n", key, value)
+		rawEnv, err := godotenv.Marshal(e)
+		if err != nil {
+			return fmt.Errorf("error generating raw output: %w", err)
 		}
+		fmt.Println(rawEnv)
 	}
 
 	return nil

go.sum

@@ -2,9 +2,6 @@ package replace
 
 import (
 	"fmt"
-	"os"
-	"path/filepath"
-	"strings"
 
 	"github.com/spf13/cobra"
 	"github.com/u-yas/ennbu/env"
@@ -21,36 +18,22 @@ func Run(cmd *cobra.Command, args []string) error {
 		value = env.EscapeSpecialChars(value)
 	}
 
-	// Check if the value contains newline characters and wrap it with double quotes if necessary
-	if strings.Contains(value, "\n") {
-		value = fmt.Sprintf("\"%s\"", value)
-	}
+	e, err := env.ReadEnv(envFilePath)
 
-	fileName := filepath.Base(envFilePath)
-	envContent, err := os.ReadFile(envFilePath)
 	if err != nil {
-		return fmt.Errorf("error reading %s: %w", fileName, err)
+		return fmt.Errorf("failed to read env file: %w", err)
 	}
 
-	lines := strings.Split(string(envContent), "\n")
-	found := false
-
-	for i, line := range lines {
-		if strings.HasPrefix(line, key+"=") {
-			lines[i] = key + "=" + value
-			found = true
-			break
-		}
+	// replace cmd should not add new key
+	if _, ok := e[key]; !ok {
+		return fmt.Errorf("key not found: %s", key)
 	}
 
-	if !found {
-		return fmt.Errorf("key %s not found in %s", key, fileName)
-	}
+	e[key] = value
 
-	newContent := strings.Join(lines, "\n")
-	err = os.WriteFile(envFilePath, []byte(newContent), 0644)
+	err = env.WriteEnv(e, envFilePath)
 	if err != nil {
-		return fmt.Errorf("error writing %s: %w", fileName, err)
+		return fmt.Errorf("failed to write env file: %w", err)
 	}
 	return nil
 }

list/run.go

@@ -2,8 +2,6 @@ package set
 
 import (
 	"fmt"
-	"os"
-	"strings"
 
 	"github.com/spf13/cobra"
 	"github.com/u-yas/ennbu/env"
@@ -19,35 +17,18 @@ func Run(cmd *cobra.Command, args []string) error {
 	if escapeFlag {
 		value = env.EscapeSpecialChars(value)
 	}
-	// Check if the value contains newline characters and wrap it with double quotes if necessary
-	if strings.Contains(value, "\n") {
-		value = fmt.Sprintf("\"%s\"", value)
-	}
-
-	envContent, err := os.ReadFile(envFilePath)
-	if err != nil {
-		return fmt.Errorf("error reading %s: %w", envFilePath, err)
-	}
 
-	lines := strings.Split(string(envContent), "\n")
-	found := false
+	e, err := env.ReadEnv(envFilePath)
 
-	for i, line := range lines {
-		if strings.HasPrefix(line, key+"=") {
-			lines[i] = key + "=" + value
-			found = true
-			break
-		}
+	if err != nil {
+		return fmt.Errorf("failed to read env file: %w", err)
 	}
 
-	if !found {
-		lines = append(lines, key+"="+value)
-	}
+	e[key] = value
 
-	newContent := strings.Join(lines, "\n")
-	err = os.WriteFile(envFilePath, []byte(newContent), 0644)
+	err = env.WriteEnv(e, envFilePath)
 	if err != nil {
-		return fmt.Errorf("error writing %s: %w", envFilePath, err)
+		return fmt.Errorf("failed to write env file: %w", err)
 	}
 
 	return nil