Analysis
Description of Analysis Class.
Analysis
Static Members
▸
Architecture(directory)
Parse the structure of the Vue application and its components.
Parameters
directory (any)
The directory from which to read .vue files.
Returns
Promise<Array<Object>>
:
An array of objects containing properties related to the application structure.
Parse parent-child relationships between components.
ParentChild(directory: any):
Promise<[]>
Parameters
directory (any)
The directory from which to read .vue files.
Returns
Promise<[]>
:
An array of objects with parent & child properties - one for each nested relationship.
Exports
Description of Exports Class.
Exports
Static Members
▸
ExportParentChild(directory)
Parse & export parent-child relationships between components to JSON.
ExportParentChild(directory: any):
Boolean
Parameters
directory (any)
The directory from which to read .vue files.
Returns
Boolean
:
True if the file export succeeded, false if there was an error.
▸
ExportArchitecture(directory)
Parse & export structural relationships between components to JSON.
ExportArchitecture(directory: any):
Boolean
Parameters
directory (any)
The directory from which to read .vue files.
Returns
Boolean
:
True if the file export succeeded, false if there was an error.
Files
Description of Files Class.
Files
Static Members
Get all the Vue files in the input directory (collects files in nested folders too).
Parameters
directory (any)
The directory to search for .vue files in.
Returns
Promise<Array<String>>
:
An array of file paths of .vue files.
Get the raw text data of a file.
Parameters
filePath (any)
The path the file is at.
Returns
string
:
Raw text content of the file.
Classes
Get the css classes in the the .vue file.
Parameters
fileString (any)
The raw text content (string) of the file.
Returns
Array<String>
:
An array of css classes strings from the .vue file.
IdSelectors
Get the css id selectors in the the .vue file.
Parameters
fileString (any)
The raw text content (string) of the file.
Returns
Array<String>
:
An array of css id selector strings from the .vue file.
Description of MetaDataES6 Class.
MetaDataES6
Static Members
Description of MetaDataVue Class.
MetaDataVue
Static Members