@rushstack/rush-sdk 5.91.0 → 5.92.0

package/lib/api/Rush.d.ts

@@ -0,0 +1,91 @@
+import { IPackageJson, ITerminalProvider } from '@rushstack/node-core-library';
+import { IBuiltInPluginConfiguration } from '../pluginFramework/PluginLoader/BuiltInPluginLoader';
+/**
+ * Options to pass to the rush "launch" functions.
+ *
+ * @public
+ */
+export interface ILaunchOptions {
+    /**
+     * True if the tool was invoked from within a project with a rush.json file, otherwise false. We
+     * consider a project without a rush.json to be "unmanaged" and we'll print that to the command line when
+     * the tool is executed. This is mainly used for debugging purposes.
+     */
+    isManaged: boolean;
+    /**
+     * If true, the wrapper process already printed a warning that the version of Node.js hasn't been tested
+     * with this version of Rush, so we shouldn't print a similar error.
+     */
+    alreadyReportedNodeTooNewError?: boolean;
+    /**
+     * Used to specify Rush plugins that are dependencies of the "\@microsoft/rush" package.
+     *
+     * @internal
+     */
+    builtInPluginConfigurations?: IBuiltInPluginConfiguration[];
+    /**
+     * Used to specify terminal how to write a message
+     */
+    terminalProvider?: ITerminalProvider;
+}
+/**
+ * General operations for the Rush engine.
+ *
+ * @public
+ */
+export declare class Rush {
+    private static __rushLibPackageJson;
+    private static __rushLibPackageFolder;
+    /**
+     * This API is used by the `@microsoft/rush` front end to launch the "rush" command-line.
+     * Third-party tools should not use this API.  Instead, they should execute the "rush" binary
+     * and start a new Node.js process.
+     *
+     * @remarks
+     * Earlier versions of the rush frontend used a different API contract. In the old contract,
+     * the second argument was the `isManaged` value of the {@link ILaunchOptions} object.
+     *
+     * Even though this API isn't documented, it is still supported for legacy compatibility.
+     */
+    static launch(launcherVersion: string, arg: ILaunchOptions): void;
+    /**
+     * This API is used by the `@microsoft/rush` front end to launch the "rushx" command-line.
+     * Third-party tools should not use this API.  Instead, they should execute the "rushx" binary
+     * and start a new Node.js process.
+     */
+    static launchRushX(launcherVersion: string, options: ILaunchOptions): void;
+    /**
+     * This API is used by the `@microsoft/rush` front end to launch the "rush-pnpm" command-line.
+     * Third-party tools should not use this API.  Instead, they should execute the "rush-pnpm" binary
+     * and start a new Node.js process.
+     */
+    static launchRushPnpm(launcherVersion: string, options: ILaunchOptions): void;
+    /**
+     * The currently executing version of the "rush-lib" library.
+     * This is the same as the Rush tool version for that release.
+     */
+    static get version(): string;
+    /**
+     * @internal
+     */
+    static get _rushLibPackageJson(): IPackageJson;
+    static get _rushLibPackageFolder(): string;
+    private static _ensureOwnPackageJsonIsLoaded;
+    /**
+     * Assign the `RUSH_INVOKED_FOLDER` environment variable during startup.  This is only applied when
+     * Rush is invoked via the CLI, not via the `@microsoft/rush-lib` automation API.
+     *
+     * @remarks
+     * Modifying the parent process's environment is not a good design.  The better design is (1) to consolidate
+     * Rush's code paths that invoke scripts, and (2) to pass down the invoked folder with each code path,
+     * so that it can finally be applied in a centralized helper like `Utilities._createEnvironmentForRushCommand()`.
+     * The natural time to do that refactoring is when we rework `Utilities.executeCommand()` to use
+     * `Executable.spawn()` or rushell.
+     */
+    private static _assignRushInvokedFolder;
+    /**
+     * This function normalizes legacy options to the current {@link ILaunchOptions} object.
+     */
+    private static _normalizeLaunchOptions;
+}
+//# sourceMappingURL=Rush.d.ts.map

package/lib/api/Rush.js

@@ -0,0 +1 @@
+module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("api/Rush");

package/lib/api/RushConfiguration.d.ts

