search

wallabyjs / public

Repository for Wallaby.js questions and issues
http://wallabyjs.com
760 stars 45 forks source link

enhancement: explicit configuration API documentation #2503

Open boneskull opened 4 years ago

boneskull commented 4 years ago

Hi,

Sometimes, I find myself struggling to find what I'm looking for on wallabyjs.com/docs. While the "guide" format is helpful, it'd be great to have a more "terse" view of all available configuration options, say in a table:

Option Default Type Description
runMode "automatic" "onsave"\|"automatic" Whether to run tests as you type ("automatic") or only on file save ("onsave")
debug false boolean If true, print extra debugging info in the Wallaby Console

Also, maybe a search box would be nice, but a search engine can usually take care of this fine.

Thanks!

smcenlly commented 4 years ago

Thanks for the suggestion for the condensed form for settings, we like the idea. We'll take a look over the next few weeks.

I think for now, we'll probably leave search via a search engine.