change basic to dotenv

Author: dsa0x

Readme.md

@@ -38,12 +38,12 @@ sicher init
 
 **_Optional flags:_**
 
-| flag       | description                                                           | default | options       |
-| ---------- | --------------------------------------------------------------------- | ------- | ------------- |
-| -env       | set the environment name                                              | dev     |               |
-| -path      | set the path to the credentials file                                  | .       |               |
-| -style     | set the style of the decrypted credentials file                       | basic   | basic or yaml |
-| -gitignore | path to the gitignore file. the key file will be added here, if given |         |               |
+| flag       | description                                                           | default | options        |
+| ---------- | --------------------------------------------------------------------- | ------- | -------------- |
+| -env       | set the environment name                                              | dev     |                |
+| -path      | set the path to the credentials file                                  | .       |                |
+| -style     | set the style of the decrypted credentials file                       | dotenv  | dotenv or yaml |
+| -gitignore | path to the gitignore file. the key file will be added here, if given |         |                |
 
 This will create a key file `{environment}.key` and an encrypted credentials file `{environment}.enc` in the current directory. The environment name is optional and defaults to `dev`, but can be set to anything else with the `-env` flag.
 
@@ -55,12 +55,12 @@ sicher edit
 
 **_Optional flags:_**
 
-| flag    | description                                     | default | options       |
-| ------- | ----------------------------------------------- | ------- | ------------- |
-| -env    | set the environment name                        | dev     |               |
-| -path   | set the path to the credentials file            | .       |               |
-| -editor | set the editor to use                           | vim     | vim, nano, vi |
-| -style  | set the style of the decrypted credentials file | basic   | basic or yaml |
+| flag    | description                                     | default | options        |
+| ------- | ----------------------------------------------- | ------- | -------------- |
+| -env    | set the environment name                        | dev     |                |
+| -path   | set the path to the credentials file            | .       |                |
+| -editor | set the editor to use                           | vim     | vim, nano, vi  |
+| -style  | set the style of the decrypted credentials file | dotenv  | dotenv or yaml |
 
 This will create a temporary file, decrypt the credentials into it, and open it in your editor. The editor defaults to `vim`, but can be also set to `nano` or `vi` with the `-editor` flag. The temporary file is destroyed after each save, and the encrypted credentials file is updated with the new content.
 
