[docs]: Add documentation for scan options in welcome.md
ravut8 opened this issue · 0 comments
ravut8 commented
Overview
The new scanned options for the VueScanner
class method not yet documented so users may not know they are available. Here are the 3 added options
verbose
- to provide detailed scanning log from the consoleignore
- to allow users to specify file paths and/or directories to be excluded from scanningoutput
- by default, the scan will output the component profiles in JSON format. Another export format is STDOUT.
Expected Behavior
- Add explanations for
VueScannerOption Interface
andOutputFormat Type
before the 5-step section.