AbstractGenerator class
Home > @keymanapp/kmc-generate > AbstractGenerator
AbstractGenerator class
Common functionality for generating projects. Do not instantiate this class, rather instantiate a subclass
Signature:
export declare class AbstractGenerator
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
callbacks |
|
CompilerCallbacks | |
filenameMap |
|
{ [index: string]: string; } | map of all files to be transformed, filled by this class and subclasses |
fullCopyright | protected |
string | extension of options.copyright including copyright year |
includedPrefixes |
|
string[] | identifiers for lines to include when transforming template files, filled by child classes |
options |
|
GeneratorOptions | |
SFile_GitIgnore |
|
(not declared) | |
SFile_HistoryMD |
|
(not declared) | |
SFile_LicenseMD |
|
(not declared) | |
SFile_ReadmeHTM |
|
string | |
SFile_ReadmeMD |
|
(not declared) | |
SFile_WelcomeHTM |
|
string | |
SPath_Source |
|
(not declared) | |
templateBasePath |
|
string | base path for template files in this module |
tokenMap |
|
{ [index: string]: string; } | tokens to rewrite in output files |
Methods
Method | Modifiers | Description |
---|---|---|
defaultArtifacts() | protected |
Fills in the artifact outputPath used by all generators |
init(callbacks, options) | Initialize the generator. Copies options. | |
write(artifacts) | Write artifacts from a successful compile to disk, via callbacks methods. The artifacts written will include all files from the project, across multiple folders. Folders will be created as needed |