Compare commits

...

4 Commits

Author SHA1 Message Date
Austin Nicholas eee440fa28
Merge 7e279f03c6 into bcbe6173c3 2024-11-21 13:32:06 +00:00
Sam Myres bcbe6173c3
Merge pull request #95 from dmarkham/samiam2013/readme-revision
Note in the readme and flag that trimprefix accepts lists
2024-10-03 19:12:26 -05:00
samiam2013 0abe832021 note in the readme and flag help description that trimprefix accepts lists 2024-10-03 19:06:09 -05:00
Austin Nicholas 7e279f03c6 Added 'dot' and 'dot-upper' transformers 2022-07-02 10:10:54 -04:00
5 changed files with 81 additions and 13 deletions

View File

@ -7,9 +7,9 @@ This was again forked here as (https://github.com/dmarkham/enumer) picking up wh
``` ```
$ ./enumer --help $ enumer --help
Enumer is a tool to generate Go code that adds useful methods to Go enums (constants with a specific type). Enumer is a tool to generate Go code that adds useful methods to Go enums (constants with a specific type).
Usage of ./enumer: Usage of enumer:
Enumer [flags] -type T [directory] Enumer [flags] -type T [directory]
Enumer [flags] -type T files... # Must be a single package Enumer [flags] -type T files... # Must be a single package
For more information, see: For more information, see:
@ -34,11 +34,11 @@ Flags:
-transform string -transform string
enum item name transformation method. Default: noop (default "noop") enum item name transformation method. Default: noop (default "noop")
-trimprefix string -trimprefix string
transform each item name by removing a prefix. Default: "" transform each item name by removing a prefix or comma separated list of prefixes. Default: ""
-type string -type string
comma-separated list of type names; must be set comma-separated list of type names; must be set
-values -values
if true, alternative string values method will be generated. Default: false if true, alternative string values method will be generated. Default: false
-yaml -yaml
if true, yaml marshaling methods will be generated. Default: false if true, yaml marshaling methods will be generated. Default: false
``` ```
@ -183,6 +183,8 @@ name := MyTypeValue.String() // name => "my_type_value"
- snake-upper - snake-upper
- kebab - kebab
- kebab-upper - kebab-upper
- dot (dot.case)
- dot-upper (DOT.CASE)
- lower (lowercase) - lower (lowercase)
- upper (UPPERCASE) - upper (UPPERCASE)
- title (TitleCase) - title (TitleCase)
@ -208,7 +210,8 @@ Possible transform values are listed above in the [transformers](#transformers)
The default value for `transform` flag is `noop` which means no transformation will be performed. The default value for `transform` flag is `noop` which means no transformation will be performed.
If a prefix is provided via the `trimprefix` flag, it will be trimmed from the start of each name (before If a prefix is provided via the `trimprefix` flag, it will be trimmed from the start of each name (before
it is transformed). If a name doesn't have the prefix it will be passed unchanged. it is transformed). You can trim multiple prefixes by passing a comma separated list.
If a name doesn't have the prefix it will be passed unchanged.
If a prefix is provided via the `addprefix` flag, it will be added to the start of each name (after trimming and after transforming). If a prefix is provided via the `addprefix` flag, it will be added to the start of each name (after trimming and after transforming).

View File

@ -4,6 +4,7 @@
// go command is not available on android // go command is not available on android
//go:build !android
// +build !android // +build !android
package main package main
@ -89,6 +90,12 @@ func TestEndToEnd(t *testing.T) {
case "transform_kebab_upper.go": case "transform_kebab_upper.go":
typeName = "KebabUpperCaseValue" typeName = "KebabUpperCaseValue"
transformNameMethod = "kebab-upper" transformNameMethod = "kebab-upper"
case "transform_dot.go":
typeName = "DotCaseValue"
transformNameMethod = "dot"
case "transform_dot_upper.go":
typeName = "DotUpperCaseValue"
transformNameMethod = "dot-upper"
case "transform_upper.go": case "transform_upper.go":
typeName = "UpperCaseValue" typeName = "UpperCaseValue"
transformNameMethod = "upper" transformNameMethod = "upper"

View File

@ -53,7 +53,7 @@ var (
altValuesFunc = flag.Bool("values", false, "if true, alternative string values method will be generated. Default: false") altValuesFunc = flag.Bool("values", false, "if true, alternative string values method will be generated. Default: false")
output = flag.String("output", "", "output file name; default srcdir/<type>_string.go") output = flag.String("output", "", "output file name; default srcdir/<type>_string.go")
transformMethod = flag.String("transform", "noop", "enum item name transformation method. Default: noop") transformMethod = flag.String("transform", "noop", "enum item name transformation method. Default: noop")
trimPrefix = flag.String("trimprefix", "", "transform each item name by removing a prefix. Default: \"\"") trimPrefix = flag.String("trimprefix", "", "transform each item name by removing a prefix or comma separated list of prefixes. Default: \"\"")
addPrefix = flag.String("addprefix", "", "transform each item name by adding a prefix. Default: \"\"") addPrefix = flag.String("addprefix", "", "transform each item name by adding a prefix. Default: \"\"")
linecomment = flag.Bool("linecomment", false, "use line comment text as printed text when present") linecomment = flag.Bool("linecomment", false, "use line comment text as printed text when present")
) )
@ -343,6 +343,14 @@ func (g *Generator) transformValueNames(values []Value, transformMethod string)
fn = func(s string) string { fn = func(s string) string {
return strings.ToUpper(name.Delimit(s, '-')) return strings.ToUpper(name.Delimit(s, '-'))
} }
case "dot":
fn = func(s string) string {
return strings.ToLower(name.Delimit(s, '.'))
}
case "dot_upper", "dot-upper":
fn = func(s string) string {
return strings.ToUpper(name.Delimit(s, '.'))
}
case "upper": case "upper":
fn = func(s string) string { fn = func(s string) string {
return strings.ToUpper(s) return strings.ToUpper(s)
@ -774,9 +782,9 @@ func (g *Generator) buildOneRun(runs [][]Value, typeName string) {
} }
// Arguments to format are: // Arguments to format are:
// [1]: type name // [1]: type name
// [2]: size of index element (8 for uint8 etc.) // [2]: size of index element (8 for uint8 etc.)
// [3]: less than zero check (for signed types) // [3]: less than zero check (for signed types)
const stringOneRun = `func (i %[1]s) String() string { const stringOneRun = `func (i %[1]s) String() string {
if %[3]si >= %[1]s(len(_%[1]sIndex)-1) { if %[3]si >= %[1]s(len(_%[1]sIndex)-1) {
return fmt.Sprintf("%[1]s(%%d)", i) return fmt.Sprintf("%[1]s(%%d)", i)
@ -786,10 +794,10 @@ const stringOneRun = `func (i %[1]s) String() string {
` `
// Arguments to format are: // Arguments to format are:
// [1]: type name // [1]: type name
// [2]: lowest defined value for type, as a string // [2]: lowest defined value for type, as a string
// [3]: size of index element (8 for uint8 etc.) // [3]: size of index element (8 for uint8 etc.)
// [4]: less than zero check (for signed types) // [4]: less than zero check (for signed types)
const stringOneRunWithOffset = `func (i %[1]s) String() string { const stringOneRunWithOffset = `func (i %[1]s) String() string {
i -= %[2]s i -= %[2]s
if %[4]si >= %[1]s(len(_%[1]sIndex)-1) { if %[4]si >= %[1]s(len(_%[1]sIndex)-1) {

25
testdata/transform_dot.go vendored Normal file
View File

@ -0,0 +1,25 @@
package main
import "fmt"
type DotCaseValue int
const (
DotCaseValueOne DotCaseValue = iota
DotCaseValueTwo
DotCaseValueThree
)
func main() {
ck(DotCaseValueOne, "dot.case.value.one")
ck(DotCaseValueTwo, "dot.case.value.two")
ck(DotCaseValueThree, "dot.case.value.three")
ck(-127, "DotCaseValue(-127)")
ck(127, "DotCaseValue(127)")
}
func ck(value DotCaseValue, str string) {
if fmt.Sprint(value) != str {
panic("transform_dot.go: " + str)
}
}

25
testdata/transform_dot_upper.go vendored Normal file
View File

@ -0,0 +1,25 @@
package main
import "fmt"
type DotUpperCaseValue int
const (
DotUpperCaseValueOne DotUpperCaseValue = iota
DotUpperCaseValueTwo
DotUpperCaseValueThree
)
func main() {
ck(DotUpperCaseValueOne, "DOT.UPPER.CASE.VALUE.ONE")
ck(DotUpperCaseValueTwo, "DOT.UPPER.CASE.VALUE.TWO")
ck(DotUpperCaseValueThree, "DOT.UPPER.CASE.VALUE.THREE")
ck(-127, "DotUpperCaseValue(-127)")
ck(127, "DotUpperCaseValue(127)")
}
func ck(value DotUpperCaseValue, str string) {
if fmt.Sprint(value) != str {
panic("transform_dot_upper.go: " + str)
}
}