envgen

README

envgen

Utility to parse golang env structures into .env files.

Getting started

1. Download swag by using:

go install github.com/Batyachelly/envgen/cmd/envgen@latest

1. Run envgen in the project's root folder which contains a config files.

envgen -target=example/config.go -structs=Config,AnotherConfig1,AnotherConfig2 -output_dir example/generated

Documentation

Index

• Variables
• func DefaultMarshal(envs []Env) []byte
• type Env
• type EnvFile
• type EnvFiles
  • func (efs EnvFiles) Save(outputDir string) error
  • func (efs EnvFiles) SaveWithCustomMarshal(outputDir string, marshal func([]Env) []byte) error
• type EnvParser
  • func NewParserFromASTObjects(objects map[string]*ast.Object) EnvParser
  • func NewParserFromFile(filePath string) (EnvParser, error)
  • func NewParserFromReader(r io.Reader) (EnvParser, error)
  • func (ep EnvParser) FindStructs(targetStructs []string) (EnvParser, error)
  • func (ep EnvParser) ParseFields() EnvFiles

Variables

var ErrInvalidASTObjectType = errors.New("invalid type")

ErrInvalidASTObjectType ast object has a type different from the type declaration.

Functions

func DefaultMarshal

func DefaultMarshal(envs []Env) []byte

DefaultMarshal default marshal function.

Types

type Env

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

type EnvFile

type EnvFile struct {
	Envs []Env
}

type EnvFiles

type EnvFiles map[string]EnvFile

func (EnvFiles) Save

func (efs EnvFiles) Save(outputDir string) error

Save saves parsed environment variables to files using the DefaultMarshal.

func (EnvFiles) SaveWithCustomMarshal

func (efs EnvFiles) SaveWithCustomMarshal(outputDir string, marshal func([]Env) []byte) error

SaveWithCustomMarshal saves parsed environment variables to files using the received function.

type EnvParser

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

EnvParser implement envs parsing from .go file.

func NewParserFromASTObjects

func NewParserFromASTObjects(objects map[string]*ast.Object) EnvParser

NewParserFromASTObjects creates a new parser based on the AST object map.

func NewParserFromFile

func NewParserFromFile(filePath string) (EnvParser, error)

NewParserFromFile creates a new parser based on the .go file.

func NewParserFromReader

func NewParserFromReader(r io.Reader) (EnvParser, error)

NewParserFromReader creates a new parser based on data from the io.Reader.

func (EnvParser) FindStructs

func (ep EnvParser) FindStructs(targetStructs []string) (EnvParser, error)

FindStructs filters structures leaving only those specified in the argument.

func (EnvParser) ParseFields

func (ep EnvParser) ParseFields() EnvFiles

ParseFields parse structs to EnvFiles.