rush-lib.api.md

API Report File for "@microsoft/rush-lib"

Do not edit this file. It is a report generated by API Extractor.

import { IPackageJson } from '@microsoft/node-core-library';

// @public
export class ApprovedPackagesConfiguration {
    constructor(jsonFilename: string);
    // (undocumented)
    addOrUpdatePackage(packageName: string, reviewCategory: string): boolean;
    clear(): void;
    // (undocumented)
    getItemByName(packageName: string): ApprovedPackagesItem | undefined;
    // (undocumented)
    items: ApprovedPackagesItem[];
    loadFromFile(): void;
    saveToFile(): void;
    tryLoadFromFile(approvedPackagesPolicyEnabled: boolean): boolean;
}

// @public
export class ApprovedPackagesItem {
    allowedCategories: Set<string>;
    packageName: string;
}

// @public
export class ApprovedPackagesPolicy {
    // Warning: (ae-forgotten-export) The symbol "IRushConfigurationJson" needs to be exported by the entry point index.d.ts
    // 
    // @internal
    constructor(rushConfiguration: RushConfiguration, rushConfigurationJson: IRushConfigurationJson);
    readonly browserApprovedPackages: ApprovedPackagesConfiguration;
    readonly enabled: boolean;
    readonly ignoredNpmScopes: Set<string>;
    readonly nonbrowserApprovedPackages: ApprovedPackagesConfiguration;
    readonly reviewCategories: Set<string>;
    }

// @beta
export enum BumpType {
    // (undocumented)
    'major' = 5,
    // (undocumented)
    'minor' = 4,
    // (undocumented)
    'none' = 0,
    // (undocumented)
    'patch' = 2,
    // (undocumented)
    'preminor' = 3,
    // (undocumented)
    'prerelease' = 1
}

// @public
export class ChangeManager {
    static createEmptyChangeFiles(rushConfiguration: RushConfiguration, projectName: string, emailAddress: string): string | undefined;
}

// @public
export class CommonVersionsConfiguration {
    readonly allowedAlternativeVersions: Map<string, ReadonlyArray<string>>;
    readonly filePath: string;
    getAllPreferredVersions(): Map<string, string>;
    static loadFromFile(jsonFilename: string): CommonVersionsConfiguration;
    readonly preferredVersions: Map<string, string>;
    save(): boolean;
    readonly xstitchPreferredVersions: Map<string, string>;
    }

// @beta (undocumented)
export const enum DependencyType {
    // (undocumented)
    Dev = "devDependencies",
    // (undocumented)
    Optional = "optionalDependencies",
    // (undocumented)
    Peer = "peerDependencies",
    // (undocumented)
    Regular = "dependencies"
}

// @public
export const enum EnvironmentVariableNames {
    RUSH_ABSOLUTE_SYMLINKS = "RUSH_ABSOLUTE_SYMLINKS",
    RUSH_ALLOW_UNSUPPORTED_NODEJS = "RUSH_ALLOW_UNSUPPORTED_NODEJS",
    RUSH_PREVIEW_VERSION = "RUSH_PREVIEW_VERSION",
    RUSH_TEMP_FOLDER = "RUSH_TEMP_FOLDER",
    RUSH_VARIANT = "RUSH_VARIANT"
}

// @beta
export enum Event {
    postRushBuild = 4,
    postRushInstall = 2,
    preRushBuild = 3,
    preRushInstall = 1
}

// @beta
export class EventHooks {
    // Warning: (ae-forgotten-export) The symbol "IEventHooksJson" needs to be exported by the entry point index.d.ts
    // 
    // @internal
    constructor(eventHooksJson: IEventHooksJson);
    get(event: Event): string[];
    }

// @public
export interface ILaunchOptions {
    alreadyReportedNodeTooNewError?: boolean;
    isManaged: boolean;
}

// @beta
export class IndividualVersionPolicy extends VersionPolicy {
    // Warning: (ae-forgotten-export) The symbol "IIndividualVersionJson" needs to be exported by the entry point index.d.ts
    // 
    // @internal
    constructor(versionPolicyJson: IIndividualVersionJson);
    bump(bumpType?: BumpType, identifier?: string): void;
    ensure(project: IPackageJson, force?: boolean): IPackageJson | undefined;
    // @internal
    readonly _json: IIndividualVersionJson;
    readonly lockedMajor: number | undefined;
    validate(versionString: string, packageName: string): void;
}

// @public
export interface ITryFindRushJsonLocationOptions {
    showVerbose?: boolean;
    startingFolder?: string;
}

// @internal
export class _LastInstallFlag {
    constructor(folderPath: string, state?: Object);
    clear(): void;
    create(): void;
    isValid(): boolean;
    readonly path: string;
    }

