Globally installed node module that will help you automatically generate files and update existing .vue files with relevant information to auto-populate your vue repository for vue-styleguidist
- In your terminal, run
npm i @vue-styleguidist-auto-commenter -gto install this globally for use on any vue projects within your system
- Install vue-styleguidist by following their docs and configuration setup as this project will not automate installing the core settings and module
-D or --dry (set by default) Drymode no files will be generated only previewed of what will be done
-l or --live Ready to create your files? Turn on this flag to actually process things and create/edit files automagically
-P [value] or --path [value] Provide the path to the source file you want to run this in (recursively). Default is set to /
-A or --absolute Use this flag when your value you're using in --path will be absolute and not relative to where you are in the system
-R or --report (Set by Default) Enables a report to be generated in dry and live mode
-X or --report-location Sets a new location for where your report will be saved. If you use the --absolute flag the report location will ALSO need to be absolute. (Report location default is ./ )
-H or --help Will provide you some help options (like a repeat of this menu :) )
There's a few options for running this but essentially:
-
open your vue project in a terminal and make sure you're in the root of the project
-
run
auto-styleguidstorautoguidein your terminal to preview the files that will be created including their contents -
Default run will NOT create any files or modify anything but only create a report of what will happen if you pass the
--liveflag -
Open the report in
./Reports/vue-auto-guide-report.htmlto see the changes -
Once you confirmed it looks good, you can pass
auto-styleguidst --liveand it will generate all the files necessary to auto populate your vue project