@@ -85,7 +85,7 @@ func main() {
 	var config Config
 
 	s := sicher.New("dev", ".")
-	s.SetEnvStyle("yaml") // default is basic
+	s.SetEnvStyle("yaml") // default is dotenv
 	err := s.LoadEnv("", &cfg)
 	if err != nil {
 		fmt.Println(err)
@@ -105,7 +105,7 @@ The `LoadEnv` function will load the credentials from the encrypted file `{envir
 
 All env files should be in the format like the example below:
 
-For `basic envType`:
+For `dotenv`:
 
 ```
 PORT=8080
@@ -114,7 +114,7 @@ MONGO_DB_NAME=sicher
 APP_URL=http://localhost:8080
 ```
 
-For `Yaml envType`:
+For `yaml`:
 
 ```
 PORT:8080

cli/sicher.go

@@ -31,7 +31,7 @@ sicher edit
 func init() {
 	flag.StringVar(&pathFlag, "path", ".", "Path to the project")
 	flag.StringVar(&envFlag, "env", "dev", "Environment to use")
-	flag.StringVar(&styleFlag, "style", string(sicher.DefaultEnvStyle), "Env file style. Valid values are basic and yaml")
+	flag.StringVar(&styleFlag, "style", string(sicher.DefaultEnvStyle), "Env file style. Valid values are dotenv and yaml")
 	flag.StringVar(&editorFlag, "editor", "vim", "Select editor. vim | vi | nano")
 	flag.StringVar(&gitignorePathFlag, "gitignore", ".", "Path to the gitignore file")
 

example/sample.go

@@ -33,7 +33,7 @@ func LoadConfigMap() {
 	cfg := make(map[string]string)
 
 	s := sicher.New("dev", ".")
-	s.SetEnvStyle("yaml") // default is basic
+	s.SetEnvStyle("yaml") // default is dotenv
 	err := s.LoadEnv("", &cfg)
 	if err != nil {
 		fmt.Println(err)

helpers.go

@@ -17,21 +17,21 @@ import (
 type EnvStyle string
 
 const (
-	YAML  EnvStyle = "yaml"
-	YML   EnvStyle = "yml"
-	BASIC EnvStyle = "basic"
+	YAML   EnvStyle = "yaml"
+	YML    EnvStyle = "yml"
+	DOTENV EnvStyle = "dotenv"
 )
 
 var envStyleDelim = map[EnvStyle]string{
-	YAML:  ":",
-	YML:   ":",
-	BASIC: "=",
+	YAML:   ":",
+	YML:    ":",
+	DOTENV: "=",
 }
 
 var envStyleExt = map[EnvStyle]string{
-	YAML:  "yml",
-	YML:   "yml",
-	BASIC: "env",
+	YAML:   "yml",
+	YML:    "yml",
+	DOTENV: "env",
 }
 
 // cleanUpFile removes the given file
@@ -75,7 +75,7 @@ func generateKey() string {
 // parseConfig parses the environment variables into a map
 func parseConfig(config []byte, store map[string]string, envType EnvStyle) (err error) {
 
-	if envType != BASIC && envType != YAML && envType != YML {
+	if envType != DOTENV && envType != YAML && envType != YML {
 		return errors.New("invalid environment type")
 	}
 

helpers_test.go

@@ -45,7 +45,7 @@ PORT=8080
 URI=localhost
 #OLD_PORT=5000
 	`)
-	err := parseConfig(cfg, enMap, "basic")
+	err := parseConfig(cfg, enMap, "dotenv")
 	if err != nil {
 		t.Errorf("Unable to parse config; %v", err)
 	}
@@ -67,7 +67,7 @@ URI=localhost
 
 	parseConfig(cfg, enMap, "yaml")
 	if len(enMap) != 0 {
-		t.Errorf("Expected basic style env not be be parseable with yaml envType")
+		t.Errorf("Expected dotenv style env not be be parseable with yaml envType")
 	}
 }
 func TestYamlParseConfig(t *testing.T) {

sicher.go

@@ -20,7 +20,7 @@ import (
 
 var delimiter = "==--=="
 var defaultEnv = "dev"
-var DefaultEnvStyle = BASIC
+var DefaultEnvStyle = DOTENV
 var (
 	execCmd               = exec.Command
 	stdIn   io.ReadWriter = os.Stdin
@@ -55,7 +55,7 @@ func New(environment string, path string) *sicher {
 		path = "."
 	}
 	path, _ = filepath.Abs(path)
-	return &sicher{Path: path + "/", Environment: environment, data: make(map[string]string), envStyle: BASIC}
+	return &sicher{Path: path + "/", Environment: environment, data: make(map[string]string), envStyle: DOTENV}
 }
 
 // Initialize initializes the sicher project and creates the necessary files
@@ -291,8 +291,8 @@ func (s *sicher) LoadEnv(prefix string, configFile interface{}) error {
 }
 
 func (s *sicher) SetEnvStyle(style string) {
-	if style != "basic" && style != "yaml" && style != "yml" {
-		fmt.Println("Invalid style: Select one of basic, yml, or yaml")
+	if style != "dotenv" && style != "yaml" && style != "yml" {
+		fmt.Println("Invalid style: Select one of dotenv, yml, or yaml")
 		os.Exit(1)
 	}
 	s.envStyle = EnvStyle(style)

sicher_test.go

@@ -40,10 +40,10 @@ func TestNewWithEnvironment(t *testing.T) {
 }
 func TestEnvStyle(t *testing.T) {
 	s := New("testenv", "")
-	s.SetEnvStyle("basic")
+	s.SetEnvStyle("dotenv")
 
-	if s.envStyle != "basic" {
-		t.Errorf("Expected environment style to be set to %s, got %s", "basic", s.envStyle)
+	if s.envStyle != "dotenv" {
+		t.Errorf("Expected environment style to be set to %s, got %s", "dotenv", s.envStyle)
 	}
 
 }