// @beta
export class LockStepVersionPolicy extends VersionPolicy {
    // Warning: (ae-forgotten-export) The symbol "ILockStepVersionJson" needs to be exported by the entry point index.d.ts
    // 
    // @internal
    constructor(versionPolicyJson: ILockStepVersionJson);
    bump(bumpType?: BumpType, identifier?: string): void;
    ensure(project: IPackageJson, force?: boolean): IPackageJson | undefined;
    // @internal
    readonly _json: ILockStepVersionJson;
    readonly mainProject: string | undefined;
    readonly nextBump: BumpType;
    update(newVersionString: string): boolean;
    validate(versionString: string, packageName: string): void;
    readonly version: string;
    }

// @beta (undocumented)
export class PackageJsonDependency {
    constructor(name: string, version: string, type: DependencyType, onChange: () => void);
    // (undocumented)
    readonly dependencyType: DependencyType;
    // (undocumented)
    readonly name: string;
    // (undocumented)
    setVersion(newVersion: string): void;
    // (undocumented)
    readonly version: string;
    }

// @beta (undocumented)
export class PackageJsonEditor {
    // (undocumented)
    addOrUpdateDependency(packageName: string, newVersion: string, dependencyType: DependencyType): void;
    readonly dependencyList: ReadonlyArray<PackageJsonDependency>;
    readonly devDependencyList: ReadonlyArray<PackageJsonDependency>;
    // (undocumented)
    readonly filePath: string;
    // (undocumented)
    static fromObject(object: IPackageJson, filename: string): PackageJsonEditor;
    // (undocumented)
    static load(filePath: string): PackageJsonEditor;
    // (undocumented)
    readonly name: string;
    // (undocumented)
    saveIfModified(): boolean;
    // (undocumented)
    tryGetDependency(packageName: string): PackageJsonDependency | undefined;
    // (undocumented)
    tryGetDevDependency(packageName: string): PackageJsonDependency | undefined;
    // (undocumented)
    readonly version: string;
}

// @beta
export abstract class PackageManager {
    // @internal
    protected constructor(version: string, packageManager: PackageManagerName);
    readonly packageManager: PackageManagerName;
    readonly shrinkwrapFilename: string;
    // (undocumented)
    protected _shrinkwrapFilename: string;
    readonly version: string;
}

// @public
export type PackageManagerName = 'pnpm' | 'npm' | 'yarn';

// @public
export class PnpmOptionsConfiguration {
    // Warning: (ae-forgotten-export) The symbol "IPnpmOptionsJson" needs to be exported by the entry point index.d.ts
    // 
    // @internal
    constructor(json: IPnpmOptionsJson);
    readonly resolutionStrategy: ResolutionStrategy;
    readonly strictPeerDependencies: boolean;
}

// @public
export type ResolutionStrategy = 'fewer-dependencies' | 'fast';

// @public
export class Rush {
    static launch(launcherVersion: string, arg: ILaunchOptions): void;
    static launchRushX(launcherVersion: string, options: ILaunchOptions): void;
    static readonly version: string;
}

// @public
export class RushConfiguration {
    readonly approvedPackagesPolicy: ApprovedPackagesPolicy;
    readonly changesFolder: string;
    // @deprecated
    readonly committedShrinkwrapFilename: string;
    readonly commonFolder: string;
    readonly commonRushConfigFolder: string;
    readonly commonScriptsFolder: string;
    readonly commonTempFolder: string;
    // @deprecated
    readonly commonVersions: CommonVersionsConfiguration;
    readonly currentInstalledVariant: string | undefined;
    readonly currentVariantJsonFilename: string;
    readonly ensureConsistentVersions: boolean;
    // @beta
    readonly eventHooks: EventHooks;
    findProjectByShorthandName(shorthandProjectName: string): RushConfigurationProject | undefined;
    findProjectByTempName(tempProjectName: string): RushConfigurationProject | undefined;
    getCommittedShrinkwrapFilename(variant?: string | undefined): string;
    getCommonVersions(variant?: string | undefined): CommonVersionsConfiguration;
    getCommonVersionsFilePath(variant?: string | undefined): string;
    getPnpmfilePath(variant?: string | undefined): string;
    getProjectByName(projectName: string): RushConfigurationProject | undefined;
    readonly gitAllowedEmailRegExps: string[];
    readonly gitSampleEmail: string;
    readonly gitVersionBumpCommitMessage: string | undefined;
    readonly hotfixChangeEnabled: boolean;
    static loadFromConfigurationFile(rushJsonFilename: string): RushConfiguration;
    // (undocumented)
    static loadFromDefaultLocation(options?: ITryFindRushJsonLocationOptions): RushConfiguration;
    readonly npmCacheFolder: string;
    readonly npmTmpFolder: string;
    readonly packageManager: PackageManagerName;
    readonly packageManagerToolFilename: string;
    readonly packageManagerToolVersion: string;
    // @beta
    readonly packageManagerWrapper: PackageManager;
    readonly pnpmOptions: PnpmOptionsConfiguration;
    readonly pnpmStoreFolder: string;
    readonly projectFolderMaxDepth: number;
    readonly projectFolderMinDepth: number;
    // (undocumented)
    readonly projects: RushConfigurationProject[];
    // (undocumented)
    readonly projectsByName: Map<string, RushConfigurationProject>;
    readonly repositoryUrl: string;
    readonly rushJsonFile: string;
    readonly rushJsonFolder: string;
    readonly rushLinkJsonFilename: string;
    readonly shrinkwrapFilename: string;
    readonly shrinkwrapFilePhrase: string;
    readonly suppressNodeLtsWarning: boolean;
    // @beta
    readonly telemetryEnabled: boolean;
    readonly tempShrinkwrapFilename: string;
    readonly tempShrinkwrapPreinstallFilename: string;
    static tryFindRushJsonLocation(options?: ITryFindRushJsonLocationOptions): string | undefined;
    tryGetProjectForPath(currentFolderPath: string): RushConfigurationProject | undefined;
    // @beta (undocumented)
    readonly versionPolicyConfiguration: VersionPolicyConfiguration;
    readonly yarnCacheFolder: string;
    readonly yarnOptions: YarnOptionsConfiguration;
    }

