Open pmeijer opened 1 year ago
Have we looked at other libraries that could help us here? I just want to make sure we aren't re-inventing the wheel :)
Also, are we planning on updating the generated documentation to include this?
No but that’s a good point. I’m just adding the requirements I had in mind here to open up a discussion about it. Yes it should generate the docs. Probably also add a test that checks that the docs are in sync with the latest config file. Any suggestions are welcomed.
The
./config/config.default.js
should contain the documentation as well as the default values.Suggestion is to augment the json structure with metadata such as
doc
,type
,category
,value
etc. When requiring the file as a config - the structure should be transformed back into the regular config format.Depending on the category the config variables would be listed from "default", "advanced", "cli".
Example of how the format could look like: