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](./kmc-generate.abstractgenerator.callbacks.md) | `protected` `readonly` | CompilerCallbacks | |
| [filenameMap](./kmc-generate.abstractgenerator.filenamemap.md) | `protected` `readonly` | { \[index: string\]: string; } | map of all files to be transformed, filled by this class and subclasses |
| [fullCopyright](./kmc-generate.abstractgenerator.fullcopyright.md) | `protected` | string | extension of options.copyright including copyright year |
| [includedPrefixes](./kmc-generate.abstractgenerator.includedprefixes.md) | `protected` `readonly` | string\[\] | identifiers for lines to include when transforming template files, filled by child classes |
| [options](./kmc-generate.abstractgenerator.options.md) | `protected` `readonly` | [GeneratorOptions](./kmc-generate.generatoroptions.md) | |
| [SFile\_GitIgnore](./kmc-generate.abstractgenerator.sfile_gitignore.md) | `protected` `static` `readonly` | (not declared) | |
| [SFile\_HistoryMD](./kmc-generate.abstractgenerator.sfile_historymd.md) | `protected` `static` `readonly` | (not declared) | |
| [SFile\_LicenseMD](./kmc-generate.abstractgenerator.sfile_licensemd.md) | `protected` `static` `readonly` | (not declared) | |
| [SFile\_ReadmeHTM](./kmc-generate.abstractgenerator.sfile_readmehtm.md) | `protected` `static` `readonly` | string | |
| [SFile\_ReadmeMD](./kmc-generate.abstractgenerator.sfile_readmemd.md) | `protected` `static` `readonly` | (not declared) | |
| [SFile\_WelcomeHTM](./kmc-generate.abstractgenerator.sfile_welcomehtm.md) | `protected` `static` `readonly` | string | |
| [SPath\_Source](./kmc-generate.abstractgenerator.spath_source.md) | `protected` `static` `readonly` | (not declared) | |
| [templateBasePath](./kmc-generate.abstractgenerator.templatebasepath.md) | `protected` `readonly` | string | base path for template files in this module |
| [tokenMap](./kmc-generate.abstractgenerator.tokenmap.md) | `protected` `readonly` | { \[index: string\]: string; } | tokens to rewrite in output files |
Methods
| Method | Modifiers | Description |
|---|---|---|
| [defaultArtifacts()](./kmc-generate.abstractgenerator.defaultartifacts.md) | `protected` | Fills in the artifact outputPath used by all generators |
| [init(callbacks, options)](./kmc-generate.abstractgenerator.init.md) | Initialize the generator. Copies options. | |
| [write(artifacts)](./kmc-generate.abstractgenerator.write.md) | 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 |
