Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Printing documentation #274

Open
Tracked by #19
ronkorving opened this issue Oct 22, 2018 · 3 comments
Open
Tracked by #19

Printing documentation #274

ronkorving opened this issue Oct 22, 2018 · 3 comments

Comments

@ronkorving
Copy link

ronkorving commented Oct 22, 2018

Thanks for an awesome config library, my new favorite!

How awesome would it be to have an API that would return a human-readable formatted string of the configuration, its meaning and current values?

For example:

console.log(config.describeConfig(['property', 'value', 'doc']));

could output something like:

property value doc
http.host 0.0.0.0 The host to bind the HTTP server to.
http.port 8080 The port to bind the HTTP server to.
debug true Whether debug-mode is enabled.

We have the doc properties, but I feel like we're not getting a lot of mileage out of them without something like this. Would love to get some feedback on this, thanks!

@madarche
Copy link
Collaborator

Hello @ronkorving. A PR on this subject would be welcome.

@ronkorving
Copy link
Author

Thanks, I'm happy to hear that. I'll see if I can find some time to get this going.

@A-312
Copy link
Contributor

A-312 commented Dec 7, 2019

HTML output ? (Don't forget to add description of your feature in the README -> #267)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants