Why must --files be used when I'm using conf.json?
See original GitHub issueI’m passing -c conf.json to jsdoc2md:
jsdoc2md --template readmeTpl.hbs --no-cache -c doc/conf.json --files lib/* >> README.md
I’d like to include lib/* in doc/conf.json’s source.include below:
"source": {
"include": [
"node_modules/@justinc/jsdocs/typedefs/index.jsdoc",
"node_modules/@justinc/jsdocs/typedefs/Tuple.jsdoc"
]
}
but I can’t do that as jsdoc errors out without --files.
Issue Analytics
- State:
- Created 7 years ago
- Comments:6 (3 by maintainers)
Top Results From Across the Web
Stop Using JSON Config Files - Medium
Mainly because JSON is a data format and JavaScript is just code. Code is evaluable (therefore dynamic) and composable. And there's no need...
Read more >Why JSON isn't a Good Configuration Language - Lucidchart
There are several reasons why JSON is used for configuration files. The biggest reason is probably that it is easy to implement. Many...
Read more >Don't Use JSON as a Configuration File Format ... - Revelry Labs
First, it doesn't allow comments. You may want to explain your configuration or any configuration options. JSON doesn't allow that. There are ...
Read more >The downsides of JSON for config files - arp242.net
I've recently witnessed the trend of using JSON for configuration files ... It's not what JSON was designed to do, and consequently not...
Read more >What does “Use JSON File Config” do? - TapClicks
What does “Use JSON File Config” do? ... The Smart Connector enables you to upload data into TapClicks using nearly any file type...
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

I was not using
*I was usingnode_modules/@justinc/jsdocs/typedefs/{index,Tuple}.hbswhich is workable for this use case but it doesn’t scale if there are other files to include from other modules.I brought this issue up because I thought
jsdoc2mdcan be made better if the user is not required to supply--files/--sourcewhen they’re using a jsdoc config file. CLI opts can be used to overwrite config in the file but why force me to have my config in 2 places.In any case - it’s not a blocker, just a suggestion. … of course there are ways around it
Ok, understood. I thought it was simply a matter of turning off
requiredflags via some option injsdoc2md’s config.🍺