Home > @rushstack/heft

heft package

Heft is a config-driven toolchain that invokes other popular tools such as TypeScript, ESLint, Jest, Webpack, and API Extractor. You can use it to build web applications, Node.js services, command-line tools, libraries, and more.

Classes

Class	Description
HeftConfiguration

Interfaces

Interface	Description
ICopyOperation	Used to specify a selection of files to copy from a specific source folder to one or more destination folders.
IDeleteOperation	Used to specify a selection of source files to delete from the specified source folder.
IFileSelectionSpecifier	Used to specify a selection of one or more files.
IGlobOptions	A supported subset of options used when globbing files.
IHeftDefaultParameters	The default parameters provided by Heft.
IHeftLifecycleCleanHookOptions	Options provided to the clean hook.
IHeftLifecycleHooks	Hooks that are available to the lifecycle plugin.
IHeftLifecyclePlugin	The interface that Heft lifecycle plugins must implement. Lifecycle plugins are used to provide functionality that affects the lifecycle of the Heft run. As such, they do not belong to any particular Heft phase.
IHeftLifecycleSession	The lifecycle session is responsible for providing session-specific information to Heft lifecycle plugins. The session provides access to the hooks that Heft will run as part of lifecycle execution, as well as access to parameters provided via the CLI. The session is also how you request access to other lifecycle plugins.
IHeftLifecycleToolFinishHookOptions	Options provided to the toolFinish hook.
IHeftLifecycleToolStartHookOptions	Options provided to the toolStart hook.
IHeftParameters	Parameters provided to a Heft plugin.
IHeftParsedCommandLine	The type of IHeftTaskSession.parsedCommandLine, which exposes details about the command line that was used to invoke Heft.
IHeftPhase
IHeftPhaseFinishHookOptions
IHeftPhaseOperationMetadata	Metadata for an operation that represents a phase.
IHeftPhaseStartHookOptions
IHeftPlugin	The interface used for all Heft plugins.
IHeftRecordMetricsHookOptions
IHeftTask
IHeftTaskFileOperations	Options provided to the registerFileOperations hook.
IHeftTaskFinishHookOptions
IHeftTaskHooks	Hooks that are available to the task plugin.
IHeftTaskOperationMetadata	Metadata for an operation that represents a task.
IHeftTaskPlugin	The interface that Heft task plugins must implement. Task plugins are used to provide the implementation of a specific task.
IHeftTaskRunHookOptions	Options provided to the run hook.
IHeftTaskRunIncrementalHookOptions	Options provided to the 'runIncremental' hook.
IHeftTaskSession	The task session is responsible for providing session-specific information to Heft task plugins. The session provides access to the hooks that Heft will run as part of task execution, as well as access to parameters provided via the CLI. The session is also how you request access to other task plugins.
IHeftTaskStartHookOptions
IIncrementalCopyOperation	Used to specify a selection of files to copy from a specific source folder to one or more destination folders.
IMetricsData
IReaddirOptions	Options for fs.readdir
IRigPackageResolver	Rig resolves requested tools from the project's Heft rig.
IRunScript	(BETA) Interface used by scripts that are run by the RunScriptPlugin.
IRunScriptOptions	(BETA) Options provided to scripts that are run using the RunScriptPlugin.
IScopedLogger	A logger which is used to emit errors and warnings to the console, as well as to write to the console. Messaged emitted by the scoped logger are prefixed with the name of the scoped logger.
IWatchedFileState	Information about the state of a watched file.
IWatchFileSystem	Interface contract for heft plugins to use the WatchFileSystemAdapter

Namespaces

Namespace	Description
ConfigurationFile

Type Aliases

Type Alias	Description
GlobFn	Glob a set of files and return a list of paths that match the provided patterns.
ReaddirDirentCallback	Callback for fs.readdir when withFileTypes is true
ReaddirStringCallback	Callback for fs.readdir when withFileTypes is not specified or false
StatCallback	Callback for fs.stat and fs.lstat
WatchGlobFn	Glob a set of files and return a map of paths that match the provided patterns to their current state in the watcher.