@@ -0,0 +1,595 @@
+import { JsonNull, PackageNameParser } from '@rushstack/node-core-library';
+import { RushConfigurationProject, IRushConfigurationProjectJson } from './RushConfigurationProject';
+import { ApprovedPackagesPolicy } from './ApprovedPackagesPolicy';
+import { EventHooks } from './EventHooks';
+import { VersionPolicyConfiguration } from './VersionPolicyConfiguration';
+import { CommonVersionsConfiguration } from './CommonVersionsConfiguration';
+import { PackageManagerName, PackageManager } from './packageManager/PackageManager';
+import { ExperimentsConfiguration } from './ExperimentsConfiguration';
+import { RepoStateFile } from '../logic/RepoStateFile';
+import { LookupByPath } from '../logic/LookupByPath';
+import { RushPluginsConfiguration } from './RushPluginsConfiguration';
+import { IPnpmOptionsJson, PnpmOptionsConfiguration } from '../logic/pnpm/PnpmOptionsConfiguration';
+import { INpmOptionsJson, NpmOptionsConfiguration } from '../logic/npm/NpmOptionsConfiguration';
+import { IYarnOptionsJson, YarnOptionsConfiguration } from '../logic/yarn/YarnOptionsConfiguration';
+import { PackageManagerOptionsConfigurationBase } from '../logic/base/BasePackageManagerOptionsConfiguration';
+/**
+ * Part of IRushConfigurationJson.
+ */
+export interface IApprovedPackagesPolicyJson {
+    reviewCategories?: string[];
+    ignoredNpmScopes?: string[];
+}
+/**
+ * Part of IRushConfigurationJson.
+ */
+export interface IRushGitPolicyJson {
+    allowedEmailRegExps?: string[];
+    sampleEmail?: string;
+    versionBumpCommitMessage?: string;
+    changeLogUpdateCommitMessage?: string;
+    changefilesCommitMessage?: string;
+    tagSeparator?: string;
+}
+/**
+ * Part of IRushConfigurationJson.
+ * @beta
+ */
+export interface IEventHooksJson {
+    /**
+     * The list of scripts to run after every Rush build command finishes
+     */
+    postRushBuild?: string[];
+}
+/**
+ * Part of IRushConfigurationJson.
+ */
+export interface IRushRepositoryJsonBase {
+    /**
+     * The default branch name. This tells "rush change" which remote branch to compare against.
+     */
+    defaultBranch?: string;
+    /**
+     * The default remote. This tells "rush change" which remote to compare against if the remote URL is not set
+     * or if a remote matching the provided remote URL is not found.
+     */
+    defaultRemote?: string;
+}
+export interface IRushRepositoryJsonSingleUrl extends IRushRepositoryJsonBase {
+    /**
+     * The remote url of the repository. If a value is provided,
+     * \"rush change\" will use it to find the right remote to compare against.
+     *
+     * @deprecated Use "urls" instead.
+     */
+    url?: string;
+}
+export interface IRushRepositoryJsonMultipleUrls extends IRushRepositoryJsonBase {
+    /**
+     * Remote url(s) of the repository. If a value is provided, \"rush change\" will
+     * use one of these to find the right remote to compare against. Specifying multiple URLs
+     * is useful if a GitHub repository is renamed or for `<projectName>.visualstudio.com` versus
+     * `dev.azure.com/<projectName>` URLs.
+     */
+    urls?: string[];
+}
+export declare type IRushRepositoryJson = IRushRepositoryJsonSingleUrl | IRushRepositoryJsonMultipleUrls;
+/**
+ * Options defining an allowed variant as part of IRushConfigurationJson.
+ */
+export interface IRushVariantOptionsJson {
+    variantName: string;
+    description: string;
+}
+/**
+ * This represents the JSON data structure for the "rush.json" configuration file.
+ * See rush.schema.json for documentation.
+ */
+export interface IRushConfigurationJson {
+    $schema: string;
+    npmVersion?: string;
+    pnpmVersion?: string;
+    yarnVersion?: string;
+    rushVersion: string;
+    repository?: IRushRepositoryJson;
+    nodeSupportedVersionRange?: string;
+    nodeSupportedVersionInstructions?: string;
+    suppressNodeLtsWarning?: boolean;
+    projectFolderMinDepth?: number;
+    projectFolderMaxDepth?: number;
+    allowMostlyStandardPackageNames?: boolean;
+    approvedPackagesPolicy?: IApprovedPackagesPolicyJson;
+    gitPolicy?: IRushGitPolicyJson;
+    telemetryEnabled?: boolean;
+    allowedProjectTags?: string[];
+    projects: IRushConfigurationProjectJson[];
+    eventHooks?: IEventHooksJson;
+    hotfixChangeEnabled?: boolean;
+    npmOptions?: INpmOptionsJson;
+    pnpmOptions?: IPnpmOptionsJson;
+    yarnOptions?: IYarnOptionsJson;
+    ensureConsistentVersions?: boolean;
+    variants?: IRushVariantOptionsJson[];
+}
+/**
+ * This represents the JSON data structure for the "current-variant.json" data file.
+ */
+export interface ICurrentVariantJson {
+    variant: string | JsonNull;
+}
+/**
+ * Options for `RushConfiguration.tryFindRushJsonLocation`.
+ * @public
+ */
+export interface ITryFindRushJsonLocationOptions {
+    /**
+     * Whether to show verbose console messages.  Defaults to false.
+     */
+    showVerbose?: boolean;
+    /**
+     * The folder path where the search will start.  Defaults tot he current working directory.
+     */
+    startingFolder?: string;
+}
+/**
+ * This represents the Rush configuration for a repository, based on the "rush.json"
+ * configuration file.
+ * @public
+ */
+export declare class RushConfiguration {
+    private static _jsonSchema;
+    private _variants;
+    private readonly _pathTrees;
+    private _projects;
+    private _projectsByName;
+    private _projectsByTag;
+    private _commonVersionsConfigurationsByVariant;
+    /**
+     * The name of the package manager being used to install dependencies
+     */
+    readonly packageManager: PackageManagerName;
+    /**
+     * {@inheritdoc PackageManager}
+     *
+     * @privateremarks
+     * In the next major breaking API change, we will rename this property to "packageManager" and eliminate the
+     * old property with that name.
+     *
+     * @beta
+     */
+    readonly packageManagerWrapper: PackageManager;
+    /**
+     * Gets the JSON data structure for the "rush.json" configuration file.
+     *
+     * @internal
+     */
+    readonly rushConfigurationJson: IRushConfigurationJson;
+    /**
+     * The absolute path to the "rush.json" configuration file that was loaded to construct this object.
+     */
+    readonly rushJsonFile: string;
+    /**
+     * The absolute path of the folder that contains rush.json for this project.
+     */
+    readonly rushJsonFolder: string;
+    /**
+     * The folder that contains all change files.
+     */
+    readonly changesFolder: string;
+    /**
+     * The fully resolved path for the "common" folder where Rush will store settings that
+     * affect all Rush projects.  This is always a subfolder of the folder containing "rush.json".
+     * Example: `C:\MyRepo\common`
+     */
+    readonly commonFolder: string;
+    /**
+     * The folder where Rush's additional config files are stored.  This folder is always a
+     * subfolder called `config\rush` inside the common folder.  (The `common\config` folder
+     * is reserved for configuration files used by other tools.)  To avoid confusion or mistakes,
+     * Rush will report an error if this this folder contains any unrecognized files.
+     *
+     * Example: `C:\MyRepo\common\config\rush`
+     */
+    readonly commonRushConfigFolder: string;
+    /**
+     * The folder where temporary files will be stored.  This is always a subfolder called "temp"
+     * under the common folder.
+     * Example: `C:\MyRepo\common\temp`
+     */
+    readonly commonTempFolder: string;
+    /**
+     * The folder where automation scripts are stored.  This is always a subfolder called "scripts"
+     * under the common folder.
+     * Example: `C:\MyRepo\common\scripts`
+     */
+    readonly commonScriptsFolder: string;
+    /**
+     * The local folder that will store the NPM package cache.  Rush does not rely on the
+     * npm's default global cache folder, because npm's caching implementation does not
+     * reliably handle multiple processes.  (For example, if a build box is running
+     * "rush install" simultaneously for two different working folders, it may fail randomly.)
+     *
+     * Example: `C:\MyRepo\common\temp\npm-cache`
+     */
+    readonly npmCacheFolder: string;
+    /**
+     * The local folder where npm's temporary files will be written during installation.
+     * Rush does not rely on the global default folder, because it may be on a different
+     * hard disk.
+     *
+     * Example: `C:\MyRepo\common\temp\npm-tmp`
+     */
+    readonly npmTmpFolder: string;
+    /**
+     * The local folder that will store the Yarn package cache.
+     *
+     * Example: `C:\MyRepo\common\temp\yarn-cache`
+     */
+    readonly yarnCacheFolder: string;
+    /**
+     * The filename (without any path) of the shrinkwrap file that is used by the package manager.
+     * @remarks
+     * This property merely reports the filename; the file itself may not actually exist.
+     * Example: `npm-shrinkwrap.json` or `pnpm-lock.yaml`
+     */
+    readonly shrinkwrapFilename: string;
+    /**
+     * The full path of the temporary shrinkwrap file that is used during "rush install".
+     * This file may get rewritten by the package manager during installation.
+     * @remarks
+     * This property merely reports the filename; the file itself may not actually exist.
+     * Example: `C:\MyRepo\common\temp\npm-shrinkwrap.json` or `C:\MyRepo\common\temp\pnpm-lock.yaml`
+     */
+    readonly tempShrinkwrapFilename: string;
+    /**
+     * The full path of a backup copy of tempShrinkwrapFilename. This backup copy is made
+     * before installation begins, and can be compared to determine how the package manager
+     * modified tempShrinkwrapFilename.
+     * @remarks
+     * This property merely reports the filename; the file itself may not actually exist.
+     * Example: `C:\MyRepo\common\temp\npm-shrinkwrap-preinstall.json`
+     * or `C:\MyRepo\common\temp\pnpm-lock-preinstall.yaml`
+     */
+    readonly tempShrinkwrapPreinstallFilename: string;
+    /**
+     * The filename of the variant dependency data file.  By default this is
+     * called 'current-variant.json' resides in the Rush common folder.
+     * Its data structure is defined by ICurrentVariantJson.
+     *
+     * Example: `C:\MyRepo\common\temp\current-variant.json`
+     */
+    readonly currentVariantJsonFilename: string;
+    /**
+     * The version of the locally installed NPM tool.  (Example: "1.2.3")
+     */
+    readonly packageManagerToolVersion: string;
+    /**
+     * The absolute path to the locally installed NPM tool.  If "rush install" has not
+     * been run, then this file may not exist yet.
+     * Example: `C:\MyRepo\common\temp\npm-local\node_modules\.bin\npm`
+     */
+    readonly packageManagerToolFilename: string;
+    /**
+     * The minimum allowable folder depth for the projectFolder field in the rush.json file.
+     * This setting provides a way for repository maintainers to discourage nesting of project folders
+     * that makes the directory tree more difficult to navigate.  The default value is 2,
+     * which implements a standard 2-level hierarchy of `<categoryFolder>/<projectFolder>/package.json`.
+     */
+    readonly projectFolderMinDepth: number;
+    /**
+     * The maximum allowable folder depth for the projectFolder field in the rush.json file.
+     * This setting provides a way for repository maintainers to discourage nesting of project folders
+     * that makes the directory tree more difficult to navigate.  The default value is 2,
+     * which implements on a standard convention of `<categoryFolder>/<projectFolder>/package.json`.
+     */
+    readonly projectFolderMaxDepth: number;
+    /**
+     * Today the npmjs.com registry enforces fairly strict naming rules for packages, but in the early
+     * days there was no standard and hardly any enforcement.  A few large legacy projects are still using
+     * nonstandard package names, and private registries sometimes allow it.  Set "allowMostlyStandardPackageNames"
+     * to true to relax Rush's enforcement of package names.  This allows upper case letters and in the future may
+     * relax other rules, however we want to minimize these exceptions.  Many popular tools use certain punctuation
+     * characters as delimiters, based on the assumption that they will never appear in a package name; thus if we relax
+     * the rules too much it is likely to cause very confusing malfunctions.
+     *
+     * The default value is false.
+     */
+    readonly allowMostlyStandardPackageNames: boolean;
+    /**
+     * The "approvedPackagesPolicy" settings.
+     */
+    readonly approvedPackagesPolicy: ApprovedPackagesPolicy;
+    /**
+     * [Part of the "gitPolicy" feature.]
+     * A list of regular expressions describing allowable email patterns for Git commits.
+     * They are case-insensitive anchored JavaScript RegExps.
+     * Example: `".*@example\.com"`
+     * This array will never be undefined.
+     */
+    readonly gitAllowedEmailRegExps: string[];
+    /**
+     * [Part of the "gitPolicy" feature.]
+     * An example valid email address that conforms to one of the allowedEmailRegExps.
+     * Example: `"foxtrot@example\.com"`
+     * This will never be undefined, and will always be nonempty if gitAllowedEmailRegExps is used.
+     */
+    readonly gitSampleEmail: string;
+    /**
+     * [Part of the "gitPolicy" feature.]
+     * The commit message to use when committing changes during 'rush publish'
+     */
+    readonly gitVersionBumpCommitMessage: string | undefined;
+    /**
+     * [Part of the "gitPolicy" feature.]
+     * The commit message to use when committing change log files 'rush version'
+     */
+    readonly gitChangeLogUpdateCommitMessage: string | undefined;
+    /**
+     * [Part of the "gitPolicy" feature.]
+     * The commit message to use when committing change log files 'rush version'
+     */
+    readonly gitChangefilesCommitMessage: string | undefined;
+    /**
+     * [Part of the "gitPolicy" feature.]
+     * The separator between package name and version in git tag.
+     */
+    readonly gitTagSeparator: string | undefined;
+    /**
+     * [Part of the "hotfixChange" feature.]
+     * Enables creating hotfix changes
+     */
+    readonly hotfixChangeEnabled: boolean;
+    /**
+     * Remote URL(s) of the repository. If a value is provided, \"rush change\" will
+     * use one of these to find the right remote to compare against. Specifying multiple URLs
+     * is useful if a GitHub repository is renamed or for `<projectName>.visualstudio.com` versus
+     * `dev.azure.com/<projectName>` URLs.
+     */
+    readonly repositoryUrls: string[];
+    /**
+     * The default branch name. This tells "rush change" which remote branch to compare against.
+     */
+    readonly repositoryDefaultBranch: string;
+    /**
+     * The default remote. This tells "rush change" which remote to compare against if the remote URL is not set
+     * or if a remote matching the provided remote URL is not found.
+     */
+    readonly repositoryDefaultRemote: string;
+    /**
+     * Odd-numbered major versions of Node.js are experimental.  Even-numbered releases
+     * spend six months in a stabilization period before the first Long Term Support (LTS) version.
+     * For example, 8.9.0 was the first LTS version of Node.js 8.  Pre-LTS versions are not recommended
+     * for production usage because they frequently have bugs.  They may cause Rush itself
+     * to malfunction.
+     *
+     * Rush normally prints a warning if it detects a pre-LTS Node.js version.  If you are testing
+     * pre-LTS versions in preparation for supporting the first LTS version, you can use this setting
+     * to disable Rush's warning.
+     */
+    readonly suppressNodeLtsWarning: boolean;
+    /**
+     * If true, then consistent version specifiers for dependencies will be enforced.
+     * I.e. "rush check" is run before some commands.
+     */
+    readonly ensureConsistentVersions: boolean;
+    /**
+     * Indicates whether telemetry collection is enabled for Rush runs.
+     * @beta
+     */
+    readonly telemetryEnabled: boolean;
+    /**
+     * {@inheritDoc NpmOptionsConfiguration}
+     */
+    readonly npmOptions: NpmOptionsConfiguration;
+    /**
+     * {@inheritDoc PnpmOptionsConfiguration}
+     */
+    readonly pnpmOptions: PnpmOptionsConfiguration;
+    /**
+     * {@inheritDoc YarnOptionsConfiguration}
+     */
+    readonly yarnOptions: YarnOptionsConfiguration;
+    /**
+     * The configuration options used by the current package manager.
+     * @remarks
+     * For package manager specific variants, reference {@link RushConfiguration.npmOptions | npmOptions},
+     * {@link RushConfiguration.pnpmOptions | pnpmOptions}, or {@link RushConfiguration.yarnOptions | yarnOptions}.
+     */
+    readonly packageManagerOptions: PackageManagerOptionsConfigurationBase;
+    /**
+     * The rush hooks. It allows customized scripts to run at the specified point.
+     * @beta
+     */
+    readonly eventHooks: EventHooks;
+    /**
+     * The rush hooks. It allows customized scripts to run at the specified point.
+     */
+    readonly packageNameParser: PackageNameParser;
+    /**
+     * @beta
+     */
+    readonly versionPolicyConfiguration: VersionPolicyConfiguration;
+    /**
+     * @beta
+     */
+    readonly versionPolicyConfigurationFilePath: string;
+    /**
+     * This configuration object contains settings repo maintainers have specified to enable
+     * and disable experimental Rush features.
+     *
+     * @beta
+     */
+    readonly experimentsConfiguration: ExperimentsConfiguration;
+    /**
+     * @internal
+     */
+    readonly _rushPluginsConfiguration: RushPluginsConfiguration;
+    /**
+     * Use RushConfiguration.loadFromConfigurationFile() or Use RushConfiguration.loadFromDefaultLocation()
+     * instead.
+     */
+    private constructor();
+    private _initializeAndValidateLocalProjects;
+    /**
+     * Loads the configuration data from an Rush.json configuration file and returns
+     * an RushConfiguration object.
+     */
+    static loadFromConfigurationFile(rushJsonFilename: string): RushConfiguration;
+    static loadFromDefaultLocation(options?: ITryFindRushJsonLocationOptions): RushConfiguration;
+    /**
+     * Find the rush.json location and return the path, or undefined if a rush.json can't be found.
+     *
+     * @privateRemarks
+     * Keep this in sync with `findRushJsonLocation` in `rush-sdk/src/index.ts`.
+     */
+    static tryFindRushJsonLocation(options?: ITryFindRushJsonLocationOptions): string | undefined;
+    /**
+     * This generates the unique names that are used to create temporary projects
+     * in the Rush common folder.
+     * NOTE: sortedProjectJsons is sorted by the caller.
+     */
+    private static _generateTempNameForProject;
+    /**
+     * If someone adds a config file in the "common/rush/config" folder, it would be a bad
+     * experience for Rush to silently ignore their file simply because they misspelled the
+     * filename, or maybe it's an old format that's no longer supported.  The
+     * _validateCommonRushConfigFolder() function makes sure that this folder only contains
+     * recognized config files.
+     */
+    private static _validateCommonRushConfigFolder;
+    /**
+     * The fully resolved path for the "autoinstallers" folder.
+     * Example: `C:\MyRepo\common\autoinstallers`
+     */
+    get commonAutoinstallersFolder(): string;
+    /**
+     * The folder where rush-plugin options json files are stored.
+     * Example: `C:\MyRepo\common\config\rush-plugins`
+     */
+    get rushPluginOptionsFolder(): string;
+    /**
+     * The full path of the shrinkwrap file that is tracked by Git.  (The "rush install"
+     * command uses a temporary copy, whose path is tempShrinkwrapFilename.)
+     * @remarks
+     * This property merely reports the filename; the file itself may not actually exist.
+     * Example: `C:\MyRepo\common\npm-shrinkwrap.json` or `C:\MyRepo\common\pnpm-lock.yaml`
+     *
+     * @deprecated Use `getCommittedShrinkwrapFilename` instead, which gets the correct common
+     * shrinkwrap file name for a given active variant.
+     */
+    get committedShrinkwrapFilename(): string;
+    /**
+     * Returns an English phrase such as "shrinkwrap file" that can be used in logging messages
+     * to refer to the shrinkwrap file using appropriate terminology for the currently selected
+     * package manager.
+     */
+    get shrinkwrapFilePhrase(): string;
+    /**
+     * The filename of the build dependency data file.  By default this is
+     * called 'rush-link.json' resides in the Rush common folder.
+     * Its data structure is defined by IRushLinkJson.
+     *
+     * Example: `C:\MyRepo\common\temp\rush-link.json`
+     *
+     * @deprecated The "rush-link.json" file was removed in Rush 5.30.0.
+     * Use `RushConfigurationProject.localDependencyProjects` instead.
+     */
+    get rushLinkJsonFilename(): string;
+    /**
+     * The default fully-qualified git remote branch of the repository. This helps "rush change" find the right branch to compare against.
+     */
+    get repositoryDefaultFullyQualifiedRemoteBranch(): string;
+    get projects(): RushConfigurationProject[];
+    get projectsByName(): Map<string, RushConfigurationProject>;
+    /**
+     * Obtains the mapping from custom tags to projects.
+     * @beta
+     */
+    get projectsByTag(): ReadonlyMap<string, ReadonlySet<RushConfigurationProject>>;
+    /**
+     * Settings from the common-versions.json config file.
+     * @remarks
+     * If the common-versions.json file is missing, this property will not be undefined.
+     * Instead it will be initialized in an empty state, and calling CommonVersionsConfiguration.save()
+     * will create the file.
+     *
+     * @deprecated Use `getCommonVersions` instead, which gets the correct common version data
+     * for a given active variant.
+     */
+    get commonVersions(): CommonVersionsConfiguration;
+    /**
+     * Gets the currently-installed variant, if an installation has occurred.
+     * For Rush operations which do not take a --variant parameter, this method
+     * determines which variant, if any, was last specified when performing "rush install"
+     * or "rush update".
+     */
+    get currentInstalledVariant(): string | undefined;
+    /**
+     * Gets the path to the common-versions.json config file for a specific variant.
+     * @param variant - The name of the current variant in use by the active command.
+     */
+    getCommonVersionsFilePath(variant?: string | undefined): string;
+    /**
+     * Gets the settings from the common-versions.json config file for a specific variant.
+     * @param variant - The name of the current variant in use by the active command.
+     */
+    getCommonVersions(variant?: string | undefined): CommonVersionsConfiguration;
+    /**
+     * Returns a map of all direct dependencies that only have a single semantic version specifier.
+     * @param variant - The name of the current variant in use by the active command.
+     *
+     * @returns A map of dependency name --\> version specifier for implicitly preferred versions.
+     */
+    getImplicitlyPreferredVersions(variant?: string | undefined): Map<string, string>;
+    /**
+     * Gets the path to the repo-state.json file for a specific variant.
+     * @param variant - The name of the current variant in use by the active command.
+     */
+    getRepoStateFilePath(variant?: string | undefined): string;
+    /**
+     * Gets the contents from the repo-state.json file for a specific variant.
+     * @param variant - The name of the current variant in use by the active command.
+     */
+    getRepoState(variant?: string | undefined): RepoStateFile;
+    /**
+     * Gets the committed shrinkwrap file name for a specific variant.
+     * @param variant - The name of the current variant in use by the active command.
+     */
+    getCommittedShrinkwrapFilename(variant?: string | undefined): string;
+    /**
+     * Gets the absolute path for "pnpmfile.js" for a specific variant.
+     * @param variant - The name of the current variant in use by the active command.
+     * @remarks
+     * The file path is returned even if PNPM is not configured as the package manager.
+     */
+    getPnpmfilePath(variant?: string | undefined): string;
+    /**
+     * Looks up a project in the projectsByName map.  If the project is not found,
+     * then undefined is returned.
+     */
+    getProjectByName(projectName: string): RushConfigurationProject | undefined;
+    /**
+     * This is used e.g. by command-line interfaces such as "rush build --to example".
+     * If "example" is not a project name, then it also looks for a scoped name
+     * like `@something/example`.  If exactly one project matches this heuristic, it
+     * is returned.  Otherwise, undefined is returned.
+     */
+    findProjectByShorthandName(shorthandProjectName: string): RushConfigurationProject | undefined;
+    /**
+     * Looks up a project by its RushConfigurationProject.tempProjectName field.
+     * @returns The found project, or undefined if no match was found.
+     */
+    findProjectByTempName(tempProjectName: string): RushConfigurationProject | undefined;
+    /**
+     * @returns An optimized lookup engine to find a project by its path relative to the specified root.
+     * @beta
+     */
+    getProjectLookupForRoot(rootPath: string): LookupByPath<RushConfigurationProject>;
+    /**
+     * Returns the project for which the specified path is underneath that project's folder.
+     * If the path is not under any project's folder, returns undefined.
+     */
+    tryGetProjectForPath(currentFolderPath: string): RushConfigurationProject | undefined;
+    private _getVariantConfigFolderPath;
+}
+//# sourceMappingURL=RushConfiguration.d.ts.map

package/lib/api/RushConfiguration.js

@@ -0,0 +1 @@
+module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("api/RushConfiguration");