Merge pull request #15 from kaypee90/refactor-version-0.2.0

fix: improve displayed text on cli

cmd/depbot/main.go

@@ -2,7 +2,7 @@ package main
 
 func main() {
 	// display introduction text
-	displayIntroductoryText()
+	printIntroductoryText()
 
 	var updates []Update
 
@@ -36,5 +36,5 @@ func main() {
 
 	// write configration data to yaml file
 	yamlData := config.ConvertToYaml()
-	createDependabotYmlFile(yamlData)
+	createDependabotYamlFile(yamlData)
 }

cmd/depbot/utils.go

@@ -9,31 +9,16 @@ import (
 
 const (
 	dependabotFileName = "dependabot.yml"
-	githubDir          = ".github"
+	githubDirectory    = ".github"
 )
 
-func displayIntroductoryText() {
+func printIntroductoryText() {
 	green := "\033[32m"
 	reset := "\033[0m"
-	fmt.Printf("%sDepbot wizard will help you configure dependabot in your project%s\n", green, reset)
+	fmt.Printf("%sDepbot wizard will assist you to configure dependabot in your project%s\n", green, reset)
 }
 
-func createDirIfItDoesNotExit(dir string) (hasCreatedNewDir bool, err error) {
-	if _, err := os.Stat(dir); os.IsNotExist(err) {
-		err := os.Mkdir(dir, 0755)
-
-		if err != nil {
-			log.Fatalf("Error creating directory %s: %v", dir, err)
-			return false, err
-		}
-
-		return true, nil
-	}
-
-	return false, nil
-}
-
-func writeDataToFile(fileName string, data []byte) {
+func writeBytesToFile(fileName string, data []byte) {
 	file, err := os.Create(fileName)
 	if err != nil {
 		log.Fatalf("Error creating file %s: %v", fileName, err)
@@ -48,30 +33,45 @@ func writeDataToFile(fileName string, data []byte) {
 	log.Printf("Dependabot config created successfully!")
 }
 
+func createDirectoryIfItDoesNotExist(dir string) (hasCreatedNewDir bool, err error) {
+	if _, err := os.Stat(dir); os.IsNotExist(err) {
+		err := os.Mkdir(dir, 0755)
+
+		if err != nil {
+			log.Fatalf("Error creating directory %s: %v", dir, err)
+			return false, err
+		}
+
+		return true, nil
+	}
+
+	return false, nil
+}
+
 func createConfigurationFile(fileName string, destinationDir string, data []byte, skipCreatingDir bool) {
 	fullFilePath := fileName
 
 	if !skipCreatingDir {
-		log.Printf("Creating %s directory..", githubDir)
-		createDirIfItDoesNotExit(destinationDir)
+		log.Printf("Creating %s directory..", githubDirectory)
+		createDirectoryIfItDoesNotExist(destinationDir)
 		fullFilePath = destinationDir + "/" + fileName
 	} else {
-		log.Printf("Skipping directory creation since current directory is %s", githubDir)
+		log.Printf("Skipping directory creation since %s already exists", githubDirectory)
 	}
 
-	writeDataToFile(fullFilePath, data)
+	writeBytesToFile(fullFilePath, data)
 }
 
-func getCurrentDir() string {
-	currentDir, err := os.Getwd()
+func getWorkingDirectory() string {
+	currentDirectory, err := os.Getwd()
 	if err != nil {
 		panic(err)
 	}
 
-	return filepath.Base(currentDir)
+	return filepath.Base(currentDirectory)
 }
 
-func createDependabotYmlFile(data []byte) {
-	skipCreatingDir := getCurrentDir() == githubDir
-	createConfigurationFile(dependabotFileName, githubDir, data, skipCreatingDir)
+func createDependabotYamlFile(data []byte) {
+	skipCreatingDir := getWorkingDirectory() == githubDirectory
+	createConfigurationFile(dependabotFileName, githubDirectory, data, skipCreatingDir)
 }

cmd/depbot/utils_test.go

@@ -9,21 +9,21 @@ import (
 
 const testDir = "./test"
 
-func TestCreateDirIfItDoesNotExitIfDirectoryAlreadyDoesntExist(t *testing.T) {
+func TestCreateDirectoryIfItDoesNotExistIfDirectoryAlreadyDoesntExist(t *testing.T) {
 	defer os.RemoveAll(testDir)
 
-	hasCreatedNewDir, err := createDirIfItDoesNotExit(testDir)
+	hasCreatedNewDir, err := createDirectoryIfItDoesNotExist(testDir)
 
 	assert.NilError(t, err)
 	assert.Equal(t, hasCreatedNewDir, true)
 }
 
-func TestCreateDirIfItDoesNotExitIfDirectoryAlreadyExist(t *testing.T) {
+func TestCreateDirectoryIfItDoesNotExistIfDirectoryAlreadyExist(t *testing.T) {
 	defer os.RemoveAll(testDir)
 
 	_ = os.Mkdir(testDir, 0755)
 
-	hasCreatedNewDir, err := createDirIfItDoesNotExit(testDir)
+	hasCreatedNewDir, err := createDirectoryIfItDoesNotExist(testDir)
 
 	assert.NilError(t, err)
 	assert.Equal(t, hasCreatedNewDir, false)
@@ -46,8 +46,8 @@ func TestCreateConfigurationFile(t *testing.T) {
 	assert.NilError(t, err)
 }
 
-func TestGetCurrentDir(t *testing.T) {
-	dirName := getCurrentDir()
+func TestGetWorkingDirectory(t *testing.T) {
+	dirName := getWorkingDirectory()
 
 	assert.Equal(t, dirName, "depbot")
 }