posener / goreadme

Generate readme file from Go doc. Now available as a Github action!
MIT License
213 stars 31 forks source link

Add -render-type-content option to render full type content instead of an ellipsis (`{ ... }`) #129

Closed alexandregv closed 3 months ago

alexandregv commented 4 months ago

Adds a -render-type-content bool flag which allows to control wether you want to replace types content with an ellipsis or not.
It defaults to false, to keep the current behavior.

Example with -render-type-content=true:

type Config struct { ... }

becomes

type Config struct {
    Username      string `json:"username"`
    Password      string `json:"password"`
}
codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 69.87%. Comparing base (8283e66) to head (1ef7e79). Report is 1 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #129 +/- ## ======================================= Coverage 69.87% 69.87% ======================================= Files 3 3 Lines 83 83 ======================================= Hits 58 58 Misses 15 15 Partials 10 10 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

posener commented 3 months ago

Maybe add a test? Also update pr text? Thanks!

alexandregv commented 3 months ago

Just added a test, and changed PR text.