Skip to content

Releases: g4s8/envdoc

Fix panic on empty docs

06 Feb 15:40
1b8b8fb
Compare
Choose a tag to compare

What's Changed

Full Changelog: v0.1.1...v0.1.2

Parse anonymous struct fields

06 Feb 12:33
445e54b
Compare
Choose a tag to compare

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`

05 Feb 16:27
caab31a
Compare
Choose a tag to compare

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

  • feat: add envPrefix nested env vars lists by @g4s8 in #4

Full Changelog: v0.0.10...v0.1.0

Complex struct fields and envPrefix

09 Jan 10:07
de77cea
Compare
Choose a tag to compare

Support complex struct fields with envPrefix #2

Field-name params

26 Dec 09:14
23b13f3
Compare
Choose a tag to compare

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

24 Dec 19:03
6dd1141
Compare
Choose a tag to compare
  • 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.

21 Dec 12:35
4b42316
Compare
Choose a tag to compare
  • 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

17 Dec 16:39
90d3254
Compare
Choose a tag to compare

Add a new -format option with 3 supported arguments:

  • markdown (default) - generate markdown documentation
  • plaintext - generate txt file with plain text documentation
  • html - generate documentation as html file

Go doc reference

16 Dec 19:50
03c260a
Compare
Choose a tag to compare

Add go doc reference, add more tests, add coverage reports, add status badges.

Make `-type` arg optional

14 Dec 17:34
c4b93c3
Compare
Choose a tag to compare

In case if -type arg is omitted, this envdoc
processes the next type after go:generate comment.