Merge pull request #1438 from go-gorm/feat/gentool-default-tag

feat(gentool): add fieldWithDefaultTag option

Author: qqxhb

tools/gentool/README.ZH_CN.md

@@ -29,6 +29,8 @@
         generate field with gorm index tag
   -fieldWithTypeTag
         generate field with gorm column type tag
+  -fieldWithDefaultTag
+        generate field with gorm default tag
   -modelPkgName string
         generated model code's package name
   -outFile string
@@ -82,6 +84,10 @@ default ""
 
 使用gorm列类型标记生成字段
 
+#### fieldWithDefaultTag
+
+使用gorm默认值标记生成字段
+
 #### modelPkgName
 
 默认值是数据表名称。
@@ -131,4 +137,4 @@ Value : False / True
 
 ```shell
 gentool -dsn "user:pwd@tcp(127.0.0.1:3306)/database?charset=utf8mb4&parseTime=True&loc=Local" -tables "orders,doctor"
-```
+```

tools/gentool/README.md

@@ -27,6 +27,8 @@ Install GEN as a binary tool
         generate field with gorm index tag
   -fieldWithTypeTag
         generate field with gorm column type tag
+  -fieldWithDefaultTag
+        generate field with gorm default tag
   -modelPkgName string
         generated model code's package name
   -outFile string
@@ -80,6 +82,10 @@ generate field with gorm index tag
 
 generate field with gorm column type tag
 
+#### fieldWithDefaultTag
+
+generate field with gorm default tag
+
 #### modelPkgName
 
 defalut table name.
@@ -126,4 +132,4 @@ detect integer field's unsigned type, adjust generated data type
 
 ```shell
 gentool -dsn "user:pwd@tcp(127.0.0.1:3306)/database?charset=utf8mb4&parseTime=True&loc=Local" -tables "orders,doctor"
-```
+```

tools/gentool/gen.yml

@@ -28,5 +28,7 @@ database:
   fieldWithIndexTag : false
   # generate field with gorm column type tag
   fieldWithTypeTag  : false
+  # generate field with gorm default tag
+  fieldWithDefaultTag : false
   # detect integer field's unsigned type, adjust generated data type
   fieldSignable  : false

tools/gentool/gentool.go

@@ -34,19 +34,20 @@ const (
 
 // CmdParams is command line parameters
 type CmdParams struct {
-	DSN               string   `yaml:"dsn"`               // consult[https://gorm.io/docs/connecting_to_the_database.html]"
-	DB                string   `yaml:"db"`                // input mysql or postgres or sqlite or sqlserver. consult[https://gorm.io/docs/connecting_to_the_database.html]
-	Tables            []string `yaml:"tables"`            // enter the required data table or leave it blank
-	OnlyModel         bool     `yaml:"onlyModel"`         // only generate model
-	OutPath           string   `yaml:"outPath"`           // specify a directory for output
-	OutFile           string   `yaml:"outFile"`           // query code file name, default: gen.go
-	WithUnitTest      bool     `yaml:"withUnitTest"`      // generate unit test for query code
-	ModelPkgName      string   `yaml:"modelPkgName"`      // generated model code's package name
-	FieldNullable     bool     `yaml:"fieldNullable"`     // generate with pointer when field is nullable
-	FieldCoverable    bool     `yaml:"fieldCoverable"`    // generate with pointer when field has default value
-	FieldWithIndexTag bool     `yaml:"fieldWithIndexTag"` // generate field with gorm index tag
-	FieldWithTypeTag  bool     `yaml:"fieldWithTypeTag"`  // generate field with gorm column type tag
-	FieldSignable     bool     `yaml:"fieldSignable"`     // detect integer field's unsigned type, adjust generated data type
+	DSN                 string   `yaml:"dsn"`                 // consult[https://gorm.io/docs/connecting_to_the_database.html]"
+	DB                  string   `yaml:"db"`                  // input mysql or postgres or sqlite or sqlserver. consult[https://gorm.io/docs/connecting_to_the_database.html]
+	Tables              []string `yaml:"tables"`              // enter the required data table or leave it blank
+	OnlyModel           bool     `yaml:"onlyModel"`           // only generate model
+	OutPath             string   `yaml:"outPath"`             // specify a directory for output
+	OutFile             string   `yaml:"outFile"`             // query code file name, default: gen.go
+	WithUnitTest        bool     `yaml:"withUnitTest"`        // generate unit test for query code
+	ModelPkgName        string   `yaml:"modelPkgName"`        // generated model code's package name
+	FieldNullable       bool     `yaml:"fieldNullable"`       // generate with pointer when field is nullable
+	FieldCoverable      bool     `yaml:"fieldCoverable"`      // generate with pointer when field has default value
+	FieldWithIndexTag   bool     `yaml:"fieldWithIndexTag"`   // generate field with gorm index tag
+	FieldWithTypeTag    bool     `yaml:"fieldWithTypeTag"`    // generate field with gorm column type tag
+	FieldWithDefaultTag bool     `yaml:"fieldWithDefaultTag"` // generate field with gorm default tag
+	FieldSignable       bool     `yaml:"fieldSignable"`       // detect integer field's unsigned type, adjust generated data type
 }
 
 func (c *CmdParams) revise() *CmdParams {
@@ -153,6 +154,7 @@ func argParse() *CmdParams {
 	fieldCoverable := flag.Bool("fieldCoverable", false, "generate with pointer when field has default value")
 	fieldWithIndexTag := flag.Bool("fieldWithIndexTag", false, "generate field with gorm index tag")
 	fieldWithTypeTag := flag.Bool("fieldWithTypeTag", false, "generate field with gorm column type tag")
+	fieldWithDefaultTag := flag.Bool("fieldWithDefaultTag", false, "generate field with gorm default tag")
 	fieldSignable := flag.Bool("fieldSignable", false, "detect integer field's unsigned type, adjust generated data type")
 	flag.Parse()
 
@@ -198,6 +200,9 @@ func argParse() *CmdParams {
 	if *fieldWithTypeTag {
 		cmdParse.FieldWithTypeTag = *fieldWithTypeTag
 	}
+	if *fieldWithDefaultTag {
+		cmdParse.FieldWithDefaultTag = *fieldWithDefaultTag
+	}
 	if *fieldSignable {
 		cmdParse.FieldSignable = *fieldSignable
 	}
@@ -217,15 +222,16 @@ func main() {
 	}
 
 	g := gen.NewGenerator(gen.Config{
-		OutPath:           config.OutPath,
-		OutFile:           config.OutFile,
-		ModelPkgPath:      config.ModelPkgName,
-		WithUnitTest:      config.WithUnitTest,
-		FieldNullable:     config.FieldNullable,
-		FieldCoverable:    config.FieldCoverable,
-		FieldWithIndexTag: config.FieldWithIndexTag,
-		FieldWithTypeTag:  config.FieldWithTypeTag,
-		FieldSignable:     config.FieldSignable,
+		OutPath:             config.OutPath,
+		OutFile:             config.OutFile,
+		ModelPkgPath:        config.ModelPkgName,
+		WithUnitTest:        config.WithUnitTest,
+		FieldNullable:       config.FieldNullable,
+		FieldCoverable:      config.FieldCoverable,
+		FieldWithIndexTag:   config.FieldWithIndexTag,
+		FieldWithTypeTag:    config.FieldWithTypeTag,
+		FieldWithDefaultTag: config.FieldWithDefaultTag,
+		FieldSignable:       config.FieldSignable,
 	})
 
 	g.UseDB(db)