To convert a Config type to a Config.Internal type, use the internal.internalConfig function.
Readonly
clrDefault output colour to the terminal.
Readonly
compilerOptional arguments to use when constructing Stage.Compiler.
Readonly
consoleOptional arguments to use when constructing Logger.
Readonly
fsOptional arguments to use when constructing FileSystem.
Readonly
launchA four-digit year string representing the launch date of the project.
Readonly
pathsPaths to files or directories.
Absolute or relative to node’s cwd.
Readonly
replacePlaceholders to be replaced during the build processes.
Readonly
stagesAll build stages and whether or not they run, including custom implementations.
If true, the default class is run. If false, it is not run at all.
Readonly
titleProject’s human-friendly name in title case.
Protected
Static
defaultA “local” “cache” of default config values, used primarily for ProjectConfig.export.
Used to export the default config to write a config file when one did not exist.
Gets a path to the Config.Paths.dist directories.
Instance used to work with paths and files.
Optional
subDir: DistDirectorySub-path to get.
Optional additional subpaths.
Relative path.
0.1.0-alpha — Previously defined in ProjectConfig class.
Gets a path to the Config.Paths.scripts directories.
Instance used to work with paths and files.
Optional
subDir: "logs"Sub-path to get.
Optional additional subpaths.
Relative path.
0.1.0-alpha — Previously defined in ProjectConfig class.
Gets a path to the Config.Paths.src directories.
Overloaded for more accurate typing:
Instance used to work with paths and files.
Sub-path to get.
Optional additional subpaths.
Relative path.
0.1.0-alpha — Previously defined in ProjectConfig class.
Internal
Optional
subDir: SourceDirectoryGets the instance for the given stage.
An array with first the stage’s class and then the configured arguments for that class, or undefined if that class is disabled by the config.
0.1.0-alpha — Previously defined in ProjectConfig class.
Returns the minimum required properties of this config.
Useful for creating stripped-down or default configuration objects.
The minimum required properties for this config.
0.1.0-alpha — Previously defined in ProjectConfig class.
The object shape used when converting to JSON.
0.1.0-alpha — Previously defined in ProjectConfig class.
Overrides the default function to return a string representation of this object.
0.1.0-alpha — Previously defined in ProjectConfig class.
A super-simple class just for the configuration of the project.
Since
0.1.0-alpha
Since
0.1.0-alpha.1 — Now implements Config.Class instead of Config.Internal.