readyou / jsdoc-toolkit

Automatically exported from code.google.com/p/jsdoc-toolkit
0 stars 0 forks source link

Scans through errors before failing due to missing template. #207

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
# What steps will reproduce the problem?
1. Run the program without specifying a template with the -t option.

# What is the expected output? What do you see instead?

I would expect to be warned that the options were incorrect before the
program ran; instead, it scanned through hundreds of files before telling
me it couldn't do anything because I hadn't specified a template.

Alternatively, it should use a default template if none is specified.

# What version of the product are you using? On what operating system?

$Id: run.js 756 2009-01-07 21:32:58Z micmath $

Running on Fedora Linux 8, x86 platform.

Original issue reported on code.google.com by b...@subvert.org.uk on 24 Feb 2009 at 10:01

GoogleCodeExporter commented 9 years ago
I agree, the *existence* of the template could be checked before parsing, 
however it wouldn't be possible to 
detect *errors* in the template at that point, so it would be a limited safety 
net. I'd suggest trying the template 
out on one or two source files first to quickly do that sort of sanity check.

BTW: there are some combinations of command line options that will work as 
expected without a -t option, so 
the check probably isn't as simple as you expect, but it should still be 
possible.

Original comment by micmath on 24 Feb 2009 at 1:54