Support a config file format that allows for comments
See original GitHub issueThere’s a few ways this can be done, but wanted to open an issue to kick off some discussion.
Overall the idea is that it would be useful if a config format that allowed for comments would be supported, since then you could annotate white listings:
{
"path-whitelist": [
// not patchable at this time
"1486|laravel-mix>webpack-dev-server>http-proxy-middleware>http-proxy"
]
}
Personally I’m a fan of JSON5, which has 1 dependency, but people also seem to like YAML for which there is YAML that has no dependencies (if you’re considered about that).
Another possible solution as a middle ground could be to support piping in a config, which would let you do json5 audit-ci.json | audit-ci
.
Thoughts?
Issue Analytics
- State:
- Created 3 years ago
- Comments:8 (4 by maintainers)
Top Results From Across the Web
The 3 Best Config File Formats - Jonathan Hall
A good configuration file format is easy for a human to read and edit. As with code, readability of configuration is an essential...
Read more >Configuration file format that recognizes comments as a part of ...
I am trying to decide which settings format to use for my application. The config files will be modified from within the application....
Read more >Comments in configuration files - BMC Documentation
To enter comments in a configuration file, use a comment character and enter the comment text anywhere to the right of the comment...
Read more >How to Pick Right Configuration File Type for Your Project
Find out which file types I use for certain scenarios and which situations suit a specific file type best. We'll dive into JSON,...
Read more >More Comment-Preserving Configuration Parsers - Kevin Burke
First, allowing programs to read/write configuration files allows for automated cleanup/manipulation. Go ships with a first-class parser/AST ...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
#197 should do the trick 👍🏻
+1 for the JSON 5 comment support idea.