goca interfaces

Generate interface contracts for Test-Driven Development.

Syntax

goca interfaces <EntityName> [flags]

Description

Generates only the interface contracts without implementations, perfect for TDD workflows where you define contracts first.

Flags

--usecase

Generate use case interfaces.

goca interfaces Product --usecase

--repository

Generate repository interfaces.

goca interfaces User --repository

--all

Generate all interfaces.

goca interfaces Order --all

--handler

Generate handler interfaces.

goca interfaces Product --handler

--dry-run

Preview files without writing anything.

goca interfaces EntityName --dry-run

--force

Overwrite existing files.

goca interfaces EntityName --force

--backup

Back up existing files before overwriting.

goca interfaces EntityName --backup

Examples

Use Case Interfaces

goca interfaces Product --usecase

Generates: internal/interfaces/product_usecase.go

package interfaces

import "context"

type ProductUseCase interface {
    Create(ctx context.Context, input CreateProductInput) (*ProductResponse, error)
    GetByID(ctx context.Context, id uint) (*ProductResponse, error)
    Update(ctx context.Context, id uint, input UpdateProductInput) error
    Delete(ctx context.Context, id uint) error
    List(ctx context.Context) ([]*ProductResponse, error)
}

Repository Interfaces

goca interfaces User --repository

Generates: internal/interfaces/user_repository.go

package interfaces

import (
    "context"
    "myproject/internal/domain"
)

type UserRepository interface {
    Save(ctx context.Context, user *domain.User) error
    FindByID(ctx context.Context, id uint) (*domain.User, error)
    FindAll(ctx context.Context) ([]*domain.User, error)
    Update(ctx context.Context, user *domain.User) error
    Delete(ctx context.Context, id uint) error
}

All Interfaces

goca interfaces Order --all

TDD Workflow

1. Generate Interfaces:

   goca interfaces Payment --all

2. Write Tests:

   func TestPaymentService_CreatePayment(t *testing.T) {
       mockRepo := &MockPaymentRepository{}
       service := NewPaymentService(mockRepo)
       // ... test implementation
   }

3. Implement: Implement the actual service and repository.

See Also

• goca usecase - Generate full use cases
• goca repository - Generate repositories