RoadmapShopEvents
Skip to main content

Home > @rushstack/heft > HeftConfiguration

HeftConfiguration class

Signature:

export declare class HeftConfiguration 

Properties

PropertyModifiersTypeDescription
buildCacheFolderreadonlystring

The project's build cache folder.

This folder exists at <project root>/.heft/build-cache. TypeScript's output goes into this folder and then is either copied or linked to the final output folder

buildFolderreadonlystringProject build folder. This is the folder containing the project's package.json file.
globalTerminalreadonlyITerminalTerminal instance to facilitate logging.
heftPackageJsonreadonlyIPackageJsonThe Heft tool's package.json
projectConfigFolderreadonlystringThe path to the project's "config" folder.
projectHeftDataFolderreadonlystringThe path to the project's ".heft" folder.
projectPackageJsonreadonlyIPackageJsonThe package.json of the project being built
rigConfigreadonlyRigConfigThe rig.json configuration for this project, if present.
terminalProviderreadonlyITerminalProviderTerminal provider for the provided terminal.