RoadmapShopEvents
Skip to main content

Home > @microsoft/rush-lib > RushConstants

RushConstants class

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

Constants used by the Rush tool.

Signature:
export declare class RushConstants

Remarks

These are NOT part of the public API surface for rush-lib. The rationale is that we don't want people implementing custom parsers for the Rush config files; instead, they should rely on the official APIs from rush-lib.

Properties

PropertyModifiersTypeDescription
artifactoryFilenamestaticstring(BETA) The artifactory.json configuration file name.
browserApprovedPackagesFilenamestaticstring(BETA) The filename ("browser-approved-packages.json") for an optional policy configuration file that stores a list of NPM packages that have been approved for usage by Rush projects. This is part of a pair of config files, one for projects that run in a web browser (e.g. whose approval criteria mostly focuses on licensing and code size), and one for everywhere else (e.g. tooling projects whose approval criteria mostly focuses on avoiding node_modules sprawl).
buildCacheFilenamestaticstring(BETA) Build cache configuration file.
buildCacheVersionstaticnumber(BETA) Build cache version number, incremented when the logic to create cache entries changes. Changing this ensures that cache entries generated by an old version will no longer register as a cache hit.
buildCommandNamestaticstring(BETA) The name of the incremental build command.
bulkCommandKindstatic'bulk'(BETA) The value of the "commandKind" property for a bulk command in command-line.json
changeFilesFolderNamestaticstring(BETA) The folder name ("changes") where change files will be stored.
commandLineFilenamestaticstring(BETA) Custom command line configuration file, which is used by rush for implementing custom command and options.
commonFolderNamestaticstring(BETA) The folder name ("common") where Rush's common data will be stored.
commonVersionsFilenamestaticstring(BETA) The filename ("common-versions.json") for an optional configuration file that stores dependency version information that affects all projects in the repo. This configuration file should go in the "common/config/rush" folder.
defaultMaxInstallAttemptsstaticnumber(BETA) Number of installation attempts
experimentsFilenamestaticstring(BETA) Experiments configuration file.
globalCommandKindstatic'global'(BETA) The value of the "commandKind" property for a global command in command-line.json
hashDelimiterstaticstring(BETA) When a hash generated that contains multiple input segments, this character may be used to separate them to avoid issues like crypto.createHash('sha1').update('a').update('bc').digest('hex') === crypto.createHash('sha1').update('ab').update('c').digest('hex')
nodeModulesFolderNamestaticstring(BETA) The folder name ("node_modules") where NPM installs its packages.
nonbrowserApprovedPackagesFilenamestaticstring(BETA) The filename ("nonbrowser-approved-packages.json") for an optional policy configuration file that stores a list of NPM packages that have been approved for usage by Rush projects. This is part of a pair of config files, one for projects that run in a web browser (e.g. whose approval criteria mostly focuses on licensing and code size), and one for everywhere else (e.g. tooling projects whose approval criteria mostly focuses on avoiding node_modules sprawl).
npmShrinkwrapFilenamestaticstring(BETA) The filename ("npm-shrinkwrap.json") used to store an installation plan for the NPM package manger.
phasedCommandKindstatic'phased'(BETA) The value of the "commandKind" property for a phased command in command-line.json
phaseNamePrefixstatic'_phase:'(BETA) The expected prefix for phase names in "common/config/rush/command-line.json"
pinnedVersionsFilenamestaticstring(BETA) The filename ("pinned-versions.json") for an old configuration file that that is no longer supported.
pnpmfileV1Filenamestaticstring(BETA) The filename ("pnpmfile.js") used to add custom configuration to PNPM (PNPM version 1.x and later).
pnpmfileV6Filenamestaticstring(BETA) The filename (".pnpmfile.cjs") used to add custom configuration to PNPM (PNPM version 6.x and later).
pnpmV3ShrinkwrapFilenamestaticstring(BETA) The filename ("pnpm-lock.yaml") used to store an installation plan for the PNPM package manger (PNPM version 3.x and later).
projectRushFolderNamestaticstring(BETA) The name of the per-project folder where project-specific Rush files are stored. For example, the package-deps files, which are used by commands to determine if a particular project needs to be rebuilt.
projectShrinkwrapFilenamestaticstring(BETA) The name of the file to drop in project-folder/.rush/temp/ containing a listing of the project's direct and indirect dependencies. This is used to detect if a project's dependencies have changed since the last build.
rebuildCommandNamestaticstring(BETA) The name of the non-incremental build command.
repoStateFilenamestaticstring(BETA) The filename ("repo-state.json") for a file used by Rush to store the state of various features as they stand in the repo.
rushLogsFolderNamestaticstring(BETA) The name of the project rush-logs folder.
rushPackageNamestaticstring(BETA) The name of the NPM package for the Rush tool (" @ microsoft/rush").
rushPluginManifestFilenamestaticstring(BETA) Rush plugin manifest file name.
rushPluginsConfigFilenamestaticstring(BETA) Rush plugins configuration file name.
rushProjectConfigFilenamestaticstring(BETA) Per-project configuration filename.
rushRecyclerFolderNamestaticstring(BETA) The folder name ("rush-recycler") where Rush moves large folder trees before asynchronously deleting them.
rushTempFolderNamestaticstring(BETA) The folder name ("temp") under the common folder, or under the .rush folder in each project's directory where temporary files will be stored. Example: C:\MyRepo\common\temp
rushTempNpmScopestaticstring(BETA) The NPM scope (" @ rush-temp") that is used for Rush's temporary projects.
rushTempProjectsFolderNamestaticstring(BETA) The folder name ("projects") where temporary projects will be stored. Example: C:\MyRepo\common\temp\projects
rushUserConfigurationFolderNamestaticstring(BETA) The name of the per-user Rush configuration data folder.
rushVariantsFolderNamestaticstring(BETA) The folder name ("variants") under which named variant configurations for alternate dependency sets may be found. Example: C:\MyRepo\common\config\rush\variants
rushWebSiteUrlstaticstring(BETA) The URL ("http://rushjs.io") for the Rush web site.
updateCloudCredentialsCommandNamestaticstring(BETA)
versionPoliciesFilenamestaticstring(BETA)
yarnShrinkwrapFilenamestaticstring(BETA) The filename ("shrinkwrap.yaml") used to store state for pnpm