github.com/dmji/go-stringer

Aboud go-stringer

Fork of https://github.com/golang/tools/blob/master/cmd/stringer/stringer.go

Forked on commit: 28cd7188fd2c8f3ede85d4b7a6734cc426422094 ref Unfortunately, I don't know how to fork only cmd/stringer, so there is no direct connection and it seems impossible to synchronize changes automatically.

Motivation

To extend the generator functional to get automatically the text in the format I need and an additional function that returns enum value by text.

Changes from original

• Subjective improvements
  • For my comfort, the monolithic stringer.go is divided into component files
  • Added samples for each generator builder case
  • Added flag target to make it easier to run debug on samples
• Improved file naming of output files in case no special name defined
  • Added flag outputtransform to convert strings of file names in similar way as names example: originally it generate type PatternRuneWithRange by default as 'patternrunewithrange_string.go' but i want to get it as 'pattern_rune_with_range_string.go'
• Improved string content generation
  • Added flag nametransform to convert strings from the original name to the one I need using github.com/gobeam/stringy my pet project required a snake case and I didn't want to do it by hand
• Added new optional stage to generate function go parse enum from string
  • Added flag fromstringgenfn to activate generation of ${TypeName}FromString() functions
• Added new optional stage to generate extra consts in format {Prefix}{PackageName}{TypeValue}{Suffix}, to active it required to define one of activation flag below
  • Added flag extraconstsnamesuffix to append custom text to the end of string id (first of activation flag)
  • Added flag extraconstsnameprefix to append custom text before the const name (second of activation flag)
  • Added flag extraconstsvaluetransform convert string id format similar to nametransform (optional)
  • Added flag extraconstsvaluesuffix to append some text to each const value (optional)
• Added new optional stage to generate marshalling and unmarshalling functions for specific packages
  • Added flag marshaljson to append implementations of json.Marshaler and json.Unmarshaler
  • Added flag marshaljsonpkg to specify url to json package if using forked version or similar
  • Added flag marshalqs to append implementations of qs.MarshalQS and qs.UnmarshalQS
  • Added flag marshalqspkg to specify url to qs package if using forked version or similar

How to use

Install:

go install github.com/dmji/go-stringer@latest

Information about flags can be query with execution without parameters:

go-stringer

Sample of generage comment:

package main

//go:generate go-stringer -type=SimpleRune -trimprefix=SimpleRune -linecomment=true -nametransform=snake_case_lower -outputtransform=snake_case_lower -extraconstsnamesuffix=_i18n_ID -extraconstsvaluetransform=snake_case_lower -extraconstsvaluesuffix=Presentation

type SimpleRune int16

const (
	SimpleRuneFirst SimpleRune = iota
	SimpleRuneSecond
	SimpleRuneThird
	SimpleRuneFourth
)