gormmom

README

gormmom

Empowering Native Language Programming, Simplifying GORM Tag Generation

---

gormmom is a tool designed to automatically generate GORM tags, aimed at helping developers program in their native language while simplifying the process of defining GORM tags. The tool processes struct fields and automatically generates GORM-compliant tags, ensuring field names follow specific naming conventions.

---

CHINESE README

中文说明

---

Features

• Automatic GORM Tag Generation: Automatically generates GORM tags for struct fields, such as column, index, unique, etc.
• Native Language Programming Support: Allows developers to define struct fields in their native language (e.g., Chinese), reducing the difficulty of understanding business.

---

Installation

go get github.com/yyle88/gormmom

---

Usage Example

Original Code (Native Language Programming)

type Example struct {
    V证号 string `gorm:"primaryKey"`
    V姓名 string `gorm:"index"`
    V年龄 int    `gorm:"unique"`
    V性别 bool   `gorm:"column:sex;uniqueIndex" mom:"naming:S63"`
}

Generated Code (Automatic GORM Tag Generation)

type Example struct {
    V证号 string `gorm:"column:v_c18b_f753;primaryKey" mom:"naming:s63;"`
    V姓名 string `gorm:"column:v_d359_0d54;index:idx_example_v_d359_0d54" mom:"naming:s63;idx:cnm;"`
    V年龄 int    `gorm:"column:v_745e_849f;unique" mom:"naming:s63;"`
    V性别 bool   `gorm:"column:V_2760_2B52;uniqueIndex:udx_example_V_2760_2B52" mom:"naming:S63;udx:cnm;"`
}

---

Configuration Options

• naming: Configures the naming convention for database column names.
• idx: Configures the naming convention for single-column indexes.
• udx: Configures the naming convention for single-column unique indexes.

---

Design Ideas

README OLD DOC

---

License

gormmom is open-source and released under the MIT License. See the LICENSE file for more information.

---

Support

Welcome to contribute to this project by submitting pull requests or reporting issues.

If you find this package helpful, give it a star on GitHub!

Thank you for your support!

Happy Coding with gormmom! 🎉

Give me stars. Thank you!!!

See stars

Documentation

Index

• type Config
  • func NewConfig(schemaCache *SchemaCache, options *Options) *Config
  • func (cfg *Config) GenReplace()
  • func (cfg *Config) GetNewCode() []byte
• type ConfigBatch
  • func NewConfigBatch(schemaCaches []*SchemaCache, options *Options) *ConfigBatch
  • func (c *ConfigBatch) GenReplaces()
• type Options
  • func NewOptions() *Options
  • func (opt *Options) WithColumnNamePatternFieldName(columnNamePatternFieldName string) *Options
  • func (opt *Options) WithColumnNamingStrategies(pattern gormmomname.ColumnNamePattern, naming gormmomname.Naming) *Options
  • func (opt *Options) WithDefaultColumnNamePattern(pattern gormmomname.ColumnNamePattern) *Options
  • func (opt *Options) WithIndexNamingStrategies(pattern gormidxname.IndexNamePattern, naming gormidxname.Naming) *Options
  • func (opt *Options) WithNamingTagName(namingTagName string) *Options
  • func (opt *Options) WithRenewIndexName(renewIndexName bool) *Options
  • func (opt *Options) WithSkipBasicNaming(skipBasicNaming bool) *Options
• type SchemaCache
  • func NewSchemaCache(sourcePath string, structName string, sch *schema.Schema) *SchemaCache
  • func NewSchemaCacheV2[T any](sourcePath string) *SchemaCache
  • func NewSchemaCacheV3(sourcePath string, object interface{}) *SchemaCache
  • func NewSchemaCaches(root string, objects []interface{}) []*SchemaCache
  • func (a *SchemaCache) Validate()

Types

type Config

type Config struct {
	// contains filtered or unexported fields
}

func NewConfig

func NewConfig(schemaCache *SchemaCache, options *Options) *Config

func (*Config) GenReplace

func (cfg *Config) GenReplace()

func (*Config) GetNewCode

func (cfg *Config) GetNewCode() []byte

type ConfigBatch

type ConfigBatch struct {
	// contains filtered or unexported fields
}

func NewConfigBatch

func NewConfigBatch(schemaCaches []*SchemaCache, options *Options) *ConfigBatch

func (*ConfigBatch) GenReplaces

func (c *ConfigBatch) GenReplaces()

type Options

type Options struct {
	// contains filtered or unexported fields
}

func NewOptions

func NewOptions() *Options

func (*Options) WithColumnNamePatternFieldName

func (opt *Options) WithColumnNamePatternFieldName(columnNamePatternFieldName string) *Options

func (*Options) WithColumnNamingStrategies

func (opt *Options) WithColumnNamingStrategies(pattern gormmomname.ColumnNamePattern, naming gormmomname.Naming) *Options

func (*Options) WithDefaultColumnNamePattern

func (opt *Options) WithDefaultColumnNamePattern(pattern gormmomname.ColumnNamePattern) *Options

func (*Options) WithIndexNamingStrategies

func (opt *Options) WithIndexNamingStrategies(pattern gormidxname.IndexNamePattern, naming gormidxname.Naming) *Options

func (*Options) WithNamingTagName

func (opt *Options) WithNamingTagName(namingTagName string) *Options

func (*Options) WithRenewIndexName

func (opt *Options) WithRenewIndexName(renewIndexName bool) *Options

func (*Options) WithSkipBasicNaming

func (opt *Options) WithSkipBasicNaming(skipBasicNaming bool) *Options

type SchemaCache

type SchemaCache struct {
	// contains filtered or unexported fields
}

func NewSchemaCache

func NewSchemaCache(sourcePath string, structName string, sch *schema.Schema) *SchemaCache

NewSchemaCache 创建参数信息

func NewSchemaCacheV2

func NewSchemaCacheV2[T any](sourcePath string) *SchemaCache

NewSchemaCacheV2 使用泛型创建参数信息。T 只能传类型名称而非带指针的类型名

func NewSchemaCacheV3

func NewSchemaCacheV3(sourcePath string, object interface{}) *SchemaCache

NewSchemaCacheV3 使用对象创建参数信息 object 传对象或者对象指针都行

func NewSchemaCaches

func NewSchemaCaches(root string, objects []interface{}) []*SchemaCache

func (*SchemaCache) Validate

func (a *SchemaCache) Validate()