envdoc
envdoc copied to clipboard
g4s8
Go tool to generate documentation for environment variables
Keep current context for `ast.File` in AST parser. Iterate over all files in file-set to traverse with AST parser. For #23
According to multiple requests, it's important to support generating doc from config types located in different files. It could be done by defining a new CLI flag `-project` pointing to...
Consider a project layout such as ``` > config > env.example > CONFIGURATION.md > config.go > models > config.go ``` If the config/config.go imports the models/config.go as part of its...
Hello! I'm trying to make documentation out of a structure There is a config.Config structure, and nested structures in different packages ```go package config //go:generate go run github.com/g4s8/envdoc@latest -output environments.md...
Hi, I really like the purpose of this tool. However, I am unsure how to create one md file or one env file from all our config files across our...
version used: 1.0.0 go version 1.22.6 ```go //go:generate envdoc --output environment.md -all type Appconfig struct { // Environment, has some effects on logging. Options are: production, debug, development Environment string...
Add more tests for: - [ ] AST parser - [ ] AST collectors - [ ] Renderer _Originally posted by @g4s8 in https://github.com/g4s8/envdoc/issues/24#issuecomment-2257794134_
Hi! Could you check the compatibility with the github.com/ilyakaznacheev/cleanenv module. It seems to me that the env syntax definition is similar to github.com/caarlos0/env.
The current implementation does not support pkg aliases on imports: ``` package test type Config struct { Prefix string `env:"PREFIX"` } ``` ``` import ( testfoo test ) type Config...
- Enable Windows CI build - Fix Windows file path separator Fix: #43