refactor: interface naming, and functional options (#101)

* refactor(logger): rename LoggerInterface to Logger

* refactor(worker): add functional options for WorkerPoolOptions

* chore: cleanup go.mod

* chore(lint): allow revive var-naming for internal/ packages to avoid noisy warnings

* test: add benchmarks for processor and worker pool

* refactor(packages): remove nolint comments from package declarations

Author: indaco

.golangci.yaml

@@ -73,6 +73,11 @@ linters:
         linters:
           - gocritic
         text: "stringXbytes"
+      # Internal packages: allow var-naming for packages matching their directory
+      - path: internal/
+        linters:
+          - revive
+        text: "var-naming: avoid"
       # Prealloc is often too noisy for small slices
       - path: \.go$
         linters:

cmd/tempo/synccmd/sync.go

@@ -338,16 +338,16 @@ func resolveSyncFlags(
 	}
 
 	// Worker pool options
-	opts := worker.WorkerPoolOptions{
-		Context:              ctx,
-		InputDir:             inputDir,
-		OutputDir:            outputDir,
-		ExcludeDir:           excludeDir,
-		MarkerName:           cmdCtx.Config.Templates.GuardMarker,
-		NumWorkers:           numWorkers,
-		IsProduction:         isProd,
-		IsForce:              isForce,
-		IsTrackExecutionTime: isTrackExecutionTime,
+	opts, err := worker.NewWorkerPoolOptions(ctx, inputDir, outputDir,
+		worker.WithExcludeDir(excludeDir),
+		worker.WithMarkerName(cmdCtx.Config.Templates.GuardMarker),
+		worker.WithNumWorkers(numWorkers),
+		worker.WithProduction(isProd),
+		worker.WithForce(isForce),
+		worker.WithTrackExecutionTime(isTrackExecutionTime),
+	)
+	if err != nil {
+		return worker.WorkerPoolOptions{}, nil, apperrors.Wrap("invalid worker pool options", err)
 	}
 
 	// Summary options
@@ -375,7 +375,7 @@ func resolveSyncFlags(
 }
 
 func handleSummary(
-	logger logger.LoggerInterface,
+	logger logger.Logger,
 	manager *worker.WorkerPoolManager,
 	processingErrors []worker.ProcessingError,
 	skippedFiles []worker.ProcessingError,

go.mod

@@ -19,7 +19,3 @@ require (
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	golang.org/x/sys v0.39.0 // indirect
 )
-
-// replace (
-// 	github.com/indaco/tempo-api => ../tempo-api
-// )

internal/app/context.go

@@ -6,7 +6,7 @@ import (
 )
 
 type AppContext struct {
-	Logger logger.LoggerInterface
+	Logger logger.Logger
 	Config *config.Config
 	CWD    string
 }

internal/generator/action.go

@@ -246,7 +246,7 @@ func GenerateActionJSONFile(filePath string, actions ActionList) error {
 /* ------------------------------------------------------------------------- */
 
 // GenerateActionFile generates an action file for the given entity type.
-func GenerateActionFile(entityType string, data *TemplateData, actions []Action, logger logger.LoggerInterface) error {
+func GenerateActionFile(entityType string, data *TemplateData, actions []Action, logger logger.Logger) error {
 	actionFileName := fmt.Sprintf("%s.json", entityType)
 	actionsPath := filepath.Join(data.ActionsDir, actionFileName)
 
@@ -260,7 +260,7 @@ func GenerateActionFile(entityType string, data *TemplateData, actions []Action,
 }
 
 // RetrieveActionsFile retrieves actions from a JSON file.
-func RetrieveActionsFile(logger logger.LoggerInterface, actionFilePath string, cfg *config.Config) (JSONActionList, error) {
+func RetrieveActionsFile(logger logger.Logger, actionFilePath string, cfg *config.Config) (JSONActionList, error) {
 	// Step 1: Resolve action file path
 	resolvedPath, err := resolveActionFilePath(cfg.Paths.ActionsDir, actionFilePath)
 	if err != nil {
@@ -283,7 +283,7 @@ func RetrieveActionsFile(logger logger.LoggerInterface, actionFilePath string, c
 }
 
 // ProcessEntityActions retrieves and processes actions from a JSON file.
-func ProcessEntityActions(ctx context.Context, logger logger.LoggerInterface, pathToActionsFile string, data *TemplateData, cfg *config.Config) error {
+func ProcessEntityActions(ctx context.Context, logger logger.Logger, pathToActionsFile string, data *TemplateData, cfg *config.Config) error {
 	// Validate context - use Background as fallback for non-critical operations
 	if ctx == nil {
 		ctx = context.Background()

internal/generator/action_test.go

@@ -871,7 +871,7 @@ func TestProcessEntityActions(t *testing.T) {
 
 	// Override ProcessActionsFunc temporarily
 	originalProcessActions := ProcessActionsFunc
-	ProcessActionsFunc = func(ctx context.Context, logger logger.LoggerInterface, actions []Action, data *TemplateData) error {
+	ProcessActionsFunc = func(ctx context.Context, logger logger.Logger, actions []Action, data *TemplateData) error {
 		// Debugging output
 		for i, action := range actions {
 			t.Logf("DEBUG: Action[%d]: %+v", i, action)

internal/generator/generator.go

@@ -13,7 +13,7 @@ import (
 // ActionProcessor defines the interface for processing actions.
 // This allows for dependency injection and easier testing.
 type ActionProcessor interface {
-	ProcessActions(ctx context.Context, logger logger.LoggerInterface, actions []Action, data *TemplateData) error
+	ProcessActions(ctx context.Context, logger logger.Logger, actions []Action, data *TemplateData) error
 }
 
 // DefaultActionProcessor is the default implementation of ActionProcessor.
@@ -25,7 +25,7 @@ func NewActionProcessor() ActionProcessor {
 }
 
 // ProcessActions implements ActionProcessor.ProcessActions.
-func (p *DefaultActionProcessor) ProcessActions(ctx context.Context, logger logger.LoggerInterface, actions []Action, data *TemplateData) error {
+func (p *DefaultActionProcessor) ProcessActions(ctx context.Context, logger logger.Logger, actions []Action, data *TemplateData) error {
 	return ProcessActions(ctx, logger, actions, data)
 }
 
@@ -44,7 +44,7 @@ var actionHandlers = map[string]ActionHandler{
 var ProcessActionsFunc = ProcessActions
 
 // ProcessActions processes a list of actions using the appropriate handlers.
-func ProcessActions(ctx context.Context, logger logger.LoggerInterface, actions []Action, data *TemplateData) error {
+func ProcessActions(ctx context.Context, logger logger.Logger, actions []Action, data *TemplateData) error {
 	// Validate context - use Background as fallback for non-critical operations
 	if ctx == nil {
 		ctx = context.Background()
@@ -74,7 +74,7 @@ func ProcessActions(ctx context.Context, logger logger.LoggerInterface, actions
 }
 
 // handleDryRun handles the dry-run mode by resolving templates and logging the actions.
-func handleDryRun(logger logger.LoggerInterface, action Action, data *TemplateData) {
+func handleDryRun(logger logger.Logger, action Action, data *TemplateData) {
 	switch action.Item {
 	case "file":
 		// Handle single file addition

internal/git/git.go

@@ -13,10 +13,10 @@ import (
 // GitOperations defines the interface for git operations.
 // This allows for dependency injection and easier testing.
 type GitOperations interface {
-	CloneOrUpdate(repoURL, repoPath string, logger logger.LoggerInterface) error
-	Update(repoPath string, logger logger.LoggerInterface) error
-	Clone(repoURL, repoPath string, logger logger.LoggerInterface) error
-	ForceReclone(repoURL, repoPath string, logger logger.LoggerInterface) error
+	CloneOrUpdate(repoURL, repoPath string, logger logger.Logger) error
+	Update(repoPath string, logger logger.Logger) error
+	Clone(repoURL, repoPath string, logger logger.Logger) error
+	ForceReclone(repoURL, repoPath string, logger logger.Logger) error
 	IsValidRepo(repoPath string) bool
 }
 
@@ -38,7 +38,7 @@ var (
 )
 
 // Default implementation of CloneOrUpdate
-func DefaultCloneOrUpdate(repoURL, repoPath string, logger logger.LoggerInterface) error {
+func DefaultCloneOrUpdate(repoURL, repoPath string, logger logger.Logger) error {
 	if IsValidGitRepo(repoPath) {
 		logger.Info("Updating existing plugin repository").WithAttrs("repo_path", repoPath)
 		return UpdateRepo(repoPath, logger)
@@ -48,14 +48,14 @@ func DefaultCloneOrUpdate(repoURL, repoPath string, logger logger.LoggerInterfac
 }
 
 // Default implementation of UpdateRepo
-func DefaultUpdateRepo(repoPath string, logger logger.LoggerInterface) error {
+func DefaultUpdateRepo(repoPath string, logger logger.Logger) error {
 	logger.Info("Updating existing repository").WithAttrs("repo_path", repoPath)
 	return cmdrunner.RunCommand(repoPath, "git", "pull")
 }
 
 // CloneRepo clones a Git repository into the specified path.
 // It validates the URL and path to prevent command injection attacks.
-func CloneRepo(repoURL, repoPath string, logger logger.LoggerInterface) error {
+func CloneRepo(repoURL, repoPath string, logger logger.Logger) error {
 	// Validate URL to prevent command injection
 	if err := validation.ValidateGitURL(repoURL); err != nil {
 		return apperrors.Wrap("invalid repository URL", err)
@@ -73,7 +73,7 @@ func CloneRepo(repoURL, repoPath string, logger logger.LoggerInterface) error {
 
 // ForceReclone removes an existing repository and re-clones it.
 // It validates the URL and path before performing any operations.
-func ForceReclone(repoURL, repoPath string, logger logger.LoggerInterface) error {
+func ForceReclone(repoURL, repoPath string, logger logger.Logger) error {
 	// Validate URL first (CloneRepo will also validate, but fail fast)
 	if err := validation.ValidateGitURL(repoURL); err != nil {
 		return apperrors.Wrap("invalid repository URL", err)
@@ -103,22 +103,22 @@ func IsValidGitRepo(repoPath string) bool {
 // Interface implementations for DefaultGitOps
 
 // CloneOrUpdate implements GitOperations.CloneOrUpdate.
-func (g *DefaultGitOps) CloneOrUpdate(repoURL, repoPath string, logger logger.LoggerInterface) error {
+func (g *DefaultGitOps) CloneOrUpdate(repoURL, repoPath string, logger logger.Logger) error {
 	return DefaultCloneOrUpdate(repoURL, repoPath, logger)
 }
 
 // Update implements GitOperations.Update.
-func (g *DefaultGitOps) Update(repoPath string, logger logger.LoggerInterface) error {
+func (g *DefaultGitOps) Update(repoPath string, logger logger.Logger) error {
 	return DefaultUpdateRepo(repoPath, logger)
 }
 
 // Clone implements GitOperations.Clone.
-func (g *DefaultGitOps) Clone(repoURL, repoPath string, logger logger.LoggerInterface) error {
+func (g *DefaultGitOps) Clone(repoURL, repoPath string, logger logger.Logger) error {
 	return CloneRepo(repoURL, repoPath, logger)
 }
 
 // ForceReclone implements GitOperations.ForceReclone.
-func (g *DefaultGitOps) ForceReclone(repoURL, repoPath string, logger logger.LoggerInterface) error {
+func (g *DefaultGitOps) ForceReclone(repoURL, repoPath string, logger logger.Logger) error {
 	return ForceReclone(repoURL, repoPath, logger)
 }
 

internal/git/git_test.go

@@ -23,7 +23,7 @@ func TestDefaultCloneOrUpdate(t *testing.T) {
 		originalUpdateRepo := UpdateRepo
 		defer func() { UpdateRepo = originalUpdateRepo }()
 
-		UpdateRepo = func(repoPath string, logger logger.LoggerInterface) error {
+		UpdateRepo = func(repoPath string, logger logger.Logger) error {
 			if repoPath != tempDir {
 				t.Errorf("UpdateRepo called with wrong path: got %s, want %s", repoPath, tempDir)
 			}
@@ -46,7 +46,7 @@ func TestDefaultCloneOrUpdate(t *testing.T) {
 		originalCloneRepo := CloneRepoFunc
 		defer func() { CloneRepoFunc = originalCloneRepo }()
 
-		CloneRepoFunc = func(repoURL, repoPath string, logger logger.LoggerInterface) error {
+		CloneRepoFunc = func(repoURL, repoPath string, logger logger.Logger) error {
 			if repoPath != destRepo {
 				t.Errorf("CloneRepoFunc called with wrong path: got %s, want %s", repoPath, destRepo)
 			}

internal/helpers/entity.go

@@ -10,7 +10,7 @@ import (
 
 // CheckEntityForNew logs a warning or info message when creating a new entity that already exists.
 // It handles both component and variant entity types with appropriate path formatting.
-func CheckEntityForNew(entityType, entityName, outputPath string, force bool, logr logger.LoggerInterface) {
+func CheckEntityForNew(entityType, entityName, outputPath string, force bool, logr logger.Logger) {
 	// Select logging function and action message based on `force` flag
 	logFunc, action := logr.Warning, "Use '--force' to overwrite it. Any changes will be lost."
 	if force {
@@ -32,7 +32,7 @@ func CheckEntityForNew(entityType, entityName, outputPath string, force bool, lo
 }
 
 // CheckEntityForDefine logs a warning or info message when defining templates that already exist.
-func CheckEntityForDefine(entityType, outputPath string, force bool, logr logger.LoggerInterface) {
+func CheckEntityForDefine(entityType, outputPath string, force bool, logr logger.Logger) {
 	// Select logging function and action message based on `force` flag
 	logFunc, action := logr.Warning, "Use '--force' to overwrite them. Any changes will be lost."
 	if force {