Declare jsArch in the dependency injection system
Kind: global function
| Param | Type | Default | Description |
|---|---|---|---|
| services | Object |
Services (provided by the dependency injector) | |
| services.CONFIG | Object |
The JSArch config | |
| services.EOL | Object |
The OS EOL chars | |
| services.glob | Object |
Globbing service | |
| services.fs | Object |
File system service | |
| services.parser | Object |
Parser service | |
| [services.log] | Object |
noop |
Logging service |
Compile an run a template
Kind: inner method of initJSArch
Returns: Promise.<String> - Computed architecture notes as a markdown file
| Param | Type | Description |
|---|---|---|
| options | Object |
Options (destructured) |
| options.cwd | Object |
Current working directory |
| options.patterns | Object |
Patterns to look files for (see node-glob) |
| options.eol | Object |
End of line character (default to the OS one) |
| options.titleLevel | Object |
The base title level of the output makdown document |
| options.base | Object |
The base directory for the ARCHITECTURE.md references |