chore: Introduce code formatter through Make (#26)

* chore: add gci and goimports tools for code formatting
* fix go.sum
* chore: Introduce code formatter through Make

Author: yogesh-chauhan

Makefile

@@ -0,0 +1,47 @@
+ifndef GOPATH
+	GOPATH := $(shell go env GOPATH)
+endif
+ifndef GOBIN # derive value from gopath (default to first entry, similar to 'go get')
+	GOBIN := $(shell go env GOPATH | sed 's/:.*//')/bin
+endif
+
+tools = $(addprefix $(GOBIN)/, goimports gci)
+
+LDFLAGS = "-X github.com/harness/gitness/version.GitCommit=${GIT_COMMIT} -X github.com/harness/gitness/version.major=${GITNESS_VERSION_MAJOR} -X github.com/harness/gitness/version.minor=${GITNESS_VERSION_MINOR} -X github.com/harness/gitness/version.patch=${GITNESS_VERSION_PATCH}"
+
+###############################################################################
+#
+# Build rules
+#
+###############################################################################
+tools: $(tools) ## Install tools required for the build
+	@echo "Installed tools"
+
+build:  
+	@echo "Building mcp-server"
+	go build -ldflags=${LDFLAGS} -o cmd/harness-mcp-server/harness-mcp-server ./cmd/harness-mcp-server
+
+###############################################################################
+#
+# Code Formatting and linting
+#
+###############################################################################
+
+format: tools # Format go code and error if any changes are made
+	@echo "Formating ..."
+	@goimports -w .
+	@gci write --custom-order -s standard -s "prefix(github.com/harness/gitness)" -s default -s blank -s dot .
+	@echo "Formatting complete"
+
+.PHONY: help format tools
+
+$(GOBIN)/gci:
+	go install github.com/daixiang0/[email protected]
+	
+# Install goimports to format code
+$(GOBIN)/goimports:
+	@echo "🔘 Installing goimports ... (`date '+%H:%M:%S'`)"
+	@go install golang.org/x/tools/cmd/goimports
+
+help: ## show help message
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m\033[0m\n"} /^[$$()% 0-9a-zA-Z_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

README.md

@@ -74,6 +74,24 @@ Toolset Name: `logs`
 
 ## Quickstart
 
+## Makefile Usage
+
+This project provides a `Makefile` to simplify common development tasks. The main targets are:
+
+- `make build` – Build the mcp-server binary with version information embedded.
+- `make init` – Set up git hooks and submodules for pre-commit checks.
+- `make dep` – Download Go module dependencies.
+- `make tools` – Install tools required for the build (if any are specified).
+- `make format` – Format Go code using goimports and gci.
+
+You can run any of these commands from the project root. For example:
+
+```sh
+make build
+make format
+```
+
+
 ### Build from Source
 
 1. Clone the repository:

client/ar/ar_gen.go

@@ -19,16 +19,16 @@ type ChatbotService struct {
 func (c *ChatbotService) SendChatMessage(ctx context.Context, scope dto.Scope, request *dto.ChatRequest) (string, error) {
 	path := chatPath
 	params := make(map[string]string)
-	
+
 	// Only add non-empty scope parameters
 	if scope.AccountID != "" {
 		params["accountIdentifier"] = scope.AccountID
 	}
-	
+
 	if scope.OrgID != "" {
 		params["orgIdentifier"] = scope.OrgID
 	}
-	
+
 	if scope.ProjectID != "" {
 		params["projectIdentifier"] = scope.ProjectID
 	}

client/chatbot.go

@@ -12,11 +12,10 @@ import (
 	"strings"
 	"time"
 
-	"github.com/harness/harness-mcp/pkg/harness/auth"
-	"github.com/rs/zerolog/log"
-
 	"github.com/cenkalti/backoff/v4"
 	"github.com/harness/harness-mcp/client/dto"
+	"github.com/harness/harness-mcp/pkg/harness/auth"
+	"github.com/rs/zerolog/log"
 )
 
 var (

client/client.go

@@ -4,16 +4,17 @@ import (
 	"context"
 	"fmt"
 	"log/slog"
+
 	"github.com/harness/harness-mcp/client/dto"
 	"github.com/harness/harness-mcp/pkg/utils"
 )
 
 const (
-	ccmBasePath        = "ccm/api"
-	ccmGetOverviewPath = ccmBasePath + "/overview?accountIdentifier=%s&startTime=%d&endTime=%d&groupBy=%s"
-	ccmCostCategoryListPath = ccmBasePath + "/business-mapping/filter-panel?accountIdentifier=%s"
-	ccmCostCategoryDetailListPath = ccmBasePath + "/business-mapping?accountIdentifier=%s" // This endpoint lists cost categories
-	ccmGetCostCategoryPath = ccmBasePath + "/business-mapping/%s?accountIdentifier=%s" // This endpoint lists cost categories
+	ccmBasePath                   = "ccm/api"
+	ccmGetOverviewPath            = ccmBasePath + "/overview?accountIdentifier=%s&startTime=%d&endTime=%d&groupBy=%s"
+	ccmCostCategoryListPath       = ccmBasePath + "/business-mapping/filter-panel?accountIdentifier=%s"
+	ccmCostCategoryDetailListPath = ccmBasePath + "/business-mapping?accountIdentifier=%s"    // This endpoint lists cost categories
+	ccmGetCostCategoryPath        = ccmBasePath + "/business-mapping/%s?accountIdentifier=%s" // This endpoint lists cost categories
 )
 
 type CloudCostManagementService struct {
@@ -23,7 +24,7 @@ type CloudCostManagementService struct {
 func (c *CloudCostManagementService) GetOverview(ctx context.Context, accID string, startTime int64, endTime int64, groupBy string) (*dto.CEView, error) {
 	path := fmt.Sprintf(ccmGetOverviewPath, accID, startTime, endTime, groupBy)
 
-	slog.Debug("GetOverView", "Path", path) 
+	slog.Debug("GetOverView", "Path", path)
 	params := make(map[string]string)
 
 	ccmOverview := new(dto.CEView)
@@ -97,7 +98,7 @@ func (r *CloudCostManagementService) ListCostCategoriesDetail(ctx context.Contex
 }
 
 func (r *CloudCostManagementService) GetCostCategory(ctx context.Context, scope dto.Scope, opts *dto.CCMGetCostCategoryOptions) (*dto.CCMCostCategory, error) {
-	// Opts shouuldn't be nil 
+	// Opts shouuldn't be nil
 	if opts == nil {
 		return nil, fmt.Errorf("Missing parameters for Get CCM Cost categories.")
 	}

client/cloudcostmanagement.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/harness/harness-mcp/client/dto"      // Corrected import path for Scope
+	"github.com/harness/harness-mcp/client/dto"             // Corrected import path for Scope
 	pkgDTO "github.com/harness/harness-mcp/pkg/harness/dto" // Alias for the other DTOs
 )
 
@@ -34,7 +34,7 @@ func (c *ConnectorService) ListConnectorCatalogue(ctx context.Context, scope dto
 				Connectors []string `json:"connectors"`
 			} `json:"catalogue"`
 		} `json:"data"`
-		MetaData     interface{} `json:"metaData"`
+		MetaData      interface{} `json:"metaData"`
 		CorrelationID string      `json:"correlationId"`
 	}
 
@@ -71,10 +71,10 @@ func (c *ConnectorService) GetConnector(ctx context.Context, scope dto.Scope, co
 
 	// Define a struct to match the actual API response structure
 	type connectorResponse struct {
-		Status        string                   `json:"status"`
-		Data          pkgDTO.ConnectorDetail   `json:"data"`
-		MetaData      interface{}              `json:"metaData"`
-		CorrelationID string                   `json:"correlationId"`
+		Status        string                 `json:"status"`
+		Data          pkgDTO.ConnectorDetail `json:"data"`
+		MetaData      interface{}            `json:"metaData"`
+		CorrelationID string                 `json:"correlationId"`
 	}
 
 	var response connectorResponse

client/connectors.go

@@ -6,6 +6,6 @@ type ChatHistoryItem struct {
 }
 
 type ChatRequest struct {
-	Question    string           `json:"question"`
-	ChatHistory []ChatHistoryItem `json:"chat_history,omitempty"` 
+	Question    string            `json:"question"`
+	ChatHistory []ChatHistoryItem `json:"chat_history,omitempty"`
 }

client/dto/chatbot.go

@@ -10,34 +10,34 @@ const (
 )
 
 const (
-	SortTypeName    string = "NAME"
-	SortTypeLastEdit    string = "LAST_EDIT"
+	SortTypeName     string = "NAME"
+	SortTypeLastEdit string = "LAST_EDIT"
 )
 
 const (
-	SortOrderAsc    string = "ASCENDING"
-	SortOrderDesc   string = "DESCENDING"
+	SortOrderAsc  string = "ASCENDING"
+	SortOrderDesc string = "DESCENDING"
 )
 
 // CCMBaseResponse represents a basic ccm response.
 type CCMBaseResponse struct {
-	Status        string      `json:"state,omitempty"`
-	Message	   string      `json:"message,omitempty"`
-	CorrelationID string      `json:"correlation_id,omitempty"`
-	Error		 []CCMError      `json:"error,omitempty"`
+	Status        string     `json:"state,omitempty"`
+	Message       string     `json:"message,omitempty"`
+	CorrelationID string     `json:"correlation_id,omitempty"`
+	Error         []CCMError `json:"error,omitempty"`
 }
 
 // Response error
 type CCMError struct {
-	FieldId	 string `json:"fieldId,omitempty"`
-	Error string `json:"error,omitempty"`
+	FieldId string `json:"fieldId,omitempty"`
+	Error   string `json:"error,omitempty"`
 }
 
 // CEView represents a basic Cost Overview response.
 // The `data` field contains the response data.
 type CEView struct {
 	CCMBaseResponse
-	Data          CCMOverview `json:"data,omitempty"`
+	Data CCMOverview `json:"data,omitempty"`
 }
 
 // CCMOverview represents the Overview data from a CCM Overview
@@ -74,8 +74,8 @@ type CCMReference struct {
 // CcmCostCategoriesOptions represents options for listing cost categories
 type CCMListCostCategoriesOptions struct {
 	AccountIdentifier string `json:"accountIdentifier,omitempty"`
-	CostCategory string `json:"costCategory,omitempty"`
-	SearchTerm string `json:"search,omitempty"`
+	CostCategory      string `json:"costCategory,omitempty"`
+	SearchTerm        string `json:"search,omitempty"`
 }
 
 // CcmCostCategoryList represents a list of cost categories in CCM
@@ -89,22 +89,22 @@ type CCMCostCategoryList struct {
 // ***************************
 
 type CCMPaginationOptions struct {
-	Limit             int32  `json:"limit,omitempty"`
-	Offset            int32  `json:"offset,omitempty"`
+	Limit  int32 `json:"limit,omitempty"`
+	Offset int32 `json:"offset,omitempty"`
 }
 
 type CCMListCostCategoriesDetailOptions struct {
 	AccountIdentifier string `json:"accountIdentifier,omitempty"`
 	SearchKey         string `json:"searchKey,omitempty"`
-	SortType          string `json:"sortType,omitempty"` // Enum: "NAME", "LAST_EDIT"
+	SortType          string `json:"sortType,omitempty"`  // Enum: "NAME", "LAST_EDIT"
 	SortOrder         string `json:"sortOrder,omitempty"` // Enum: "ASCENDING", "DESCENDING"
 	CCMPaginationOptions
 }
 
 type CCMCostCategoryDetailList struct {
-	MetaData         map[string]interface{}          `json:"metaData"`
-	Resource         CCMCostCategoryResource          `json:"resource"`
-	ResponseMessages []CCMResponseMessage `json:"responseMessages"`
+	MetaData         map[string]interface{}  `json:"metaData"`
+	Resource         CCMCostCategoryResource `json:"resource"`
+	ResponseMessages []CCMResponseMessage    `json:"responseMessages"`
 }
 
 type CCMCostCategoryResource struct {
@@ -113,29 +113,29 @@ type CCMCostCategoryResource struct {
 }
 
 type CCMBusinessMapping struct {
-	UUID           string            `json:"uuid"`
-	Name           string            `json:"name"`
-	AccountID      string            `json:"accountId"`
-	CostTargets    []CCMCostTarget   `json:"costTargets"`
-	SharedCosts    []CCMSharedCost   `json:"sharedCosts"`
+	UUID            string             `json:"uuid"`
+	Name            string             `json:"name"`
+	AccountID       string             `json:"accountId"`
+	CostTargets     []CCMCostTarget    `json:"costTargets"`
+	SharedCosts     []CCMSharedCost    `json:"sharedCosts"`
 	UnallocatedCost CCMUnallocatedCost `json:"unallocatedCost"`
-	DataSources    []string          `json:"dataSources"`
-	CreatedAt      int64             `json:"createdAt"`
-	LastUpdatedAt  int64             `json:"lastUpdatedAt"`
-	CreatedBy      CCMUser           `json:"createdBy"`
-	LastUpdatedBy  CCMUser           `json:"lastUpdatedBy"`
+	DataSources     []string           `json:"dataSources"`
+	CreatedAt       int64              `json:"createdAt"`
+	LastUpdatedAt   int64              `json:"lastUpdatedAt"`
+	CreatedBy       CCMUser            `json:"createdBy"`
+	LastUpdatedBy   CCMUser            `json:"lastUpdatedBy"`
 }
 
 type CCMCostTarget struct {
-	Name  string        `json:"name"`
-	Rules []CCMRule     `json:"rules"`
+	Name  string    `json:"name"`
+	Rules []CCMRule `json:"rules"`
 }
 
 type CCMSharedCost struct {
-	Name      string        `json:"name"`
-	Rules     []CCMRule     `json:"rules"`
-	Strategy  string        `json:"strategy"`
-	Splits    []CCMSplit    `json:"splits"`
+	Name     string     `json:"name"`
+	Rules    []CCMRule  `json:"rules"`
+	Strategy string     `json:"strategy"`
+	Splits   []CCMSplit `json:"splits"`
 }
 
 type CCMUnallocatedCost struct {
@@ -146,7 +146,7 @@ type CCMUnallocatedCost struct {
 }
 
 type CCMSplit struct {
-	CostTargetName        *string  `json:"costTargetName"`
+	CostTargetName         *string  `json:"costTargetName"`
 	PercentageContribution *float64 `json:"percentageContribution"`
 }
 
@@ -162,12 +162,12 @@ type CCMUser struct {
 }
 
 type CCMResponseMessage struct {
-	Code           string                 `json:"code"`
-	Level          string                 `json:"level"`
-	Message        string                 `json:"message"`
-	Exception      *CCMException          `json:"exception"`
-	FailureTypes   []string               `json:"failureTypes"`
-	AdditionalInfo map[string]string      `json:"additionalInfo"`
+	Code           string            `json:"code"`
+	Level          string            `json:"level"`
+	Message        string            `json:"message"`
+	Exception      *CCMException     `json:"exception"`
+	FailureTypes   []string          `json:"failureTypes"`
+	AdditionalInfo map[string]string `json:"additionalInfo"`
 }
 
 type CCMException struct {
@@ -196,13 +196,13 @@ type CCMSuppressed struct {
 
 // CCMCostCategory represents the details of a cost category in CCM
 type CCMCostCategory struct {
-	MetaData         map[string]interface{}	`json:"metaData"`
-	Resource       	 CCMBusinessMapping     `json:"resource"`
-	ResponseMessages []CCMResponseMessage 	`json:"responseMessages"`
+	MetaData         map[string]interface{} `json:"metaData"`
+	Resource         CCMBusinessMapping     `json:"resource"`
+	ResponseMessages []CCMResponseMessage   `json:"responseMessages"`
 }
 
 // CCMGetCostCategoryOptions represents options for listing cost categories
 type CCMGetCostCategoryOptions struct {
 	AccountIdentifier string `json:"accountIdentifier,omitempty"`
-	CostCategoryId string `json:"id,omitempty"`
+	CostCategoryId    string `json:"id,omitempty"`
 }