Home > @microsoft/rush-lib > RushProjectConfiguration

RushProjectConfiguration class

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Use this class to load the "config/rush-project.json" config file.

This file provides project-specific configuration options.

Signature:

export declare class RushProjectConfiguration 

Properties

Property	Modifiers	Type	Description
disableBuildCacheForProject	readonly	boolean	(ALPHA) Disable caching for this project. The project will never be restored from cache. This may be useful if this project affects state outside of its folder. This option is only used when the build cache is enabled for the repo. You can set disableBuildCacheForProject=true to disable caching for a specific project. This is a useful workaround if that project's build scripts violate the assumptions of the cache, for example by writing files outside the project folder. Where possible, a better solution is to improve the build scripts to be compatible with caching.
incrementalBuildIgnoredGlobs	readonly	ReadonlyArray<string>	(ALPHA) The incremental analyzer can skip Rush commands for projects whose input files have not changed since the last build. Normally, every Git-tracked file under the project folder is assumed to be an input. Set incrementalBuildIgnoredGlobs to ignore specific files, specified as globs relative to the project folder. The list of file globs will be interpreted the same way your .gitignore file is.
operationSettingsByOperationName	readonly	ReadonlyMap<string, Readonly<IOperationSettings>>	(ALPHA)
project	readonly	RushConfigurationProject	(ALPHA)