directory

type BasicServiceLayout struct {
	Options *option.Options

	OutputPath string

	APIBasePath string

	CommandBasePath    string
	InternalBasePath   string
	InternalConfigPath string
	ServiceBashPath    string
	ConfigBasePath     string
	BuildBasePath      string
	DeployBasePath     string
}

type GRPCLayout struct {
	BasicServiceLayout
}

type GRPCServiceLayout interface {
	ServiceLayout

	// GetMainFilePath returns the main.go file path, e.g.: /.../cmd/main.go
	GetMainFilePath() string
	// GetAPIProtobufBasePath returns the API protobuf root directory path, e.g.: /.../api/protobuf_spec
	GetAPIProtobufBasePath() string
	// GetAPIProtobufPath returns the specific API directory path, e.g.: /.../api/protobuf_spec/health_check
	GetAPIProtobufPath(protoPath string) string
	// GetAPIProtobufFilePath returns the specific API file path, e.g.: /.../api/protobuf_spec/health_check/health_check.proto
	GetAPIProtobufFilePath(protoFile string) string

	// GetGRPCServiceBasePath returns the gRPC gateway directory path, e.g.: /.../internal/service/grpc
	GetGRPCServiceBasePath() string
	// GetGRPCServicePath returns the specific gRPC gateway directory path, e.g.: /.../internal/service/grpc/health_check
	GetGRPCServicePath(service string) string
	// GetGRPCServiceFilePath returns the specific gRPC gateway service file path, e.g.: /.../internal/service/grpc/health_check/health_check.go
	GetGRPCServiceFilePath(service string) string
	// GetGRPCRPCFilePath returns the specific gRPC gateway RPC file path, e.g.: /.../internal/service/grpc/health_check/check.go
	GetGRPCRPCFilePath(service, RPC string) string

	// GetConfigGoBasePath returns the config path, e.g.: /.../internal/config
	GetConfigGoBasePath() string
	// GetConfigGoFilePath returns the config.go file path, e.g.: /.../internal/config/config.go
	GetConfigGoFilePath() string
	// GetConfigYAMLFilePath returns the gofra.yaml file path, e.g.: /.../configs/gofra.yaml
	GetConfigYAMLFilePath() string
	// GetConfigPackageName returns the package name of config, e.g.: github.com/foo/bar/internal/config
	GetConfigPackageName(goModule string) string

	// GetPackageAlias returns the alias of specific package name
	GetPackageAlias(packageName string) string
	// GetServicePackagePath returns the package path of specific service
	GetServicePackagePath(goModule, service string) string
	// GetProtoPackagePath returns the package path of specific proto file
	GetProtoPackagePath(goModule, protoFile string) string
	// GetServiceRegisterStub returns the stub of specific service of proto
	GetServiceRegisterStub(protoFile, serviceName string) string
	// GetServiceImportStub returns the service import line of code
	GetServiceImportStub(goModule, service string) string
	// GetProtoImportStub returns the proto import line of code
	GetProtoImportStub(goModule, protoPath string) string
}

type Layout interface {
	Save() error
	String() string
}

type ServiceLayout interface {
	Layout

	// GetOutputPath returns root output directory path, e.g.: /...
	GetOutputPath() string
	// GetGoModuleFilePath returns the go.mod file path, e.g.: /.../go.mod
	GetGoModuleFilePath() string
	// GetCommandBasePath returns the cmd root path, e.g.: /.../cmd
	GetCommandBasePath() string
	// GetAPIBasePath returns the API root directory path, e.g.: /.../api
	GetAPIBasePath() string
	// GetInternalBasePath returns the internal root path, e.g.: /.../internal
	GetInternalBasePath() string
	// GetServiceBasePath returns the cmd root path, e.g.: /.../internal/service
	GetServiceBasePath() string
	// GetConfigYAMLBasePath returns the internal root path, e.g.: /.../configs
	GetConfigYAMLBasePath() string
	// GetBuildBasePath returns the cmd root path, e.g.: /.../build
	GetBuildBasePath() string
	// GetDeployBasePath returns the internal root path, e.g.: /.../deploy
	GetDeployBasePath() string
}