From 2bec0f15109720efdd821f4bf4d204082c333000 Mon Sep 17 00:00:00 2001
From: kaypee90 <kaypee90@yahoo.com>
Date: Tue, 23 Jul 2024 00:34:20 -0400
Subject: [PATCH] Clean up

---
 cmd/depbot/main.go       |  4 ++--
 cmd/depbot/utils.go      | 28 ++++++++++++++--------------
 cmd/depbot/utils_test.go | 12 ++++++------
 3 files changed, 22 insertions(+), 22 deletions(-)

diff --git a/cmd/depbot/main.go b/cmd/depbot/main.go
index b990d96..c349de2 100644
--- a/cmd/depbot/main.go
+++ b/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)
 }
diff --git a/cmd/depbot/utils.go b/cmd/depbot/utils.go
index 4f3af27..f9e1ebd 100644
--- a/cmd/depbot/utils.go
+++ b/cmd/depbot/utils.go
@@ -9,16 +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 assist you to configure dependabot in your project%s\n", green, reset)
 }
 
-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)
@@ -33,7 +33,7 @@ func writeDataToFile(fileName string, data []byte) {
 	log.Printf("Dependabot config created successfully!")
 }
 
-func createDirIfItDoesNotExit(dir string) (hasCreatedNewDir bool, err error) {
+func createDirectoryIfItDoesNotExist(dir string) (hasCreatedNewDir bool, err error) {
 	if _, err := os.Stat(dir); os.IsNotExist(err) {
 		err := os.Mkdir(dir, 0755)
 
@@ -52,26 +52,26 @@ func createConfigurationFile(fileName string, destinationDir string, data []byte
 	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 %s already exists", 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)
 }
diff --git a/cmd/depbot/utils_test.go b/cmd/depbot/utils_test.go
index 53ac49a..41aa51d 100644
--- a/cmd/depbot/utils_test.go
+++ b/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")
 }