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
BuildStageHooks
BuildSubstageHooksBase
BundleSubstageHooks
CleanStageHooks
CompileSubstageHooks
HeftCommandLine	(BETA) Command line utilities provided for Heft plugin developers.
HeftConfiguration
HeftSession
MetricsCollectorHooks	Tap these hooks to record build metrics, to a file, for example.
ScopedLogger
TestStageHooks

Abstract Classes

Abstract Class	Description
StageHooksBase

Interfaces

Interface	Description
IBuildStageContext
IBuildStageProperties
IBuildSubstage
IBundleSubstage
IBundleSubstageProperties
ICleanStageContext
ICleanStageProperties
ICompileSubstage
ICompileSubstageProperties
ICustomActionOptions	(BETA)
ICustomActionParameterBase	(BETA)
ICustomActionParameterFlag	(BETA)
ICustomActionParameterInteger	(BETA)
ICustomActionParameterString	(BETA)
ICustomActionParameterStringList	(BETA)
IHeftActionConfiguration	The base action configuration that all custom action configuration files should inherit from.
IHeftActionConfigurationOptions	Options to be used when retrieving the action configuration.
IHeftBaseParameter	(BETA) The base set of utility values provided in every object returned when registering a parameter.
IHeftPlugin
IHeftSessionHooks
IMetricsData
IParameterAssociatedActionNames	(BETA) The configuration interface for associating a parameter definition with a Heft command line action in IHeftRegisterParameterOptions.
IPostBuildSubstage
IPreCompileSubstage
IRunScriptOptions	(BETA) Options provided to scripts that are run using the RunScriptPlugin.
IScopedLogger
IStageContext
ITestStageContext
ITestStageProperties

Type Aliases

Type Alias	Description
CustomActionParameterType	(BETA)
ICustomActionParameter	(BETA)
IHeftChoiceListParameter	(BETA) The object returned when registering a choiceList type parameter.
IHeftChoiceParameter	(BETA) The object returned when registering a choice type parameter.
IHeftFlagParameter	(BETA) The object returned when registering a flag type parameter.
IHeftIntegerParameter	(BETA) The object returned when registering an integer type parameter.
IHeftRegisterParameterOptions	(BETA) The options object provided to the command line parser when registering a parameter in addition to the action names used to associate the parameter with.
IHeftStringListParameter	(BETA) The object returned when registering a stringList type parameter.
IHeftStringParameter	(BETA) The object returned when registering a string type parameter.
RegisterAction	(BETA)
RequestAccessToPluginByNameCallback	(BETA)