addon

Documentation

Index

• func AddMiddlewareLine(targetDir, line string) error
• func AddRouteLine(targetDir, routeLine, routeLabel string) error
• func AppendEnvValue(targetDir, line string) error
• func CommonBaseFiles() map[string]string
• func DetectModulePath(targetDir string) (string, error)
• func EnsureImport(path, anchor, importLine string) error
• func InsertAfter(path, anchor, block, label string) error
• func Install(opts Options) error
• func List() []string
• func RegisterModule(def ModuleDefinition)
• type ModuleDefinition
• type Options
• type TemplateData

Functions

func AddMiddlewareLine

func AddMiddlewareLine(targetDir, line string) error

AddMiddlewareLine 向中间件链注入一行，供自定义模块使用

func AddRouteLine

func AddRouteLine(targetDir, routeLine, routeLabel string) error

AddRouteLine 向路由注册注入一行，供自定义模块使用

func AppendEnvValue

func AppendEnvValue(targetDir, line string) error

AppendEnvValue 向 .env.example 追加一行配置，供自定义模块使用

func CommonBaseFiles

func CommonBaseFiles() map[string]string

CommonBaseFiles 返回自定义模块常用的基础文件（日志模块），供 generated module 使用

func DetectModulePath

func DetectModulePath(targetDir string) (string, error)

DetectModulePath 从 go.mod 中检测模块路径，供自定义模块使用

func EnsureImport

func EnsureImport(path, anchor, importLine string) error

EnsureImport 确保导入语句存在，供自定义模块使用

func InsertAfter

func InsertAfter(path, anchor, block, label string) error

InsertAfter 在锚点行之后插入代码块，供自定义模块使用

func Install

func Install(opts Options) error

func List

func List() []string

func RegisterModule

func RegisterModule(def ModuleDefinition)

RegisterModule 注册自定义模块，供 internal/addon/modules/ 下的 init() 调用

Types

type ModuleDefinition

type ModuleDefinition struct {
	Name      string
	Files     map[string]string
	BaseFiles map[string]string
	PatchFunc func(targetDir string) error
}

ModuleDefinition 自定义模块定义，通过 init() 注册到全局注册表

type Options

type Options struct {
	ModuleName   string
	TargetDir    string
	Force        bool
	SkipExisting bool
}

type TemplateData

type TemplateData struct {
	ModulePath  string
	ProjectName string
}