@rushstack/rush-sdk 5.91.0 → 5.92.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +46 -11
- package/dist/rush-lib.d.ts +18 -0
- package/lib/api/ApprovedPackagesConfiguration.d.ts +74 -0
- package/lib/api/ApprovedPackagesConfiguration.js +1 -0
- package/lib/api/ApprovedPackagesPolicy.d.ts +54 -0
- package/lib/api/ApprovedPackagesPolicy.js +1 -0
- package/lib/api/BuildCacheConfiguration.d.ts +77 -0
- package/lib/api/BuildCacheConfiguration.js +1 -0
- package/lib/api/ChangeFile.d.ts +42 -0
- package/lib/api/ChangeFile.js +1 -0
- package/lib/api/ChangeManagement.d.ts +85 -0
- package/lib/api/ChangeManagement.js +1 -0
- package/lib/api/ChangeManager.d.ts +16 -0
- package/lib/api/ChangeManager.js +1 -0
- package/lib/api/Changelog.d.ts +74 -0
- package/lib/api/Changelog.js +1 -0
- package/lib/api/CommandLineConfiguration.d.ts +161 -0
- package/lib/api/CommandLineConfiguration.js +1 -0
- package/lib/api/CommandLineJson.d.ts +251 -0
- package/lib/api/CommandLineJson.js +1 -0
- package/lib/api/CommonVersionsConfiguration.d.ts +96 -0
- package/lib/api/CommonVersionsConfiguration.js +1 -0
- package/lib/api/EnvironmentConfiguration.d.ts +258 -0
- package/lib/api/EnvironmentConfiguration.js +1 -0
- package/lib/api/EventHooks.d.ts +42 -0
- package/lib/api/EventHooks.js +1 -0
- package/lib/api/ExperimentsConfiguration.d.ts +62 -0
- package/lib/api/ExperimentsConfiguration.js +1 -0
- package/lib/api/LastInstallFlag.d.ts +73 -0
- package/lib/api/LastInstallFlag.js +1 -0
- package/lib/api/LastLinkFlag.d.ts +41 -0
- package/lib/api/LastLinkFlag.js +1 -0
- package/lib/api/PackageJsonEditor.d.ts +79 -0
- package/lib/api/PackageJsonEditor.js +1 -0
- package/lib/api/PackageNameParsers.d.ts +18 -0
- package/lib/api/PackageNameParsers.js +1 -0
- package/lib/api/Rush.d.ts +91 -0
- package/lib/api/Rush.js +1 -0
- package/lib/api/RushConfiguration.d.ts +595 -0
- package/lib/api/RushConfiguration.js +1 -0
- package/lib/api/RushConfigurationProject.d.ts +217 -0
- package/lib/api/RushConfigurationProject.js +1 -0
- package/lib/api/RushGlobalFolder.d.ts +32 -0
- package/lib/api/RushGlobalFolder.js +1 -0
- package/lib/api/RushInternals.d.ts +15 -0
- package/lib/api/RushInternals.js +1 -0
- package/lib/api/RushPluginsConfiguration.d.ts +21 -0
- package/lib/api/RushPluginsConfiguration.js +1 -0
- package/lib/api/RushProjectConfiguration.d.ts +117 -0
- package/lib/api/RushProjectConfiguration.js +1 -0
- package/lib/api/RushUserConfiguration.d.ts +16 -0
- package/lib/api/RushUserConfiguration.js +1 -0
- package/lib/api/SaveCallbackPackageJsonEditor.d.ts +14 -0
- package/lib/api/SaveCallbackPackageJsonEditor.js +1 -0
- package/lib/api/Variants.d.ts +11 -0
- package/lib/api/Variants.js +1 -0
- package/lib/api/VersionPolicy.d.ts +203 -0
- package/lib/api/VersionPolicy.js +1 -0
- package/lib/api/VersionPolicyConfiguration.d.ts +75 -0
- package/lib/api/VersionPolicyConfiguration.js +1 -0
- package/lib/api/packageManager/NpmPackageManager.d.ts +9 -0
- package/lib/api/packageManager/NpmPackageManager.js +1 -0
- package/lib/api/packageManager/PackageManager.d.ts +29 -0
- package/lib/api/packageManager/PackageManager.js +1 -0
- package/lib/api/packageManager/PnpmPackageManager.d.ts +17 -0
- package/lib/api/packageManager/PnpmPackageManager.js +1 -0
- package/lib/api/packageManager/YarnPackageManager.d.ts +9 -0
- package/lib/api/packageManager/YarnPackageManager.js +1 -0
- package/lib/cli/CommandLineMigrationAdvisor.d.ts +5 -0
- package/lib/cli/CommandLineMigrationAdvisor.js +1 -0
- package/lib/cli/RushCommandLineParser.d.ts +49 -0
- package/lib/cli/RushCommandLineParser.js +1 -0
- package/lib/cli/RushPnpmCommandLine.d.ts +7 -0
- package/lib/cli/RushPnpmCommandLine.js +1 -0
- package/lib/cli/RushPnpmCommandLineParser.d.ts +26 -0
- package/lib/cli/RushPnpmCommandLineParser.js +1 -0
- package/lib/cli/RushStartupBanner.d.ts +7 -0
- package/lib/cli/RushStartupBanner.js +1 -0
- package/lib/cli/RushXCommandLine.d.ts +17 -0
- package/lib/cli/RushXCommandLine.js +1 -0
- package/lib/cli/actions/AddAction.d.ts +15 -0
- package/lib/cli/actions/AddAction.js +1 -0
- package/lib/cli/actions/BaseAddAndRemoveAction.d.ts +36 -0
- package/lib/cli/actions/BaseAddAndRemoveAction.js +1 -0
- package/lib/cli/actions/BaseInstallAction.d.ts +23 -0
- package/lib/cli/actions/BaseInstallAction.js +1 -0
- package/lib/cli/actions/BaseRushAction.d.ts +55 -0
- package/lib/cli/actions/BaseRushAction.js +1 -0
- package/lib/cli/actions/ChangeAction.d.ts +65 -0
- package/lib/cli/actions/ChangeAction.js +1 -0
- package/lib/cli/actions/CheckAction.d.ts +10 -0
- package/lib/cli/actions/CheckAction.js +1 -0
- package/lib/cli/actions/DeployAction.d.ts +12 -0
- package/lib/cli/actions/DeployAction.js +1 -0
- package/lib/cli/actions/InitAction.d.ts +16 -0
- package/lib/cli/actions/InitAction.js +1 -0
- package/lib/cli/actions/InitAutoinstallerAction.d.ts +8 -0
- package/lib/cli/actions/InitAutoinstallerAction.js +1 -0
- package/lib/cli/actions/InitDeployAction.d.ts +9 -0
- package/lib/cli/actions/InitDeployAction.js +1 -0
- package/lib/cli/actions/InstallAction.d.ts +9 -0
- package/lib/cli/actions/InstallAction.js +1 -0
- package/lib/cli/actions/LinkAction.d.ts +8 -0
- package/lib/cli/actions/LinkAction.js +1 -0
- package/lib/cli/actions/ListAction.d.ts +54 -0
- package/lib/cli/actions/ListAction.js +1 -0
- package/lib/cli/actions/PublishAction.d.ts +49 -0
- package/lib/cli/actions/PublishAction.js +1 -0
- package/lib/cli/actions/PurgeAction.d.ts +8 -0
- package/lib/cli/actions/PurgeAction.js +1 -0
- package/lib/cli/actions/RemoveAction.d.ts +13 -0
- package/lib/cli/actions/RemoveAction.js +1 -0
- package/lib/cli/actions/ScanAction.d.ts +23 -0
- package/lib/cli/actions/ScanAction.js +1 -0
- package/lib/cli/actions/SetupAction.d.ts +7 -0
- package/lib/cli/actions/SetupAction.js +1 -0
- package/lib/cli/actions/UnlinkAction.d.ts +7 -0
- package/lib/cli/actions/UnlinkAction.js +1 -0
- package/lib/cli/actions/UpdateAction.d.ts +11 -0
- package/lib/cli/actions/UpdateAction.js +1 -0
- package/lib/cli/actions/UpdateAutoinstallerAction.d.ts +8 -0
- package/lib/cli/actions/UpdateAutoinstallerAction.js +1 -0
- package/lib/cli/actions/UpdateCloudCredentialsAction.d.ts +10 -0
- package/lib/cli/actions/UpdateCloudCredentialsAction.js +1 -0
- package/lib/cli/actions/UpgradeInteractiveAction.d.ts +9 -0
- package/lib/cli/actions/UpgradeInteractiveAction.js +1 -0
- package/lib/cli/actions/VersionAction.d.ts +22 -0
- package/lib/cli/actions/VersionAction.js +1 -0
- package/lib/cli/parsing/ParseParallelism.d.ts +6 -0
- package/lib/cli/parsing/ParseParallelism.js +1 -0
- package/lib/cli/parsing/SelectionParameterSet.d.ts +51 -0
- package/lib/cli/parsing/SelectionParameterSet.js +1 -0
- package/lib/cli/scriptActions/BaseScriptAction.d.ts +28 -0
- package/lib/cli/scriptActions/BaseScriptAction.js +1 -0
- package/lib/cli/scriptActions/GlobalScriptAction.d.ts +30 -0
- package/lib/cli/scriptActions/GlobalScriptAction.js +1 -0
- package/lib/cli/scriptActions/PhasedScriptAction.d.ts +65 -0
- package/lib/cli/scriptActions/PhasedScriptAction.js +1 -0
- package/lib/index.d.ts +51 -1
- package/lib/index.js +1 -190
- package/lib/logic/Autoinstaller.d.ts +21 -0
- package/lib/logic/Autoinstaller.js +1 -0
- package/lib/logic/ChangeFiles.d.ts +33 -0
- package/lib/logic/ChangeFiles.js +1 -0
- package/lib/logic/ChangeManager.d.ts +39 -0
- package/lib/logic/ChangeManager.js +1 -0
- package/lib/logic/ChangelogGenerator.d.ts +46 -0
- package/lib/logic/ChangelogGenerator.js +1 -0
- package/lib/logic/CredentialCache.d.ts +36 -0
- package/lib/logic/CredentialCache.js +1 -0
- package/lib/logic/DependencyAnalyzer.d.ts +34 -0
- package/lib/logic/DependencyAnalyzer.js +1 -0
- package/lib/logic/DependencySpecifier.d.ts +70 -0
- package/lib/logic/DependencySpecifier.js +1 -0
- package/lib/logic/EventHooksManager.d.ts +10 -0
- package/lib/logic/EventHooksManager.js +1 -0
- package/lib/logic/Git.d.ts +103 -0
- package/lib/logic/Git.js +1 -0
- package/lib/logic/GitStatusParser.d.ts +42 -0
- package/lib/logic/GitStatusParser.js +1 -0
- package/lib/logic/JsonSchemaUrls.d.ts +8 -0
- package/lib/logic/JsonSchemaUrls.js +1 -0
- package/lib/logic/LookupByPath.d.ts +86 -0
- package/lib/logic/LookupByPath.js +1 -0
- package/lib/logic/NodeJsCompatibility.d.ts +42 -0
- package/lib/logic/NodeJsCompatibility.js +1 -0
- package/lib/logic/PackageJsonUpdaterTypes.d.ts +75 -0
- package/lib/logic/PackageJsonUpdaterTypes.js +1 -0
- package/lib/logic/PrereleaseToken.d.ts +12 -0
- package/lib/logic/PrereleaseToken.js +1 -0
- package/lib/logic/ProjectChangeAnalyzer.d.ts +81 -0
- package/lib/logic/ProjectChangeAnalyzer.js +1 -0
- package/lib/logic/ProjectCommandSet.d.ts +13 -0
- package/lib/logic/ProjectCommandSet.js +1 -0
- package/lib/logic/PublishGit.d.ts +19 -0
- package/lib/logic/PublishGit.js +1 -0
- package/lib/logic/PublishUtilities.d.ts +71 -0
- package/lib/logic/PublishUtilities.js +1 -0
- package/lib/logic/PurgeManager.d.ts +29 -0
- package/lib/logic/PurgeManager.js +1 -0
- package/lib/logic/RepoStateFile.d.ts +55 -0
- package/lib/logic/RepoStateFile.js +1 -0
- package/lib/logic/RushConstants.d.ts +219 -0
- package/lib/logic/RushConstants.js +1 -0
- package/lib/logic/Selection.d.ts +39 -0
- package/lib/logic/Selection.js +1 -0
- package/lib/logic/SetupChecks.d.ts +22 -0
- package/lib/logic/SetupChecks.js +1 -0
- package/lib/logic/ShrinkwrapFileFactory.d.ts +8 -0
- package/lib/logic/ShrinkwrapFileFactory.js +1 -0
- package/lib/logic/StandardScriptUpdater.d.ts +26 -0
- package/lib/logic/StandardScriptUpdater.js +1 -0
- package/lib/logic/Telemetry.d.ts +123 -0
- package/lib/logic/Telemetry.js +1 -0
- package/lib/logic/UnlinkManager.d.ts +24 -0
- package/lib/logic/UnlinkManager.js +1 -0
- package/lib/logic/base/BaseInstallManagerTypes.d.ts +65 -0
- package/lib/logic/base/BaseInstallManagerTypes.js +1 -0
- package/lib/logic/base/BasePackageManagerOptionsConfiguration.d.ts +50 -0
- package/lib/logic/base/BasePackageManagerOptionsConfiguration.js +1 -0
- package/lib/logic/base/BaseProjectShrinkwrapFile.d.ts +36 -0
- package/lib/logic/base/BaseProjectShrinkwrapFile.js +1 -0
- package/lib/logic/base/BaseShrinkwrapFile.d.ts +92 -0
- package/lib/logic/base/BaseShrinkwrapFile.js +1 -0
- package/lib/logic/buildCache/CacheEntryId.d.ts +28 -0
- package/lib/logic/buildCache/CacheEntryId.js +1 -0
- package/lib/logic/buildCache/FileSystemBuildCacheProvider.d.ts +40 -0
- package/lib/logic/buildCache/FileSystemBuildCacheProvider.js +1 -0
- package/lib/logic/buildCache/ICloudBuildCacheProvider.d.ts +14 -0
- package/lib/logic/buildCache/ICloudBuildCacheProvider.js +1 -0
- package/lib/logic/buildCache/ProjectBuildCache.d.ts +46 -0
- package/lib/logic/buildCache/ProjectBuildCache.js +1 -0
- package/lib/logic/buildCache/getHashesForGlobsAsync.d.ts +3 -0
- package/lib/logic/buildCache/getHashesForGlobsAsync.js +1 -0
- package/lib/logic/deploy/DeployScenarioConfiguration.d.ts +39 -0
- package/lib/logic/deploy/DeployScenarioConfiguration.js +1 -0
- package/lib/logic/installManager/InstallHelpers.d.ts +16 -0
- package/lib/logic/installManager/InstallHelpers.js +1 -0
- package/lib/logic/npm/NpmOptionsConfiguration.d.ts +21 -0
- package/lib/logic/npm/NpmOptionsConfiguration.js +1 -0
- package/lib/logic/npm/NpmShrinkwrapFile.d.ts +29 -0
- package/lib/logic/npm/NpmShrinkwrapFile.js +1 -0
- package/lib/logic/operations/AsyncOperationQueue.d.ts +47 -0
- package/lib/logic/operations/AsyncOperationQueue.js +1 -0
- package/lib/logic/operations/IOperationExecutionResult.d.ts +49 -0
- package/lib/logic/operations/IOperationExecutionResult.js +1 -0
- package/lib/logic/operations/IOperationRunner.d.ts +77 -0
- package/lib/logic/operations/IOperationRunner.js +1 -0
- package/lib/logic/operations/NullOperationRunner.d.ts +35 -0
- package/lib/logic/operations/NullOperationRunner.js +1 -0
- package/lib/logic/operations/Operation.d.ts +80 -0
- package/lib/logic/operations/Operation.js +1 -0
- package/lib/logic/operations/OperationError.d.ts +11 -0
- package/lib/logic/operations/OperationError.js +1 -0
- package/lib/logic/operations/OperationExecutionManager.d.ts +42 -0
- package/lib/logic/operations/OperationExecutionManager.js +1 -0
- package/lib/logic/operations/OperationExecutionRecord.d.ts +82 -0
- package/lib/logic/operations/OperationExecutionRecord.js +1 -0
- package/lib/logic/operations/OperationMetadataManager.d.ts +48 -0
- package/lib/logic/operations/OperationMetadataManager.js +1 -0
- package/lib/logic/operations/OperationResultSummarizerPlugin.d.ts +17 -0
- package/lib/logic/operations/OperationResultSummarizerPlugin.js +1 -0
- package/lib/logic/operations/OperationStateFile.d.ts +39 -0
- package/lib/logic/operations/OperationStateFile.js +1 -0
- package/lib/logic/operations/OperationStatus.d.ts +43 -0
- package/lib/logic/operations/OperationStatus.js +1 -0
- package/lib/logic/operations/PhasedOperationPlugin.d.ts +9 -0
- package/lib/logic/operations/PhasedOperationPlugin.js +1 -0
- package/lib/logic/operations/ProjectLogWritable.d.ts +17 -0
- package/lib/logic/operations/ProjectLogWritable.js +1 -0
- package/lib/logic/operations/ShellOperationRunner.d.ts +87 -0
- package/lib/logic/operations/ShellOperationRunner.js +1 -0
- package/lib/logic/operations/ShellOperationRunnerPlugin.d.ts +8 -0
- package/lib/logic/operations/ShellOperationRunnerPlugin.js +1 -0
- package/lib/logic/pnpm/IPnpmfile.d.ts +54 -0
- package/lib/logic/pnpm/IPnpmfile.js +1 -0
- package/lib/logic/pnpm/PnpmOptionsConfiguration.d.ts +242 -0
- package/lib/logic/pnpm/PnpmOptionsConfiguration.js +1 -0
- package/lib/logic/pnpm/PnpmProjectShrinkwrapFile.d.ts +26 -0
- package/lib/logic/pnpm/PnpmProjectShrinkwrapFile.js +1 -0
- package/lib/logic/pnpm/PnpmShrinkwrapFile.d.ts +207 -0
- package/lib/logic/pnpm/PnpmShrinkwrapFile.js +1 -0
- package/lib/logic/pnpm/PnpmYamlCommon.d.ts +8 -0
- package/lib/logic/pnpm/PnpmYamlCommon.js +1 -0
- package/lib/logic/pnpm/PnpmfileConfiguration.d.ts +28 -0
- package/lib/logic/pnpm/PnpmfileConfiguration.js +1 -0
- package/lib/logic/pnpm/PnpmfileShim.d.ts +3 -0
- package/lib/logic/pnpm/PnpmfileShim.js +1 -0
- package/lib/logic/policy/GitEmailPolicy.d.ts +6 -0
- package/lib/logic/policy/GitEmailPolicy.js +1 -0
- package/lib/logic/policy/PolicyValidator.d.ts +10 -0
- package/lib/logic/policy/PolicyValidator.js +1 -0
- package/lib/logic/policy/ShrinkwrapFilePolicy.d.ts +13 -0
- package/lib/logic/policy/ShrinkwrapFilePolicy.js +1 -0
- package/lib/logic/selectors/GitChangedProjectSelectorParser.d.ts +23 -0
- package/lib/logic/selectors/GitChangedProjectSelectorParser.js +1 -0
- package/lib/logic/selectors/ISelectorParser.d.ts +11 -0
- package/lib/logic/selectors/ISelectorParser.js +1 -0
- package/lib/logic/selectors/NamedProjectSelectorParser.d.ts +10 -0
- package/lib/logic/selectors/NamedProjectSelectorParser.js +1 -0
- package/lib/logic/selectors/TagProjectSelectorParser.d.ts +10 -0
- package/lib/logic/selectors/TagProjectSelectorParser.js +1 -0
- package/lib/logic/selectors/VersionPolicyProjectSelectorParser.d.ts +10 -0
- package/lib/logic/selectors/VersionPolicyProjectSelectorParser.js +1 -0
- package/lib/logic/setup/ArtifactoryConfiguration.d.ts +38 -0
- package/lib/logic/setup/ArtifactoryConfiguration.js +1 -0
- package/lib/logic/setup/KeyboardLoop.d.ts +27 -0
- package/lib/logic/setup/KeyboardLoop.js +1 -0
- package/lib/logic/setup/SetupPackageRegistry.d.ts +72 -0
- package/lib/logic/setup/SetupPackageRegistry.js +1 -0
- package/lib/logic/setup/TerminalInput.d.ts +22 -0
- package/lib/logic/setup/TerminalInput.js +1 -0
- package/lib/logic/versionMismatch/VersionMismatchFinder.d.ts +49 -0
- package/lib/logic/versionMismatch/VersionMismatchFinder.js +1 -0
- package/lib/logic/versionMismatch/VersionMismatchFinderCommonVersions.d.ts +16 -0
- package/lib/logic/versionMismatch/VersionMismatchFinderCommonVersions.js +1 -0
- package/lib/logic/versionMismatch/VersionMismatchFinderEntity.d.ts +20 -0
- package/lib/logic/versionMismatch/VersionMismatchFinderEntity.js +1 -0
- package/lib/logic/versionMismatch/VersionMismatchFinderProject.d.ts +16 -0
- package/lib/logic/versionMismatch/VersionMismatchFinderProject.js +1 -0
- package/lib/logic/yarn/YarnOptionsConfiguration.d.ts +37 -0
- package/lib/logic/yarn/YarnOptionsConfiguration.js +1 -0
- package/lib/logic/yarn/YarnShrinkwrapFile.d.ts +55 -0
- package/lib/logic/yarn/YarnShrinkwrapFile.js +1 -0
- package/lib/pluginFramework/IRushPlugin.d.ts +9 -0
- package/lib/pluginFramework/IRushPlugin.js +1 -0
- package/lib/pluginFramework/PhasedCommandHooks.d.ts +93 -0
- package/lib/pluginFramework/PhasedCommandHooks.js +1 -0
- package/lib/pluginFramework/PluginLoader/AutoinstallerPluginLoader.d.ts +27 -0
- package/lib/pluginFramework/PluginLoader/AutoinstallerPluginLoader.js +1 -0
- package/lib/pluginFramework/PluginLoader/BuiltInPluginLoader.d.ts +17 -0
- package/lib/pluginFramework/PluginLoader/BuiltInPluginLoader.js +1 -0
- package/lib/pluginFramework/PluginLoader/PluginLoaderBase.d.ts +47 -0
- package/lib/pluginFramework/PluginLoader/PluginLoaderBase.js +1 -0
- package/lib/pluginFramework/PluginLoader/RushSdk.d.ts +5 -0
- package/lib/pluginFramework/PluginLoader/RushSdk.js +1 -0
- package/lib/pluginFramework/PluginManager.d.ts +47 -0
- package/lib/pluginFramework/PluginManager.js +1 -0
- package/lib/pluginFramework/RushLifeCycle.d.ts +66 -0
- package/lib/pluginFramework/RushLifeCycle.js +1 -0
- package/lib/pluginFramework/RushSession.d.ts +30 -0
- package/lib/pluginFramework/RushSession.js +1 -0
- package/lib/pluginFramework/logging/Logger.d.ts +40 -0
- package/lib/pluginFramework/logging/Logger.js +1 -0
- package/lib/start-pnpm.d.ts +2 -0
- package/lib/start-pnpm.js +1 -0
- package/lib/start.d.ts +2 -0
- package/lib/start.js +1 -0
- package/lib/startx.d.ts +2 -0
- package/lib/startx.js +1 -0
- package/lib/utilities/AsyncRecycler.d.ts +38 -0
- package/lib/utilities/AsyncRecycler.js +1 -0
- package/lib/utilities/CollatedTerminalProvider.d.ts +18 -0
- package/lib/utilities/CollatedTerminalProvider.js +1 -0
- package/lib/utilities/Npm.d.ts +6 -0
- package/lib/utilities/Npm.js +1 -0
- package/lib/utilities/OverlappingPathAnalyzer.d.ts +9 -0
- package/lib/utilities/OverlappingPathAnalyzer.js +1 -0
- package/lib/utilities/PathConstants.d.ts +23 -0
- package/lib/utilities/PathConstants.js +1 -0
- package/lib/utilities/Stopwatch.d.ts +75 -0
- package/lib/utilities/Stopwatch.js +1 -0
- package/lib/utilities/TarExecutable.d.ts +32 -0
- package/lib/utilities/TarExecutable.js +1 -0
- package/lib/utilities/Utilities.d.ts +189 -0
- package/lib/utilities/Utilities.js +1 -0
- package/lib/utilities/WebClient.d.ts +49 -0
- package/lib/utilities/WebClient.js +1 -0
- package/lib/utilities/npmrcUtilities.d.ts +15 -0
- package/lib/utilities/npmrcUtilities.js +1 -0
- package/lib-shim/generate-stubs.d.ts +2 -0
- package/lib-shim/generate-stubs.d.ts.map +1 -0
- package/lib-shim/generate-stubs.js +82 -0
- package/lib-shim/generate-stubs.js.map +1 -0
- package/lib-shim/index.d.ts +5 -0
- package/lib-shim/index.d.ts.map +1 -0
- package/lib-shim/index.js +201 -0
- package/lib-shim/index.js.map +1 -0
- package/package.json +4 -4
- package/lib/index.d.ts.map +0 -1
- package/lib/index.js.map +0 -1
|
@@ -0,0 +1,258 @@
|
|
|
1
|
+
import { IEnvironment } from '../utilities/Utilities';
|
|
2
|
+
/**
|
|
3
|
+
* @beta
|
|
4
|
+
*/
|
|
5
|
+
export interface IEnvironmentConfigurationInitializeOptions {
|
|
6
|
+
doNotNormalizePaths?: boolean;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Names of environment variables used by Rush.
|
|
10
|
+
* @beta
|
|
11
|
+
*/
|
|
12
|
+
export declare enum EnvironmentVariableNames {
|
|
13
|
+
/**
|
|
14
|
+
* This variable overrides the temporary folder used by Rush.
|
|
15
|
+
* The default value is "common/temp" under the repository root.
|
|
16
|
+
*
|
|
17
|
+
* @remarks This environment variable is not compatible with workspace installs. If attempting
|
|
18
|
+
* to move the PNPM store path, see the `RUSH_PNPM_STORE_PATH` environment variable.
|
|
19
|
+
*/
|
|
20
|
+
RUSH_TEMP_FOLDER = "RUSH_TEMP_FOLDER",
|
|
21
|
+
/**
|
|
22
|
+
* This variable overrides the version of Rush that will be installed by
|
|
23
|
+
* the version selector. The default value is determined by the "rushVersion"
|
|
24
|
+
* field from rush.json.
|
|
25
|
+
*/
|
|
26
|
+
RUSH_PREVIEW_VERSION = "RUSH_PREVIEW_VERSION",
|
|
27
|
+
/**
|
|
28
|
+
* If this variable is set to "1", Rush will not fail the build when running a version
|
|
29
|
+
* of Node that does not match the criteria specified in the "nodeSupportedVersionRange"
|
|
30
|
+
* field from rush.json.
|
|
31
|
+
*/
|
|
32
|
+
RUSH_ALLOW_UNSUPPORTED_NODEJS = "RUSH_ALLOW_UNSUPPORTED_NODEJS",
|
|
33
|
+
/**
|
|
34
|
+
* Setting this environment variable overrides the value of `allowWarningsInSuccessfulBuild`
|
|
35
|
+
* in the `command-line.json` configuration file. Specify `1` to allow warnings in a successful build,
|
|
36
|
+
* or `0` to disallow them. (See the comments in the command-line.json file for more information).
|
|
37
|
+
*/
|
|
38
|
+
RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD = "RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD",
|
|
39
|
+
/**
|
|
40
|
+
* This variable selects a specific installation variant for Rush to use when installing
|
|
41
|
+
* and linking package dependencies.
|
|
42
|
+
* For more information, see the command-line help for the `--variant` parameter
|
|
43
|
+
* and this article: https://rushjs.io/pages/advanced/installation_variants/
|
|
44
|
+
*/
|
|
45
|
+
RUSH_VARIANT = "RUSH_VARIANT",
|
|
46
|
+
/**
|
|
47
|
+
* Specifies the maximum number of concurrent processes to launch during a build.
|
|
48
|
+
* For more information, see the command-line help for the `--parallelism` parameter for "rush build".
|
|
49
|
+
*/
|
|
50
|
+
RUSH_PARALLELISM = "RUSH_PARALLELISM",
|
|
51
|
+
/**
|
|
52
|
+
* If this variable is set to "1", Rush will create symlinks with absolute paths instead
|
|
53
|
+
* of relative paths. This can be necessary when a repository is moved during a build or
|
|
54
|
+
* if parts of a repository are moved into a sandbox.
|
|
55
|
+
*/
|
|
56
|
+
RUSH_ABSOLUTE_SYMLINKS = "RUSH_ABSOLUTE_SYMLINKS",
|
|
57
|
+
/**
|
|
58
|
+
* When using PNPM as the package manager, this variable can be used to configure the path that
|
|
59
|
+
* PNPM will use as the store directory.
|
|
60
|
+
*
|
|
61
|
+
* If a relative path is used, then the store path will be resolved relative to the process's
|
|
62
|
+
* current working directory. An absolute path is recommended.
|
|
63
|
+
*/
|
|
64
|
+
RUSH_PNPM_STORE_PATH = "RUSH_PNPM_STORE_PATH",
|
|
65
|
+
/**
|
|
66
|
+
* When using PNPM as the package manager, this variable can be used to control whether or not PNPM
|
|
67
|
+
* validates the integrity of the PNPM store during installation. The value of this environment variable must be
|
|
68
|
+
* `1` (for true) or `0` (for false). If not specified, defaults to the value in .npmrc.
|
|
69
|
+
*/
|
|
70
|
+
RUSH_PNPM_VERIFY_STORE_INTEGRITY = "RUSH_PNPM_VERIFY_STORE_INTEGRITY",
|
|
71
|
+
/**
|
|
72
|
+
* This environment variable can be used to specify the `--target-folder` parameter
|
|
73
|
+
* for the "rush deploy" command.
|
|
74
|
+
*/
|
|
75
|
+
RUSH_DEPLOY_TARGET_FOLDER = "RUSH_DEPLOY_TARGET_FOLDER",
|
|
76
|
+
/**
|
|
77
|
+
* Overrides the location of the `~/.rush` global folder where Rush stores temporary files.
|
|
78
|
+
*
|
|
79
|
+
* @remarks
|
|
80
|
+
*
|
|
81
|
+
* Most of the temporary files created by Rush are stored separately for each monorepo working folder,
|
|
82
|
+
* to avoid issues of concurrency and compatibility between tool versions. However, a small set
|
|
83
|
+
* of files (e.g. installations of the `@microsoft/rush-lib` engine and the package manager) are stored
|
|
84
|
+
* in a global folder to speed up installations. The default location is `~/.rush` on POSIX-like
|
|
85
|
+
* operating systems or `C:\Users\YourName` on Windows.
|
|
86
|
+
*
|
|
87
|
+
* Use `RUSH_GLOBAL_FOLDER` to specify a different folder path. This is useful for example if a Windows
|
|
88
|
+
* group policy forbids executing scripts installed in a user's home directory.
|
|
89
|
+
*
|
|
90
|
+
* POSIX is a registered trademark of the Institute of Electrical and Electronic Engineers, Inc.
|
|
91
|
+
*/
|
|
92
|
+
RUSH_GLOBAL_FOLDER = "RUSH_GLOBAL_FOLDER",
|
|
93
|
+
/**
|
|
94
|
+
* Provides a credential for a remote build cache, if configured. This credential overrides any cached credentials.
|
|
95
|
+
*
|
|
96
|
+
* @remarks
|
|
97
|
+
* Setting this environment variable overrides whatever credential has been saved in the
|
|
98
|
+
* local cloud cache credentials using `rush update-cloud-credentials`.
|
|
99
|
+
*
|
|
100
|
+
*
|
|
101
|
+
* If Azure Blob Storage is used to store cache entries, this must be a SAS token serialized as query
|
|
102
|
+
* parameters.
|
|
103
|
+
*
|
|
104
|
+
* For information on SAS tokens, see here: https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview
|
|
105
|
+
*/
|
|
106
|
+
RUSH_BUILD_CACHE_CREDENTIAL = "RUSH_BUILD_CACHE_CREDENTIAL",
|
|
107
|
+
/**
|
|
108
|
+
* Setting this environment variable overrides the value of `buildCacheEnabled` in the `build-cache.json`
|
|
109
|
+
* configuration file.
|
|
110
|
+
*
|
|
111
|
+
* @remarks
|
|
112
|
+
* Specify `1` to enable the build cache or `0` to disable it.
|
|
113
|
+
*
|
|
114
|
+
* If there is no build cache configured, then this environment variable is ignored.
|
|
115
|
+
*/
|
|
116
|
+
RUSH_BUILD_CACHE_ENABLED = "RUSH_BUILD_CACHE_ENABLED",
|
|
117
|
+
/**
|
|
118
|
+
* Overrides the value of `isCacheWriteAllowed` in the `build-cache.json` configuration file. The value of this
|
|
119
|
+
* environment variable must be `1` (for true) or `0` (for false). If there is no build cache configured, then
|
|
120
|
+
* this environment variable is ignored.
|
|
121
|
+
*/
|
|
122
|
+
RUSH_BUILD_CACHE_WRITE_ALLOWED = "RUSH_BUILD_CACHE_WRITE_ALLOWED",
|
|
123
|
+
/**
|
|
124
|
+
* Explicitly specifies the path for the Git binary that is invoked by certain Rush operations.
|
|
125
|
+
*/
|
|
126
|
+
RUSH_GIT_BINARY_PATH = "RUSH_GIT_BINARY_PATH",
|
|
127
|
+
/**
|
|
128
|
+
* Explicitly specifies the path for the `tar` binary that is invoked by certain Rush operations.
|
|
129
|
+
*/
|
|
130
|
+
RUSH_TAR_BINARY_PATH = "RUSH_TAR_BINARY_PATH",
|
|
131
|
+
/**
|
|
132
|
+
* When Rush executes shell scripts, it sometimes changes the working directory to be a project folder or
|
|
133
|
+
* the repository root folder. The original working directory (where the Rush command was invoked) is assigned
|
|
134
|
+
* to the the child process's `RUSH_INVOKED_FOLDER` environment variable, in case it is needed by the script.
|
|
135
|
+
*
|
|
136
|
+
* @remarks
|
|
137
|
+
* The `RUSH_INVOKED_FOLDER` variable is the same idea as the `INIT_CWD` variable that package managers
|
|
138
|
+
* assign when they execute lifecycle scripts.
|
|
139
|
+
*/
|
|
140
|
+
RUSH_INVOKED_FOLDER = "RUSH_INVOKED_FOLDER"
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* Provides Rush-specific environment variable data. All Rush environment variables must start with "RUSH_". This class
|
|
144
|
+
* is designed to be used by RushConfiguration.
|
|
145
|
+
* @beta
|
|
146
|
+
*
|
|
147
|
+
* @remarks
|
|
148
|
+
* Initialize will throw if any unknown parameters are present.
|
|
149
|
+
*/
|
|
150
|
+
export declare class EnvironmentConfiguration {
|
|
151
|
+
private static _hasBeenValidated;
|
|
152
|
+
private static _rushTempFolderOverride;
|
|
153
|
+
private static _absoluteSymlinks;
|
|
154
|
+
private static _allowUnsupportedNodeVersion;
|
|
155
|
+
private static _allowWarningsInSuccessfulBuild;
|
|
156
|
+
private static _pnpmStorePathOverride;
|
|
157
|
+
private static _pnpmVerifyStoreIntegrity;
|
|
158
|
+
private static _rushGlobalFolderOverride;
|
|
159
|
+
private static _buildCacheCredential;
|
|
160
|
+
private static _buildCacheEnabled;
|
|
161
|
+
private static _buildCacheWriteAllowed;
|
|
162
|
+
private static _gitBinaryPath;
|
|
163
|
+
private static _tarBinaryPath;
|
|
164
|
+
/**
|
|
165
|
+
* An override for the common/temp folder path.
|
|
166
|
+
*/
|
|
167
|
+
static get rushTempFolderOverride(): string | undefined;
|
|
168
|
+
/**
|
|
169
|
+
* If "1", create symlinks with absolute paths instead of relative paths.
|
|
170
|
+
* See {@link EnvironmentVariableNames.RUSH_ABSOLUTE_SYMLINKS}
|
|
171
|
+
*/
|
|
172
|
+
static get absoluteSymlinks(): boolean;
|
|
173
|
+
/**
|
|
174
|
+
* If this environment variable is set to "1", the Node.js version check will print a warning
|
|
175
|
+
* instead of causing a hard error if the environment's Node.js version doesn't match the
|
|
176
|
+
* version specifier in `rush.json`'s "nodeSupportedVersionRange" property.
|
|
177
|
+
*
|
|
178
|
+
* See {@link EnvironmentVariableNames.RUSH_ALLOW_UNSUPPORTED_NODEJS}.
|
|
179
|
+
*/
|
|
180
|
+
static get allowUnsupportedNodeVersion(): boolean;
|
|
181
|
+
/**
|
|
182
|
+
* Setting this environment variable overrides the value of `allowWarningsInSuccessfulBuild`
|
|
183
|
+
* in the `command-line.json` configuration file. Specify `1` to allow warnings in a successful build,
|
|
184
|
+
* or `0` to disallow them. (See the comments in the command-line.json file for more information).
|
|
185
|
+
*/
|
|
186
|
+
static get allowWarningsInSuccessfulBuild(): boolean;
|
|
187
|
+
/**
|
|
188
|
+
* An override for the PNPM store path, if `pnpmStore` configuration is set to 'path'
|
|
189
|
+
* See {@link EnvironmentVariableNames.RUSH_PNPM_STORE_PATH}
|
|
190
|
+
*/
|
|
191
|
+
static get pnpmStorePathOverride(): string | undefined;
|
|
192
|
+
/**
|
|
193
|
+
* If specified, enables or disables integrity verification of the pnpm store during install.
|
|
194
|
+
* See {@link EnvironmentVariableNames.RUSH_PNPM_VERIFY_STORE_INTEGRITY}
|
|
195
|
+
*/
|
|
196
|
+
static get pnpmVerifyStoreIntegrity(): boolean | undefined;
|
|
197
|
+
/**
|
|
198
|
+
* Overrides the location of the `~/.rush` global folder where Rush stores temporary files.
|
|
199
|
+
* See {@link EnvironmentVariableNames.RUSH_GLOBAL_FOLDER}
|
|
200
|
+
*/
|
|
201
|
+
static get rushGlobalFolderOverride(): string | undefined;
|
|
202
|
+
/**
|
|
203
|
+
* Provides a credential for reading from and writing to a remote build cache, if configured.
|
|
204
|
+
* See {@link EnvironmentVariableNames.RUSH_BUILD_CACHE_CREDENTIAL}
|
|
205
|
+
*/
|
|
206
|
+
static get buildCacheCredential(): string | undefined;
|
|
207
|
+
/**
|
|
208
|
+
* If set, enables or disables the cloud build cache feature.
|
|
209
|
+
* See {@link EnvironmentVariableNames.RUSH_BUILD_CACHE_ENABLED}
|
|
210
|
+
*/
|
|
211
|
+
static get buildCacheEnabled(): boolean | undefined;
|
|
212
|
+
/**
|
|
213
|
+
* If set, enables or disables writing to the cloud build cache.
|
|
214
|
+
* See {@link EnvironmentVariableNames.RUSH_BUILD_CACHE_WRITE_ALLOWED}
|
|
215
|
+
*/
|
|
216
|
+
static get buildCacheWriteAllowed(): boolean | undefined;
|
|
217
|
+
/**
|
|
218
|
+
* Allows the git binary path to be explicitly provided.
|
|
219
|
+
* See {@link EnvironmentVariableNames.RUSH_GIT_BINARY_PATH}
|
|
220
|
+
*/
|
|
221
|
+
static get gitBinaryPath(): string | undefined;
|
|
222
|
+
/**
|
|
223
|
+
* Allows the tar binary path to be explicitly provided.
|
|
224
|
+
* See {@link EnvironmentVariableNames.RUSH_TAR_BINARY_PATH}
|
|
225
|
+
*/
|
|
226
|
+
static get tarBinaryPath(): string | undefined;
|
|
227
|
+
/**
|
|
228
|
+
* The front-end RushVersionSelector relies on `RUSH_GLOBAL_FOLDER`, so its value must be read before
|
|
229
|
+
* `EnvironmentConfiguration` is initialized (and actually before the correct version of `EnvironmentConfiguration`
|
|
230
|
+
* is even installed). Thus we need to read this environment variable differently from all the others.
|
|
231
|
+
* @internal
|
|
232
|
+
*/
|
|
233
|
+
static _getRushGlobalFolderOverride(processEnv: IEnvironment): string | undefined;
|
|
234
|
+
/**
|
|
235
|
+
* Reads and validates environment variables. If any are invalid, this function will throw.
|
|
236
|
+
*/
|
|
237
|
+
static validate(options?: IEnvironmentConfigurationInitializeOptions): void;
|
|
238
|
+
/**
|
|
239
|
+
* Resets EnvironmentConfiguration into an un-initialized state.
|
|
240
|
+
*/
|
|
241
|
+
static reset(): void;
|
|
242
|
+
private static _ensureValidated;
|
|
243
|
+
static parseBooleanEnvironmentVariable(name: string, value: string | undefined): boolean | undefined;
|
|
244
|
+
/**
|
|
245
|
+
* Given a path to a folder (that may or may not exist), normalize the path, including casing,
|
|
246
|
+
* to the first existing parent folder in the path.
|
|
247
|
+
*
|
|
248
|
+
* If no existing path can be found (for example, if the root is a volume that doesn't exist),
|
|
249
|
+
* this function returns undefined.
|
|
250
|
+
*
|
|
251
|
+
* @example
|
|
252
|
+
* If the following path exists on disk: `C:\Folder1\folder2\`
|
|
253
|
+
* _normalizeFirstExistingFolderPath('c:\\folder1\\folder2\\temp\\subfolder')
|
|
254
|
+
* returns 'C:\\Folder1\\folder2\\temp\\subfolder'
|
|
255
|
+
*/
|
|
256
|
+
private static _normalizeDeepestParentFolderPath;
|
|
257
|
+
}
|
|
258
|
+
//# sourceMappingURL=EnvironmentConfiguration.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("api/EnvironmentConfiguration");
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import { IEventHooksJson } from './RushConfiguration';
|
|
2
|
+
/**
|
|
3
|
+
* Events happen during Rush runs.
|
|
4
|
+
* @beta
|
|
5
|
+
*/
|
|
6
|
+
export declare enum Event {
|
|
7
|
+
/**
|
|
8
|
+
* Pre Rush install event
|
|
9
|
+
*/
|
|
10
|
+
preRushInstall = 1,
|
|
11
|
+
/**
|
|
12
|
+
* Post Rush install event
|
|
13
|
+
*/
|
|
14
|
+
postRushInstall = 2,
|
|
15
|
+
/**
|
|
16
|
+
* Pre Rush build event
|
|
17
|
+
*/
|
|
18
|
+
preRushBuild = 3,
|
|
19
|
+
/**
|
|
20
|
+
* Post Rush build event
|
|
21
|
+
*/
|
|
22
|
+
postRushBuild = 4
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* This class represents Rush event hooks configured for this repo.
|
|
26
|
+
* Hooks are customized script actions that Rush executes when specific events occur.
|
|
27
|
+
* The actions are expressed as a command-line that is executed using the operating system shell.
|
|
28
|
+
* @beta
|
|
29
|
+
*/
|
|
30
|
+
export declare class EventHooks {
|
|
31
|
+
private _hooks;
|
|
32
|
+
/**
|
|
33
|
+
* @internal
|
|
34
|
+
*/
|
|
35
|
+
constructor(eventHooksJson: IEventHooksJson);
|
|
36
|
+
/**
|
|
37
|
+
* Return all the scripts associated with the specified event.
|
|
38
|
+
* @param event - Rush event
|
|
39
|
+
*/
|
|
40
|
+
get(event: Event): string[];
|
|
41
|
+
}
|
|
42
|
+
//# sourceMappingURL=EventHooks.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("api/EventHooks");
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This interface represents the raw experiments.json file which allows repo
|
|
3
|
+
* maintainers to enable and disable experimental Rush features.
|
|
4
|
+
* @beta
|
|
5
|
+
*/
|
|
6
|
+
export interface IExperimentsJson {
|
|
7
|
+
/**
|
|
8
|
+
* By default, 'rush install' passes --no-prefer-frozen-lockfile to 'pnpm install'.
|
|
9
|
+
* Set this option to true to pass '--frozen-lockfile' instead.
|
|
10
|
+
*/
|
|
11
|
+
usePnpmFrozenLockfileForRushInstall?: boolean;
|
|
12
|
+
/**
|
|
13
|
+
* By default, 'rush update' passes --no-prefer-frozen-lockfile to 'pnpm install'.
|
|
14
|
+
* Set this option to true to pass '--prefer-frozen-lockfile' instead.
|
|
15
|
+
*/
|
|
16
|
+
usePnpmPreferFrozenLockfileForRushUpdate?: boolean;
|
|
17
|
+
/**
|
|
18
|
+
* If using the 'preventManualShrinkwrapChanges' option, restricts the hash to only include the layout of external dependencies.
|
|
19
|
+
* Used to allow links between workspace projects or the addition/removal of references to existing dependency versions to not
|
|
20
|
+
* cause hash changes.
|
|
21
|
+
*/
|
|
22
|
+
omitImportersFromPreventManualShrinkwrapChanges?: boolean;
|
|
23
|
+
/**
|
|
24
|
+
* If true, the chmod field in temporary project tar headers will not be normalized.
|
|
25
|
+
* This normalization can help ensure consistent tarball integrity across platforms.
|
|
26
|
+
*/
|
|
27
|
+
noChmodFieldInTarHeaderNormalization?: boolean;
|
|
28
|
+
/**
|
|
29
|
+
* If true, build caching will respect the allowWarningsInSuccessfulBuild flag and cache builds with warnings.
|
|
30
|
+
* This will not replay warnings from the cached build.
|
|
31
|
+
*/
|
|
32
|
+
buildCacheWithAllowWarningsInSuccessfulBuild?: boolean;
|
|
33
|
+
/**
|
|
34
|
+
* If true, the phased commands feature is enabled. To use this feature, create a "phased" command
|
|
35
|
+
* in common/config/rush/command-line.json.
|
|
36
|
+
*/
|
|
37
|
+
phasedCommands?: boolean;
|
|
38
|
+
/**
|
|
39
|
+
* If true, perform a clean install after when running `rush install` or `rush update` if the
|
|
40
|
+
* `.npmrc` file has changed since the last install.
|
|
41
|
+
*/
|
|
42
|
+
cleanInstallAfterNpmrcChanges?: boolean;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Use this class to load the "common/config/rush/experiments.json" config file.
|
|
46
|
+
* This file allows repo maintainers to enable and disable experimental Rush features.
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
export declare class ExperimentsConfiguration {
|
|
50
|
+
private static _jsonSchema;
|
|
51
|
+
private _jsonFileName;
|
|
52
|
+
/**
|
|
53
|
+
* Get the experiments configuration.
|
|
54
|
+
* @beta
|
|
55
|
+
*/
|
|
56
|
+
readonly configuration: Readonly<IExperimentsJson>;
|
|
57
|
+
/**
|
|
58
|
+
* @internal
|
|
59
|
+
*/
|
|
60
|
+
constructor(jsonFileName: string);
|
|
61
|
+
}
|
|
62
|
+
//# sourceMappingURL=ExperimentsConfiguration.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("api/ExperimentsConfiguration");
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
import { JsonObject } from '@rushstack/node-core-library';
|
|
2
|
+
import { RushConfiguration } from './RushConfiguration';
|
|
3
|
+
export declare const LAST_INSTALL_FLAG_FILE_NAME: string;
|
|
4
|
+
/**
|
|
5
|
+
* @internal
|
|
6
|
+
*/
|
|
7
|
+
export interface ILockfileValidityCheckOptions {
|
|
8
|
+
statePropertiesToIgnore?: string[];
|
|
9
|
+
rushVerb?: string;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* A helper class for managing last-install flags, which are persistent and
|
|
13
|
+
* indicate that something installed in the folder was successfully completed.
|
|
14
|
+
* It also compares state, so that if something like the Node.js version has changed,
|
|
15
|
+
* it can invalidate the last install.
|
|
16
|
+
* @internal
|
|
17
|
+
*/
|
|
18
|
+
export declare class LastInstallFlag {
|
|
19
|
+
private _state;
|
|
20
|
+
/**
|
|
21
|
+
* Returns the full path to the flag file
|
|
22
|
+
*/
|
|
23
|
+
readonly path: string;
|
|
24
|
+
/**
|
|
25
|
+
* Creates a new LastInstall flag
|
|
26
|
+
* @param folderPath - the folder that this flag is managing
|
|
27
|
+
* @param state - optional, the state that should be managed or compared
|
|
28
|
+
*/
|
|
29
|
+
constructor(folderPath: string, state?: JsonObject);
|
|
30
|
+
/**
|
|
31
|
+
* Returns true if the file exists and the contents match the current state.
|
|
32
|
+
*/
|
|
33
|
+
isValid(options?: ILockfileValidityCheckOptions): boolean;
|
|
34
|
+
/**
|
|
35
|
+
* Same as isValid(), but with an additional check: If the current state is not equal to the previous
|
|
36
|
+
* state, and an the current state causes an error, then throw an exception with a friendly message.
|
|
37
|
+
*
|
|
38
|
+
* @internal
|
|
39
|
+
*/
|
|
40
|
+
checkValidAndReportStoreIssues(options: ILockfileValidityCheckOptions & {
|
|
41
|
+
rushVerb: string;
|
|
42
|
+
}): boolean;
|
|
43
|
+
private _isValid;
|
|
44
|
+
/**
|
|
45
|
+
* Writes the flag file to disk with the current state
|
|
46
|
+
*/
|
|
47
|
+
create(): void;
|
|
48
|
+
/**
|
|
49
|
+
* Removes the flag file
|
|
50
|
+
*/
|
|
51
|
+
clear(): void;
|
|
52
|
+
/**
|
|
53
|
+
* Returns the name of the flag file
|
|
54
|
+
*/
|
|
55
|
+
protected get flagName(): string;
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* A helper class for LastInstallFlag
|
|
59
|
+
*
|
|
60
|
+
* @internal
|
|
61
|
+
*/
|
|
62
|
+
export declare class LastInstallFlagFactory {
|
|
63
|
+
/**
|
|
64
|
+
* Gets the LastInstall flag and sets the current state. This state is used to compare
|
|
65
|
+
* against the last-known-good state tracked by the LastInstall flag.
|
|
66
|
+
* @param rushConfiguration - the configuration of the Rush repo to get the install
|
|
67
|
+
* state from
|
|
68
|
+
*
|
|
69
|
+
* @internal
|
|
70
|
+
*/
|
|
71
|
+
static getCommonTempFlag(rushConfiguration: RushConfiguration, extraState?: Record<string, string>): LastInstallFlag;
|
|
72
|
+
}
|
|
73
|
+
//# sourceMappingURL=LastInstallFlag.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("api/LastInstallFlag");
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { LastInstallFlag } from './LastInstallFlag';
|
|
2
|
+
import { RushConfiguration } from './RushConfiguration';
|
|
3
|
+
export declare const LAST_LINK_FLAG_FILE_NAME: string;
|
|
4
|
+
/**
|
|
5
|
+
* A helper class for managing the last-link flag, which is persistent and
|
|
6
|
+
* indicates that linking was completed successfully.
|
|
7
|
+
* @internal
|
|
8
|
+
*/
|
|
9
|
+
export declare class LastLinkFlag extends LastInstallFlag {
|
|
10
|
+
/**
|
|
11
|
+
* @override
|
|
12
|
+
*/
|
|
13
|
+
isValid(): boolean;
|
|
14
|
+
/**
|
|
15
|
+
* @override
|
|
16
|
+
*/
|
|
17
|
+
checkValidAndReportStoreIssues(): boolean;
|
|
18
|
+
/**
|
|
19
|
+
* Returns the name of the flag file
|
|
20
|
+
*
|
|
21
|
+
* @override
|
|
22
|
+
*/
|
|
23
|
+
protected get flagName(): string;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* A helper class for LastLinkFlag
|
|
27
|
+
*
|
|
28
|
+
* @internal
|
|
29
|
+
*/
|
|
30
|
+
export declare class LastLinkFlagFactory {
|
|
31
|
+
/**
|
|
32
|
+
* Gets the LastLink flag and sets the current state. This state is used to compare
|
|
33
|
+
* against the last-known-good state tracked by the LastLink flag.
|
|
34
|
+
* @param rushConfiguration - the configuration of the Rush repo to get the install
|
|
35
|
+
* state from
|
|
36
|
+
*
|
|
37
|
+
* @internal
|
|
38
|
+
*/
|
|
39
|
+
static getCommonTempFlag(rushConfiguration: RushConfiguration): LastLinkFlag;
|
|
40
|
+
}
|
|
41
|
+
//# sourceMappingURL=LastLinkFlag.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("api/LastLinkFlag");
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import { IPackageJson } from '@rushstack/node-core-library';
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
5
|
+
export declare enum DependencyType {
|
|
6
|
+
Regular = "dependencies",
|
|
7
|
+
Dev = "devDependencies",
|
|
8
|
+
Optional = "optionalDependencies",
|
|
9
|
+
Peer = "peerDependencies",
|
|
10
|
+
YarnResolutions = "resolutions"
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* @public
|
|
14
|
+
*/
|
|
15
|
+
export declare class PackageJsonDependency {
|
|
16
|
+
private _version;
|
|
17
|
+
private _onChange;
|
|
18
|
+
readonly name: string;
|
|
19
|
+
readonly dependencyType: DependencyType;
|
|
20
|
+
constructor(name: string, version: string, type: DependencyType, onChange: () => void);
|
|
21
|
+
get version(): string;
|
|
22
|
+
setVersion(newVersion: string): void;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
*/
|
|
27
|
+
export declare class PackageJsonEditor {
|
|
28
|
+
private readonly _dependencies;
|
|
29
|
+
private readonly _devDependencies;
|
|
30
|
+
private readonly _resolutions;
|
|
31
|
+
private _modified;
|
|
32
|
+
private _sourceData;
|
|
33
|
+
readonly filePath: string;
|
|
34
|
+
/**
|
|
35
|
+
* @internal
|
|
36
|
+
*/
|
|
37
|
+
protected constructor(filepath: string, data: IPackageJson);
|
|
38
|
+
static load(filePath: string): PackageJsonEditor;
|
|
39
|
+
static fromObject(object: IPackageJson, filename: string): PackageJsonEditor;
|
|
40
|
+
get name(): string;
|
|
41
|
+
get version(): string;
|
|
42
|
+
/**
|
|
43
|
+
* The list of dependencies of type DependencyType.Regular, DependencyType.Optional, or DependencyType.Peer.
|
|
44
|
+
*/
|
|
45
|
+
get dependencyList(): ReadonlyArray<PackageJsonDependency>;
|
|
46
|
+
/**
|
|
47
|
+
* The list of dependencies of type DependencyType.Dev.
|
|
48
|
+
*/
|
|
49
|
+
get devDependencyList(): ReadonlyArray<PackageJsonDependency>;
|
|
50
|
+
/**
|
|
51
|
+
* This field is a Yarn-specific feature that allows overriding of package resolution.
|
|
52
|
+
*
|
|
53
|
+
* @remarks
|
|
54
|
+
* See the {@link https://github.com/yarnpkg/rfcs/blob/master/implemented/0000-selective-versions-resolutions.md
|
|
55
|
+
* | 0000-selective-versions-resolutions.md RFC} for details.
|
|
56
|
+
*/
|
|
57
|
+
get resolutionsList(): ReadonlyArray<PackageJsonDependency>;
|
|
58
|
+
tryGetDependency(packageName: string): PackageJsonDependency | undefined;
|
|
59
|
+
tryGetDevDependency(packageName: string): PackageJsonDependency | undefined;
|
|
60
|
+
addOrUpdateDependency(packageName: string, newVersion: string, dependencyType: DependencyType): void;
|
|
61
|
+
removeDependency(packageName: string, dependencyType: DependencyType): void;
|
|
62
|
+
saveIfModified(): boolean;
|
|
63
|
+
/**
|
|
64
|
+
* Get the normalized package.json that represents the current state of the
|
|
65
|
+
* PackageJsonEditor. This method does not save any changes that were made to the
|
|
66
|
+
* package.json, but instead returns the object representation of what would be saved
|
|
67
|
+
* if saveIfModified() is called.
|
|
68
|
+
*/
|
|
69
|
+
saveToObject(): IPackageJson;
|
|
70
|
+
private _onChange;
|
|
71
|
+
/**
|
|
72
|
+
* Create a normalized shallow copy of the provided package.json without modifying the
|
|
73
|
+
* original. If the result of this method is being returned via a public facing method,
|
|
74
|
+
* it will still need to be deep-cloned to avoid propogating changes back to the
|
|
75
|
+
* original dataset.
|
|
76
|
+
*/
|
|
77
|
+
private _normalize;
|
|
78
|
+
}
|
|
79
|
+
//# sourceMappingURL=PackageJsonEditor.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("api/PackageJsonEditor");
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { PackageNameParser } from '@rushstack/node-core-library';
|
|
2
|
+
export declare class PackageNameParsers {
|
|
3
|
+
/**
|
|
4
|
+
* This is the default for `RushConfiguration.packageNameParser`.
|
|
5
|
+
*/
|
|
6
|
+
static rushDefault: PackageNameParser;
|
|
7
|
+
/**
|
|
8
|
+
* This is the `RushConfiguration.packageNameParser` used when `allowMostlyStandardPackageNames = true`
|
|
9
|
+
* in rush.json.
|
|
10
|
+
*/
|
|
11
|
+
static mostlyStandard: PackageNameParser;
|
|
12
|
+
/**
|
|
13
|
+
* Use this in contexts where we don't have easy access to `RushConfiguration.packageNameParser`
|
|
14
|
+
* AND the package name was already validated at some earlier stage.
|
|
15
|
+
*/
|
|
16
|
+
static permissive: PackageNameParser;
|
|
17
|
+
}
|
|
18
|
+
//# sourceMappingURL=PackageNameParsers.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("api/PackageNameParsers");
|