ReadonlyargsA completed args object for this instance.
ReadonlyclrColour used for colour-coding this stage.
ReadonlyconfigComplete project configuration.
ReadonlynameName for this stage used for notices.
ReadonlyparamsCurrent CLI params.
Default args for this stage.
Path to release directory for building a package for the current version.
Gets the paths from the config for the given dist sub directory.
OptionalsubDir: DistDirectorySub-path to get.
Optional additional subpaths.
Gets an absolute path to the Config.Paths.scripts directories.
OptionalsubDir: "logs"Sub-path to get.
Optional additional subpaths.
If there's a subdir, the return will be an array of strings.
Sub-path to get.
Optional additional subpaths.
If there's no subdir, the return will be a string.
OptionalsubDir: undefinedSub-path to get.
Optional additional subpaths.
Whether the given substage should be run according to the values of CLI.Params.only and CLI.Params.without.
Whether to run this sub-stage.
Alias for internal.logError.
Message to prepend to the return for output to the console.
Caught error to log.
Depth level for output to the console.
OptionalerrMsg: stringSee logError.Args.errMsg.
Optionaldate: DateUsed for the timestamp.
Alias for internal.writeLog.
Log message to write.
File name for the log.
Subdirectories used for the path to write the log file.
Used for the timestamp.
If false, writing the log failed. Otherwise, this is the path to the written log file.
ProtectedatryExperimentalIf the tryer function has no params, then they are optional.
If the handler must exit, then 'FAILED' is not possible.
The tryer function’s return, or 'FAILED' if an error is caught
and the process isn’t exited.
ProtectedhandleAlias for errorHandler.
Error to handle.
Depth level for output to the console.
Optionalargs: Partial<AbstractError.Handler.Args>Overrides for default options.
ProtectedtryExperimentalIf the tryer function has no params, then they are optional.
If the handler must exit, then 'FAILED' is not possible.
The tryer function’s return, or 'FAILED' if an error is caught
and the process isn’t exited.
ExperimentalIf the tryer function has params, then they are required.
If the handler must exit, then 'FAILED' is not possible.
ExperimentalIf the tryer function has no params, then they are optional.
If the handler won't exit, then 'FAILED' is possible.
ExperimentalIf the tryer function has params, then they are required.
Wheather the current project version is a draft (e.g., this is not a non-dryrun release).
Current value of the package.json file for this project.
Current version object for the project.
If undefined, nothing is set. Otherwise, a SemVer is created and the value of AbstractStage.pkg.version is updated.
ReadonlysubAll sub-stages to run in this stage (in order).
Runs the entire stage (asynchronously).
This method should probably not be overwritten, except in completely custom class implementations.
Cycles through each substage and runs AbstractStage.runSubStage if AbstractStage.isSubStageIncluded returns true.
Prints a message to the console signalling the start or end of this build stage.
Whether we are starting or ending.
ProtectedrunExperimentalThis runs a custom sub-stage that only copies a whole folder at the given subpath from the source to the dist directories.
Deletes any existing, logs update messages, etc.
The subdriectory, relative to src path.
Optional_distDir: stringOptionally force a diffrent output directory than the auto-generated one.
Base output level for log messages.
ProtectedrunExperimentalThis runs a custom sub-stage that uses globs to find non-partial scss/sass files and compile them at the given subpath from the source to the dist directories.
Deletes any existing, logs update messages, etc.
The subdirectory, relative to src path.
OptionaldistDir: stringForce a diffrent output directory than the auto-generated one.
Optionalopts: Partial<Opts>Additional options. See AbstractStage.runCustomScssDirSubStage.DEFAULT_OPTS for defaults.
OptionallogLevelBase: numberBase output level for log messages. Default 1.
OptionalsassOpts: SassExperimentalDeprecated overload here for forward-compatibility. Please use the overload above instead.
OptionaldistDir: stringOptionalpostCSS: booleanOptionallogLevelBase: numberOptionalsassOpts: Sass0.2.0-alpha.2 — Please pass an AbstractStage.runCustomScssDirSubStage.Opts object as the third param instead.
ProtectedrunProtectedrunUsed to run a single stage within this class; used by AbstractStage.run.
ProtectedfilesCopies files to the dist directory.
ProtectedscssCompiles scss files to css.
ProtectedtsCompiles typescript to javascript.
ReadonlycompilerInstance used to compile files from the src directory.
ReadonlyconsoleInstance used to send messages to the console.
Instance used to deal with files and paths.
If there's a subdir, the return will be an array of strings.
Sub-path to get.
Optional additional subpaths.
If there's no subdir, the return will be a string.
OptionalsubDir: undefinedSub-path to get.
Optional additional subpaths.
Replaces placeholders in files as defined by Config.replace.
Where to find & replace placeholders.
Which version of the replacements to run.
Depth level for output to the console.
Globs to ignore while replacing. Default FileSystem.globs.SYSTEM.
Whether to make the replacements in 'docs' mode (i.e., assumes markdown in comments was converted to HTML).
Paths where placeholders were replaced.
ProtectedsassHandles errors thrown during sass compile.
Optionalargs: Partial<AbstractError.Handler.Args>
Default compile stage.
Since
0.1.0-alpha