// @public
export class RushConfigurationProject {
    // Warning: (ae-forgotten-export) The symbol "IRushConfigurationProjectJson" needs to be exported by the entry point index.d.ts
    // 
    // @internal
    constructor(projectJson: IRushConfigurationProjectJson, rushConfiguration: RushConfiguration, tempProjectName: string);
    readonly cyclicDependencyProjects: Set<string>;
    readonly downstreamDependencyProjects: string[];
    // @beta
    readonly isMainProject: boolean;
    // @deprecated
    readonly packageJson: IPackageJson;
    // @beta
    readonly packageJsonEditor: PackageJsonEditor;
    readonly packageName: string;
    readonly projectFolder: string;
    readonly projectRelativeFolder: string;
    readonly projectRushTempFolder: string;
    readonly reviewCategory: string;
    readonly shouldPublish: boolean;
    readonly skipRushCheck: boolean;
    readonly tempProjectName: string;
    readonly unscopedTempProjectName: string;
    // @beta
    readonly versionPolicy: VersionPolicy | undefined;
    // @beta
    readonly versionPolicyName: string | undefined;
    }

// @internal
export class _RushGlobalFolder {
    constructor();
    readonly nodeSpecificPath: string;
    readonly path: string;
    }

// @beta
export abstract class VersionPolicy {
    // @internal
    constructor(versionPolicyJson: IVersionPolicyJson);
    abstract bump(bumpType?: BumpType, identifier?: string): void;
    readonly definitionName: VersionPolicyDefinitionName;
    abstract ensure(project: IPackageJson, force?: boolean): IPackageJson | undefined;
    readonly exemptFromRushChange: boolean;
    readonly isLockstepped: boolean;
    // @internal
    abstract readonly _json: IVersionPolicyJson;
    // Warning: (ae-forgotten-export) The symbol "IVersionPolicyJson" needs to be exported by the entry point index.d.ts
    // 
    // @internal
    static load(versionPolicyJson: IVersionPolicyJson): VersionPolicy | undefined;
    readonly policyName: string;
    setDependenciesBeforeCommit(packageName: string, configuration: RushConfiguration): void;
    setDependenciesBeforePublish(packageName: string, configuration: RushConfiguration): void;
    abstract validate(versionString: string, packageName: string): void;
    }

// @beta
export class VersionPolicyConfiguration {
    // @internal
    constructor(jsonFileName: string);
    bump(versionPolicyName?: string, bumpType?: BumpType, identifier?: string, shouldCommit?: boolean): void;
    getVersionPolicy(policyName: string): VersionPolicy;
    update(versionPolicyName: string, newVersion: string): void;
    validate(projectsByName: Map<string, RushConfigurationProject>): void;
    readonly versionPolicies: Map<string, VersionPolicy>;
    }

// @beta
export enum VersionPolicyDefinitionName {
    // (undocumented)
    'individualVersion' = 1,
    // (undocumented)
    'lockStepVersion' = 0
}

// @public
export class YarnOptionsConfiguration {
    // Warning: (ae-forgotten-export) The symbol "IYarnOptionsJson" needs to be exported by the entry point index.d.ts
    // 
    // @internal
    constructor(json: IYarnOptionsJson);
    readonly ignoreEngines: boolean;
}