Current project config.
Current CLI params.
Partial overrides for the default args.
Optionalpkg: PackageJsonParsed contents of the project’s package.json file.
Optionalversion: SemVerVersion object for the project’s version.
Readonlyargs{@inheritDoc Stage.args}
Readonlyclr{@inheritDoc Stage.clr}
Readonlyconfig{@inheritDoc Stage.config}
Readonlyname{@inheritDoc Stage.name}
Readonlyparams{@inheritDoc Stage.params}
ReadonlysubAll sub-stages to run in this stage (in order).
Readonlycompiler{@inheritDoc Stage.compiler}
Readonlyconsole{@inheritDoc Stage.console}
Protected ReadonlyastroStatictypeReturns external symbol mappings for TypeDoc.
{@inheritDoc Stage.ARGS_DEFAULT}
ReadonlyentryPoints: nullReadonlyreplace: (_stage: Stage) => { current: string[]; ignore: string[]; package: string[] }ReadonlytypeDoc: (_stage: Stage) => Partial<Omit<typeDoc.TypeDocOptions, "entryPoints">>This is DocumentStage.typeDocConfig.
Readonlyutils: {}Path to release directory for building a package for the current version.
{@inheritDoc Stage.pkg}
{@inheritDoc Stage.version}
If undefined, nothing is set. Otherwise, a SemVer is created and the value of AbstractStage.pkg.version is updated.
{@inheritDoc Stage.fs}
{@inheritDoc Stage.fs}
{@inheritDoc Stage.isDraftVersion}
StatictypeReturns a default TypeDoc configuration object. For use as Stage.Args.Document.typeDoc.
{@inheritDoc Stage.getDistDir}
OptionalsubDir: DistDirectory{@inheritDoc Stage.getScriptsPath}
OptionalsubDir: "logs"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.
OptionalsubDir: string[]Subdirectories used for the path to write the log file.
Optionaldate: Date | nullUsed for the timestamp.
If false, writing the log failed. Otherwise, this is the path to the written log file.
ProtectedhandleAlias for errorHandler.
Error to handle.
Depth level for output to the console.
Optionalargs: Partial<Args>Overrides for default options.
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.
{@inheritDoc Stage.startEndNotice}
OptionalwatcherVersion: booleanProtectedrunExperimentalThis 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.
OptionallogLevelBase: numberBase output level for log messages.
ProtectedrunRuns the given stage as a sub-stage to the current one.
This method should probably not be overwritten.
Depth level for output to the console.
ProtectedrunUsed to run a single stage within this class; used by AbstractStage.run.
ProtectedreplaceReplaces placeholders in the built files and directories.
ProtectedtypeRuns TypeDoc to auto-document typescript.
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.
Optionalignore: string[]Globs to ignore while replacing. Default FileSystem.globs.SYSTEM.
OptionaldocsMode: booleanWhether to make the replacements in 'docs' mode (i.e., assumes markdown in comments was converted to HTML).
Paths where placeholders were replaced.
ProtectedastroProtectedatryIf 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.
ProtectedrunThis 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: SassDeprecated overload here for forward-compatibility. Please use the overload above instead.
OptionaldistDir: stringOptionalpostCSS: booleanOptionallogLevelBase: numberOptionalsassOpts: SassProtectedsassHandles errors thrown during sass compile.
Optionalargs: Partial<Args>ProtectedscssProtectedtryIf 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.
If the tryer function has params, then they are required.
If the handler must exit, then 'FAILED' is not possible.
If the tryer function has no params, then they are optional.
If the handler won't exit, then 'FAILED' is possible.
Extension of the built-in one.
Since
0.1.0-alpha