refactor: (DSP-2004) Apply good practice to code

.github/workflows/lint.yml

@@ -51,3 +51,6 @@ jobs:
           --from ${{ github.event.pull_request.head.sha }}~${{ github.event.pull_request.commits }}
           --to ${{ github.event.pull_request.head.sha }}
           --verbose
+
+      - name: 🔎 Validate PR title with commitlint
+        run: echo "${{ github.event.pull_request.title }}" | npx commitlint

cmd/create_comment.go

@@ -1,24 +1,26 @@
 package cmd
 
 import (
-	commentGithub "github.com/gbh-tech/github-pr-commenter/src"
-
+	"github.com/charmbracelet/log"
 	"github.com/spf13/cobra"
 )
 
 var createCommentPrCmd = &cobra.Command{
 	Use:     "create",
 	Aliases: []string{"new"},
 	Short:   "Create new comment on PR",
-	Example: "atlas comment create [flags]",
+	Example: "commenter create [flags]",
 	Run: func(cmd *cobra.Command, args []string) {
 		pull, _ := cmd.Flags().GetInt("pull")
 		repo, _ := cmd.Flags().GetString("repo")
 		org, _ := cmd.Flags().GetString("org")
 		content, _ := cmd.Flags().GetString("content")
 		filePath, _ := cmd.Flags().GetString("filePath")
 
-		commentGithub.CreateComment(pull, org, repo, content, filePath)
+		_, err := GithubClient.CreateComment(pull, org, repo, content, filePath)
+		if err != nil {
+			log.Fatalf("Error: %v\n", err)
+		}
 	},
 }
 

cmd/get_comment.go

@@ -1,23 +1,28 @@
 package cmd
 
 import (
-	commentGithub "github.com/gbh-tech/github-pr-commenter/src"
+	"fmt"
 
+	"github.com/charmbracelet/log"
 	"github.com/spf13/cobra"
 )
 
 var getCommentPrCmd = &cobra.Command{
 	Use:     "get",
 	Short:   "Get message ID based on text",
-	Example: "atlas comment get [flags]",
+	Example: "commenter get [flags]",
 	Run: func(cmd *cobra.Command, args []string) {
 		pull, _ := cmd.Flags().GetInt("pull")
 		repo, _ := cmd.Flags().GetString("repo")
 		org, _ := cmd.Flags().GetString("org")
 		content, _ := cmd.Flags().GetString("content")
 		filePath, _ := cmd.Flags().GetString("filePath")
 
-		commentGithub.GetUserComments(pull, org, repo, content, filePath)
+		commentID, err := GithubClient.GetUserComments(pull, org, repo, content, filePath)
+		if err != nil {
+			log.Fatalf("Error: %v\n", err)
+		}
+		fmt.Printf("%v", commentID)
 	},
 }
 

cmd/root.go

@@ -3,13 +3,24 @@ package cmd
 import (
 	"os"
 
+	comments "github.com/gbh-tech/github-pr-commenter/src/comments"
+
 	"github.com/charmbracelet/log"
 	"github.com/spf13/cobra"
 )
 
+var GithubClient comments.GithubClient
+
 var RootCmd = &cobra.Command{
 	Use:   "commenter",
 	Short: "A CLI to perform operation on GitHub PR issues.",
+	PersistentPreRun: func(cmd *cobra.Command, args []string) {
+		token := os.Getenv("GITHUB_TOKEN")
+		err := comments.NewClient(token, &GithubClient)
+		if err != nil {
+			log.Fatalf("Error initializing GitHub client: %v", err)
+		}
+	},
 }
 
 func init() {

cmd/update_comment.go

@@ -1,23 +1,25 @@
 package cmd
 
 import (
-	commentGithub "github.com/gbh-tech/github-pr-commenter/src"
-
+	"github.com/charmbracelet/log"
 	"github.com/spf13/cobra"
 )
 
 var updateCommentPrCmd = &cobra.Command{
 	Use:     "update",
 	Short:   "Update comment on PR",
-	Example: "atlas comment update [flags]",
+	Example: "commenter update [flags]",
 	Run: func(cmd *cobra.Command, args []string) {
 		repo, _ := cmd.Flags().GetString("repo")
 		org, _ := cmd.Flags().GetString("org")
 		content, _ := cmd.Flags().GetString("content")
 		filePath, _ := cmd.Flags().GetString("filePath")
 		commentID, _ := cmd.Flags().GetInt64("commentID")
 
-		commentGithub.UpdateComment(commentID, org, repo, content, filePath)
+		_, err := GithubClient.UpdateComment(commentID, org, repo, content, filePath)
+		if err != nil {
+			log.Fatalf("Error: %v\n", err)
+		}
 	},
 }
 

package.json

@@ -12,5 +12,82 @@
     "commitlint": "^19.2.1",
     "husky": "^9.0.11",
     "release-it": "^17.3.0"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ],
+    "defaultIgnores": true
+  },
+  "release-it": {
+    "github": {
+      "release": false,
+      "releaseName": "v${version}"
+    },
+    "git": {
+      "commitMessage": "chore: release v${version}",
+      "tagMatch": "v[0-9]*\\.[0-9]*\\.[0-9]*",
+      "tagName": "v${version}",
+      "getLatestTagFromAllRefs": true,
+      "tagExclude": "*[-]*",
+      "push": true,
+      "release": true,
+      "pushArgs": ["--no-verify", "--follow-tags", "--force"],
+      "commitArgs": ["--no-verify"]
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "conventionalcommits",
+          "types": [
+            {
+              "type": "feat",
+              "section": "Features"
+            },
+            {
+              "type": "fix",
+              "section": "Bug Fixes"
+            },
+            {
+              "type": "chore",
+              "section": "Miscellaneous"
+            },
+            {
+              "type": "docs",
+              "section": "Miscellaneous"
+            },
+            {
+              "type": "style",
+              "section": "Miscellaneous"
+            },
+            {
+              "type": "refactor",
+              "section": "Miscellaneous"
+            },
+            {
+              "type": "perf",
+              "section": "Miscellaneous"
+            },
+            {
+              "type": "test",
+              "section": "Miscellaneous"
+            },
+            {
+              "type": "build",
+              "section": "Miscellaneous"
+            },
+            {
+              "type": "revert",
+              "section": "Miscellaneous"
+            },
+            {
+              "type": "ci",
+              "section": "Miscellaneous"
+            }
+          ]
+        },
+        "infile": "CHANGELOG.md"
+      }
+    }
   }
 }