Readonly
argsA completed args object for this instance.
Readonly
clrColour used for colour-coding this stage.
Readonly
configComplete project configuration.
Readonly
nameName for this stage used for notices.
Readonly
paramsCurrent 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.
Optional
subDir: DistDirectorySub-path to get.
Optional additional subpaths.
Gets an absolute path to the Config.Paths.scripts directories.
Optional
subDir: "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.
Optional
subDir: 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.
Default content for an empty, markdown changelog file.
Default content for an empty, markdown release notes file.
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.
Optional
errMsg: stringSee logError.Args.errMsg.
Optional
date: 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.
Protected
atryExperimental
If 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.
Protected
handleAlias for errorHandler.
Error to handle.
Depth level for output to the console.
Optional
args: Partial<AbstractError.Handler.Args>Overrides for default options.
Protected
tryExperimental
If 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.
Experimental
If the tryer
function has params, then they are required.
If the handler must exit, then 'FAILED' is not possible.
Experimental
If the tryer
function has no params, then they are optional.
If the handler won't exit, then 'FAILED' is possible.
Experimental
If 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.
Readonly
subAll 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.
Protected
runProtected
runUsed to run a single stage within this class; used by AbstractStage.run.
Protected
startRuns the prompters to confirm before starting the substages.
Protected
changelogAdd updates in the release notes file to the changelog.
Protected
commitGit commits files changed and created during build and package.
Protected
githubUses GitHub API to update repo meta and draft a release.
Protected
packageRuns the project's package class.
Protected
replaceReplaces package placeholders in the source.
Protected
tidyResets the release notes file.
Readonly
compilerInstance used to compile files from the src directory.
Readonly
consoleInstance 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.
Optional
subDir: 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.
Default release stage.
Since
0.1.0-alpha