Merge pull request #51 from g4s8/i28

feat: add ilyakaznacheev/cleanenv support

Author: g4s8

README.md

@@ -47,6 +47,7 @@ type Config struct {
  * `-dir` (path string, *optional*) - Specify the directory to search for files. Default is the file dir with `go:generate` command.
  * `-files` (glob string, *optional*) - File glob pattern to specify file names to process. Default is the single file with `go:generate`.
  * `-types` (glob string, *optional*) - Type glob pattern for type names to process. If not specified, the next type after `go:generate` is used.
+ * `-target` (`enum(caarlos0, cleanenv)` string, optional, default `caarlos0`) - Set env library target.
  * `-output` (path string, **required**) - Output file name for generated documentation.
  * `-format` (`enum(markdown, plaintext, html, dotenv, json)` string, *optional*) - Output format for documentation.  Default is `markdown`.
  * `-no-styles` (`bool`, *optional*) - If true, CSS styles will not be included for `html` format.
@@ -96,6 +97,7 @@ See [_examples](./_examples/) dir for more details.
 
 This tool is compatible with
 - full compatibility: [caarlos0/env](https://github.com/caarlos0/env)
+- full compatibility: [ilyakaznacheev/cleanenv](https://github.com/ilyakaznacheev/cleanenv)
 - partial compatibility: [sethvargo/go-envconfig](https://github.com/sethvargo/go-envconfig)
 - partial compatibility: [joeshaw/envdecode](https://github.com/joeshaw/envdecode)
 

_examples/cleanenv/config.go

@@ -0,0 +1,24 @@
+package main
+
+// Config is an example configuration structure.
+// It is used to generate documentation for the configuration
+// using the commands below.
+//
+//go:generate go run ../../ -output doc.txt -target cleanenv -format plaintext
+type Config struct {
+	// Hosts name of hosts to listen on.
+	Hosts []string `env:"HOST" env-required:"true" env-separator:";"`
+	// Port to listen on.
+	Port int `env:"PORT"`
+
+	// Debug mode enabled.
+	Debug bool `env:"DEBUG" env-default:"false"`
+
+	// Timeouts configuration.
+	Timeouts struct {
+		// Read timeout.
+		Read int `env:"READ" env-default:"10"`
+		// Write timeout.
+		Write int `env:"WRITE" env-default:"10"`
+	} `env-prefix:"TIMEOUT_"`
+}

_examples/cleanenv/doc.txt

@@ -0,0 +1,15 @@
+Environment Variables
+
+## Config
+
+Config is an example configuration structure.
+It is used to generate documentation for the configuration
+using the commands below.
+
+ * `HOST` (separated by `;`, required) - Hosts name of hosts to listen on.
+ * `PORT` - Port to listen on.
+ * `DEBUG` (default: `false`) - Debug mode enabled.
+ * Timeouts configuration.
+   * `TIMEOUT_READ` (default: `10`) - Read timeout.
+   * `TIMEOUT_WRITE` (default: `10`) - Write timeout.
+

ast/decoder.go

@@ -30,6 +30,8 @@ type Config struct {
 	NoStyles bool
 	// FieldNames flag enables field names usage intead of `env` tag.
 	FieldNames bool
+	// Target is the target type
+	Target types.TargetType
 
 	// TagName sets custom tag name, `env` by default.
 	TagName string
@@ -53,6 +55,8 @@ func (c *Config) parseFlags(f *flag.FlagSet) error {
 	f.StringVar(&c.Dir, "dir", "", "Dir to search for files, default is the file dir with go:generate command")
 	f.StringVar(&c.FileGlob, "files", "", "FileGlob to filter by file name")
 	f.StringVar(&c.TypeGlob, "types", "", "Type glob to filter by type name")
+	var target string
+	f.StringVar(&target, "target", "caarlos0", "Target type, default `caarlos0`")
 	// output flags
 	f.StringVar(&c.OutFile, "output", "", "Output file path")
 	f.StringVar((*string)(&c.OutFormat), "format", "markdown", "Output format, default `markdown`")
@@ -89,6 +93,12 @@ func (c *Config) parseFlags(f *flag.FlagSet) error {
 		return errors.New("flags -type and -types can't be used together")
 	}
 
+	targetType, err := types.ParseTargetType(target)
+	if err != nil {
+		return fmt.Errorf("parse target type: %w", err)
+	}
+	c.Target = targetType
+
 	// check for deprecated flags
 	var deprecatedWarning strings.Builder
 	if typeName != "" {