Releases: g4s8/envdoc
Fix panic on empty docs
What's Changed
Full Changelog: v0.1.1...v0.1.2
Parse anonymous struct fields
Bug #5 fixed (thanks @nics) by #6 - If the field is envPrefix
-ed anonymous structure, then we parse it as common struct type, but it'll not be added to the full type list in case if -all
flag is set.
Full Changelog: v0.1.0...v0.1.1
Nested Lists for `envPrefix`
In this release, we've introduced nested lists for envPrefix
-ed structures in the generated documentation. This enhancement improves the clarity and organization of environment variable documentation, making it easier to understand the relationships between settings. You can now quickly identify the structure of configuration options within your Go applications. You can check it in examples dir (envprefix*
files).
What's Changed
Full Changelog: v0.0.10...v0.1.0
Complex struct fields and envPrefix
Support complex struct fields with envPrefix
#2
Field-name params
If -field-names
flag is set, envdoc
will handle field names as environment variables names, converting them from camel to snake case.
All types, env prefix, type docs, HTML styles
- add
-no-styles
flag for HTML docs - add type comment as doc paragraph
- env prefix parameter
- add
-all
flag to generate docs for all types - use field comment if doc string is empty
Array fields, templates, and styles.
- Add support for array types and custom separators.
- Use Go templates for generating documentation.
- Add nice styles to HTML docs.
- Improve examples
- Add more tests (85% coverage)
Add html and plaintext output formats
Add a new -format
option with 3 supported arguments:
markdown
(default) - generate markdown documentationplaintext
- generate txt file with plain text documentationhtml
- generate documentation as html file
Go doc reference
Add go doc reference, add more tests, add coverage reports, add status badges.
Make `-type` arg optional
In case if -type
arg is omitted, this envdoc
processes the next type after go:generate
comment.