Rush StackShopBlogEvents
Skip to main content

Home > @microsoft/rush-lib > RepoStateFile

RepoStateFile class

This file is used to track the state of various Rush-related features. It is generated and updated by Rush.

Signature:

export declare class RepoStateFile 

Properties

Property

Modifiers

Type

Description

filePath

readonly

string

Get the absolute file path of the repo-state.json file.

isValid

readonly

boolean

If false, the repo-state.json file is not valid and its values cannot be relied upon

packageJsonInjectedDependenciesHash

readonly

string | undefined

The hash of all preferred versions at the end of the last update.

pnpmCatalogsHash

readonly

string | undefined

The hash of the PNPM catalog definitions at the end of the last update.

pnpmShrinkwrapHash

readonly

string | undefined

The hash of the pnpm shrinkwrap file at the end of the last update.

preferredVersionsHash

readonly

string | undefined

The hash of all preferred versions at the end of the last update.

Methods

Method

Modifiers

Description

loadFromFile(jsonFilename)

static

Loads the repo-state.json data from the specified file path. If the file has not been created yet, then an empty object is returned.

refreshState(rushConfiguration, subspace, variant)

Refresh the data contained in repo-state.json using the current state of the Rush repo, and save the file if changes were made.