Support comments in .env file (#5)

env.go

@@ -10,6 +10,11 @@ import (
 	"time"
 )
 
+const (
+	charComment = '#'
+	// TODO: handle `prefix`, i.e. single and double quote
+)
+
 // GetStringOrDefault value.
 func GetStringOrDefault(name, defaultV string) string {
 	v, ok := os.LookupEnv(name)
@@ -73,6 +78,9 @@ func Load(paths ...string) error {
 		for s.Scan() {
 			i++
 			line := s.Text()
+			if line[0] == charComment {
+				continue
+			}
 			parts := strings.SplitN(line, "=", 2)
 			if len(parts) < 2 {
 				return fmt.Errorf("missing equal sign on line %v in %v", i, path)

env_test.go

@@ -109,6 +109,15 @@ func TestLoad(t *testing.T) {
 		is.Equal("missing equal sign on line 1 in testdata/invalid", err.Error())
 	})
 
+	t.Run("ignore comments in environment file", func(t *testing.T) {
+		is := is.New(t)
+		defer unsetenv("hat", "hats", "equals")
+		err := env.Load("testdata/with_comment")
+		is.NoErr(err)
+		equals := env.GetStringOrDefault("equals", "")
+		is.Equal("somethingwithequalsafter=", equals)
+	})
+
 	t.Run("gets the string value including equal signs", func(t *testing.T) {
 		is := is.New(t)
 		defer unsetenv("hat", "hats", "equals")

testdata/with_comment

@@ -0,0 +1,5 @@
+# this a comment, and it should be ignored!!!!
+hat=party
+hats=2
+equals=somethingwithequalsafter=
+# this another comment and should be ignored!!!