@rushstack/rush-sdk 5.90.2 → 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 +77 -11
- 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 +10 -10
- package/lib/index.d.ts.map +0 -1
- package/lib/index.js.map +0 -1
|
@@ -0,0 +1,242 @@
|
|
|
1
|
+
import { IPackageManagerOptionsJsonBase, PackageManagerOptionsConfigurationBase } from '../base/BasePackageManagerOptionsConfiguration';
|
|
2
|
+
/**
|
|
3
|
+
* This represents the available PNPM store options
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export declare type PnpmStoreOptions = 'local' | 'global';
|
|
7
|
+
/**
|
|
8
|
+
* @beta
|
|
9
|
+
*/
|
|
10
|
+
export interface IPnpmPeerDependencyRules {
|
|
11
|
+
ignoreMissing?: string[];
|
|
12
|
+
allowAny?: string[];
|
|
13
|
+
allowedVersions?: Record<string, string>;
|
|
14
|
+
}
|
|
15
|
+
export interface IPnpmPeerDependenciesMeta {
|
|
16
|
+
[packageName: string]: {
|
|
17
|
+
optional?: boolean;
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
export interface IPnpmPackageExtension {
|
|
21
|
+
dependencies?: Record<string, string>;
|
|
22
|
+
optionalDependencies?: Record<string, string>;
|
|
23
|
+
peerDependencies?: Record<string, string>;
|
|
24
|
+
peerDependenciesMeta?: IPnpmPeerDependenciesMeta;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Part of IRushConfigurationJson.
|
|
28
|
+
* @internal
|
|
29
|
+
*/
|
|
30
|
+
export interface IPnpmOptionsJson extends IPackageManagerOptionsJsonBase {
|
|
31
|
+
/**
|
|
32
|
+
* {@inheritDoc PnpmOptionsConfiguration.pnpmStore}
|
|
33
|
+
*/
|
|
34
|
+
pnpmStore?: PnpmStoreOptions;
|
|
35
|
+
/**
|
|
36
|
+
* {@inheritDoc PnpmOptionsConfiguration.strictPeerDependencies}
|
|
37
|
+
*/
|
|
38
|
+
strictPeerDependencies?: boolean;
|
|
39
|
+
/**
|
|
40
|
+
* {@inheritDoc PnpmOptionsConfiguration.preventManualShrinkwrapChanges}
|
|
41
|
+
*/
|
|
42
|
+
preventManualShrinkwrapChanges?: boolean;
|
|
43
|
+
/**
|
|
44
|
+
* {@inheritDoc PnpmOptionsConfiguration.useWorkspaces}
|
|
45
|
+
*/
|
|
46
|
+
useWorkspaces?: boolean;
|
|
47
|
+
/**
|
|
48
|
+
* {@inheritDoc PnpmOptionsConfiguration.globalOverrides}
|
|
49
|
+
*/
|
|
50
|
+
globalOverrides?: Record<string, string>;
|
|
51
|
+
/**
|
|
52
|
+
* {@inheritDoc PnpmOptionsConfiguration.globalPeerDependencyRules}
|
|
53
|
+
*/
|
|
54
|
+
globalPeerDependencyRules?: IPnpmPeerDependencyRules;
|
|
55
|
+
/**
|
|
56
|
+
* {@inheritDoc PnpmOptionsConfiguration.globalPackageExtensions}
|
|
57
|
+
*/
|
|
58
|
+
globalPackageExtensions?: Record<string, IPnpmPackageExtension>;
|
|
59
|
+
/**
|
|
60
|
+
* {@inheritDoc PnpmOptionsConfiguration.globalNeverBuiltDependencies}
|
|
61
|
+
*/
|
|
62
|
+
globalNeverBuiltDependencies?: string[];
|
|
63
|
+
/**
|
|
64
|
+
* {@inheritDoc PnpmOptionsConfiguration.globalAllowedDeprecatedVersions}
|
|
65
|
+
*/
|
|
66
|
+
globalAllowedDeprecatedVersions?: Record<string, string>;
|
|
67
|
+
/**
|
|
68
|
+
* {@inheritDoc PnpmOptionsConfiguration.globalPatchedDependencies}
|
|
69
|
+
*/
|
|
70
|
+
globalPatchedDependencies?: Record<string, string>;
|
|
71
|
+
/**
|
|
72
|
+
* {@inheritDoc PnpmOptionsConfiguration.unsupportedPackageJsonSettings}
|
|
73
|
+
*/
|
|
74
|
+
unsupportedPackageJsonSettings?: unknown;
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* Options that are only used when the PNPM package manager is selected.
|
|
78
|
+
* Use this class to load "common/config/rush/pnpm-config.json" file,
|
|
79
|
+
* or, load json from "pnpmOptions" field in "rush.json" for legacy support.
|
|
80
|
+
*
|
|
81
|
+
* @remarks
|
|
82
|
+
* It is valid to define these options in rush.json even if the PNPM package manager
|
|
83
|
+
* is not being used.
|
|
84
|
+
*
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
export declare class PnpmOptionsConfiguration extends PackageManagerOptionsConfigurationBase {
|
|
88
|
+
private static _jsonSchema;
|
|
89
|
+
private readonly _json;
|
|
90
|
+
private _globalPatchedDependencies;
|
|
91
|
+
/**
|
|
92
|
+
* The method used to resolve the store used by PNPM.
|
|
93
|
+
*
|
|
94
|
+
* @remarks
|
|
95
|
+
* Available options:
|
|
96
|
+
* - local: Use the standard Rush store path: common/temp/pnpm-store
|
|
97
|
+
* - global: Use PNPM's global store path
|
|
98
|
+
*/
|
|
99
|
+
readonly pnpmStore: PnpmStoreOptions;
|
|
100
|
+
/**
|
|
101
|
+
* The path for PNPM to use as the store directory.
|
|
102
|
+
*
|
|
103
|
+
* Will be overridden by environment variable RUSH_PNPM_STORE_PATH
|
|
104
|
+
*/
|
|
105
|
+
readonly pnpmStorePath: string;
|
|
106
|
+
/**
|
|
107
|
+
* If true, then Rush will add the "--strict-peer-dependencies" option when invoking PNPM.
|
|
108
|
+
*
|
|
109
|
+
* @remarks
|
|
110
|
+
* This causes "rush install" to fail if there are unsatisfied peer dependencies, which is
|
|
111
|
+
* an invalid state that can cause build failures or incompatible dependency versions.
|
|
112
|
+
* (For historical reasons, JavaScript package managers generally do not treat this invalid state
|
|
113
|
+
* as an error.)
|
|
114
|
+
*
|
|
115
|
+
* The default value is false. (For now.)
|
|
116
|
+
*/
|
|
117
|
+
readonly strictPeerDependencies: boolean;
|
|
118
|
+
/**
|
|
119
|
+
* If true, then `rush install` will report an error if manual modifications
|
|
120
|
+
* were made to the PNPM shrinkwrap file without running `rush update` afterwards.
|
|
121
|
+
*
|
|
122
|
+
* @remarks
|
|
123
|
+
* This feature protects against accidental inconsistencies that may be introduced
|
|
124
|
+
* if the PNPM shrinkwrap file (`pnpm-lock.yaml`) is manually edited. When this
|
|
125
|
+
* feature is enabled, `rush update` will write a hash of the shrinkwrap contents to repo-state.json,
|
|
126
|
+
* and then `rush update` and `rush install` will validate the hash. Note that this does not prohibit
|
|
127
|
+
* manual modifications, but merely requires `rush update` be run
|
|
128
|
+
* afterwards, ensuring that PNPM can report or repair any potential inconsistencies.
|
|
129
|
+
*
|
|
130
|
+
* To temporarily disable this validation when invoking `rush install`, use the
|
|
131
|
+
* `--bypass-policy` command-line parameter.
|
|
132
|
+
*
|
|
133
|
+
* The default value is false.
|
|
134
|
+
*/
|
|
135
|
+
readonly preventManualShrinkwrapChanges: boolean;
|
|
136
|
+
/**
|
|
137
|
+
* If true, then Rush will use the workspaces feature to install and link packages when invoking PNPM.
|
|
138
|
+
*
|
|
139
|
+
* @remarks
|
|
140
|
+
* The default value is true. (For now.)
|
|
141
|
+
*/
|
|
142
|
+
readonly useWorkspaces: boolean;
|
|
143
|
+
/**
|
|
144
|
+
* The "globalOverrides" setting provides a simple mechanism for overriding version selections
|
|
145
|
+
* for all dependencies of all projects in the monorepo workspace. The settings are copied
|
|
146
|
+
* into the `pnpm.overrides` field of the `common/temp/package.json` file that is generated
|
|
147
|
+
* by Rush during installation.
|
|
148
|
+
*
|
|
149
|
+
* Order of precedence: `.pnpmfile.cjs` has the highest precedence, followed by
|
|
150
|
+
* `unsupportedPackageJsonSettings`, `globalPeerDependencyRules`, `globalPackageExtensions`,
|
|
151
|
+
* and `globalOverrides` has lowest precedence.
|
|
152
|
+
*
|
|
153
|
+
* PNPM documentation: https://pnpm.io/package_json#pnpmoverrides
|
|
154
|
+
*/
|
|
155
|
+
readonly globalOverrides: Record<string, string> | undefined;
|
|
156
|
+
/**
|
|
157
|
+
* The `globalPeerDependencyRules` setting provides various settings for suppressing validation errors
|
|
158
|
+
* that are reported during installation with `strictPeerDependencies=true`. The settings are copied
|
|
159
|
+
* into the `pnpm.peerDependencyRules` field of the `common/temp/package.json` file that is generated
|
|
160
|
+
* by Rush during installation.
|
|
161
|
+
*
|
|
162
|
+
* Order of precedence: `.pnpmfile.cjs` has the highest precedence, followed by
|
|
163
|
+
* `unsupportedPackageJsonSettings`, `globalPeerDependencyRules`, `globalPackageExtensions`,
|
|
164
|
+
* and `globalOverrides` has lowest precedence.
|
|
165
|
+
*
|
|
166
|
+
* https://pnpm.io/package_json#pnpmpeerdependencyrules
|
|
167
|
+
*/
|
|
168
|
+
readonly globalPeerDependencyRules: IPnpmPeerDependencyRules | undefined;
|
|
169
|
+
/**
|
|
170
|
+
* The `globalPackageExtension` setting provides a way to patch arbitrary package.json fields
|
|
171
|
+
* for any PNPM dependency of the monorepo. The settings are copied into the `pnpm.packageExtensions`
|
|
172
|
+
* field of the `common/temp/package.json` file that is generated by Rush during installation.
|
|
173
|
+
* The `globalPackageExtension` setting has similar capabilities as `.pnpmfile.cjs` but without
|
|
174
|
+
* the downsides of an executable script (nondeterminism, unreliable caching, performance concerns).
|
|
175
|
+
*
|
|
176
|
+
* Order of precedence: `.pnpmfile.cjs` has the highest precedence, followed by
|
|
177
|
+
* `unsupportedPackageJsonSettings`, `globalPeerDependencyRules`, `globalPackageExtensions`,
|
|
178
|
+
* and `globalOverrides` has lowest precedence.
|
|
179
|
+
*
|
|
180
|
+
* PNPM documentation: https://pnpm.io/package_json#pnpmpackageextensions
|
|
181
|
+
*/
|
|
182
|
+
readonly globalPackageExtensions: Record<string, IPnpmPackageExtension> | undefined;
|
|
183
|
+
/**
|
|
184
|
+
* The `globalNeverBuiltDependencies` setting suppresses the `preinstall`, `install`, and `postinstall`
|
|
185
|
+
* lifecycle events for the specified NPM dependencies. This is useful for scripts with poor practices
|
|
186
|
+
* such as downloading large binaries without retries or attempting to invoke OS tools such as
|
|
187
|
+
* a C++ compiler. (PNPM's terminology refers to these lifecycle events as "building" a package;
|
|
188
|
+
* it has nothing to do with build system operations such as `rush build` or `rushx build`.)
|
|
189
|
+
* The settings are copied into the `pnpm.neverBuiltDependencies` field of the `common/temp/package.json`
|
|
190
|
+
* file that is generated by Rush during installation.
|
|
191
|
+
*
|
|
192
|
+
* PNPM documentation: https://pnpm.io/package_json#pnpmneverbuiltdependencies
|
|
193
|
+
*/
|
|
194
|
+
readonly globalNeverBuiltDependencies: string[] | undefined;
|
|
195
|
+
/**
|
|
196
|
+
* The `globalAllowedDeprecatedVersions` setting suppresses installation warnings for package
|
|
197
|
+
* versions that the NPM registry reports as being deprecated. This is useful if the
|
|
198
|
+
* deprecated package is an indirect dependency of an external package that has not released a fix.
|
|
199
|
+
* The settings are copied into the `pnpm.allowedDeprecatedVersions` field of the `common/temp/package.json`
|
|
200
|
+
* file that is generated by Rush during installation.
|
|
201
|
+
*
|
|
202
|
+
* PNPM documentation: https://pnpm.io/package_json#pnpmalloweddeprecatedversions
|
|
203
|
+
*
|
|
204
|
+
* If you are working to eliminate a deprecated version, it's better to specify `allowedDeprecatedVersions`
|
|
205
|
+
* in the package.json file for individual Rush projects.
|
|
206
|
+
*/
|
|
207
|
+
readonly globalAllowedDeprecatedVersions: Record<string, string> | undefined;
|
|
208
|
+
/**
|
|
209
|
+
* (USE AT YOUR OWN RISK) This is a free-form property bag that will be copied into
|
|
210
|
+
* the `common/temp/package.json` file that is generated by Rush during installation.
|
|
211
|
+
* This provides a way to experiment with new PNPM features. These settings will override
|
|
212
|
+
* any other Rush configuration associated with a given JSON field except for `.pnpmfile.cjs`.
|
|
213
|
+
*
|
|
214
|
+
* USAGE OF THIS SETTING IS NOT SUPPORTED BY THE RUSH MAINTAINERS AND MAY CAUSE RUSH
|
|
215
|
+
* TO MALFUNCTION. If you encounter a missing PNPM setting that you believe should
|
|
216
|
+
* be supported, please create a GitHub issue or PR. Note that Rush does not aim to
|
|
217
|
+
* support every possible PNPM setting, but rather to promote a battle-tested installation
|
|
218
|
+
* strategy that is known to provide a good experience for large teams with lots of projects.
|
|
219
|
+
*/
|
|
220
|
+
readonly unsupportedPackageJsonSettings: unknown | undefined;
|
|
221
|
+
readonly jsonFilename: string | undefined;
|
|
222
|
+
/**
|
|
223
|
+
* (GENERATED BY RUSH-PNPM PATCH-COMMIT) When modifying this property, make sure you know what you are doing.
|
|
224
|
+
*
|
|
225
|
+
* The `globalPatchedDependencies` is added/updated automatically when you run pnpm patch-commit
|
|
226
|
+
* command. It is a dictionary where the key should be the package name and exact version. The value
|
|
227
|
+
* should be a relative path to a patch file.
|
|
228
|
+
*
|
|
229
|
+
* PNPM documentation: https://pnpm.io/package_json#pnpmpatcheddependencies
|
|
230
|
+
*/
|
|
231
|
+
get globalPatchedDependencies(): Record<string, string> | undefined;
|
|
232
|
+
private constructor();
|
|
233
|
+
/** @internal */
|
|
234
|
+
static loadFromJsonFileOrThrow(jsonFilename: string, commonTempFolder: string): PnpmOptionsConfiguration;
|
|
235
|
+
/** @internal */
|
|
236
|
+
static loadFromJsonObject(json: IPnpmOptionsJson, commonTempFolder: string): PnpmOptionsConfiguration;
|
|
237
|
+
/**
|
|
238
|
+
* Updates patchedDependencies field of the PNPM options in the common/config/rush/pnpm-config.json file.
|
|
239
|
+
*/
|
|
240
|
+
updateGlobalPatchedDependencies(patchedDependencies: Record<string, string> | undefined): void;
|
|
241
|
+
}
|
|
242
|
+
//# sourceMappingURL=PnpmOptionsConfiguration.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/pnpm/PnpmOptionsConfiguration");
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { BaseProjectShrinkwrapFile } from '../base/BaseProjectShrinkwrapFile';
|
|
2
|
+
import { PnpmShrinkwrapFile } from './PnpmShrinkwrapFile';
|
|
3
|
+
/**
|
|
4
|
+
*
|
|
5
|
+
*/
|
|
6
|
+
export declare class PnpmProjectShrinkwrapFile extends BaseProjectShrinkwrapFile<PnpmShrinkwrapFile> {
|
|
7
|
+
/**
|
|
8
|
+
* Generate and write the project shrinkwrap file to <project>/.rush/temp/shrinkwrap-deps.json.
|
|
9
|
+
* @returns True if the project shrinkwrap was created or updated, false otherwise.
|
|
10
|
+
*/
|
|
11
|
+
updateProjectShrinkwrapAsync(): Promise<void>;
|
|
12
|
+
hasChanges(otherShrinkwrap: PnpmProjectShrinkwrapFile): boolean;
|
|
13
|
+
/**
|
|
14
|
+
* Generate the project shrinkwrap file content
|
|
15
|
+
*/
|
|
16
|
+
protected generateProjectShrinkwrapMap(): Map<string, string> | undefined;
|
|
17
|
+
protected generateWorkspaceProjectShrinkwrapMap(): Map<string, string> | undefined;
|
|
18
|
+
protected generateLegacyProjectShrinkwrapMap(): Map<string, string>;
|
|
19
|
+
private _addDependencyRecursive;
|
|
20
|
+
private _resolveAndAddPeerDependencies;
|
|
21
|
+
/**
|
|
22
|
+
* Save the current state of the object to project/.rush/temp/shrinkwrap-deps.json
|
|
23
|
+
*/
|
|
24
|
+
protected saveAsync(projectShrinkwrapMap: Map<string, string>): Promise<void>;
|
|
25
|
+
}
|
|
26
|
+
//# sourceMappingURL=PnpmProjectShrinkwrapFile.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/pnpm/PnpmProjectShrinkwrapFile");
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
import { BaseShrinkwrapFile } from '../base/BaseShrinkwrapFile';
|
|
2
|
+
import { DependencySpecifier } from '../DependencySpecifier';
|
|
3
|
+
import { RushConfiguration } from '../../api/RushConfiguration';
|
|
4
|
+
import { IShrinkwrapFilePolicyValidatorOptions } from '../policy/ShrinkwrapFilePolicy';
|
|
5
|
+
import { IExperimentsJson } from '../../api/ExperimentsConfiguration';
|
|
6
|
+
import { RushConfigurationProject } from '../../api/RushConfigurationProject';
|
|
7
|
+
import { PnpmProjectShrinkwrapFile } from './PnpmProjectShrinkwrapFile';
|
|
8
|
+
import { PackageManagerOptionsConfigurationBase } from '../base/BasePackageManagerOptionsConfiguration';
|
|
9
|
+
export interface IPeerDependenciesMetaYaml {
|
|
10
|
+
optional?: boolean;
|
|
11
|
+
}
|
|
12
|
+
export interface IPnpmShrinkwrapDependencyYaml {
|
|
13
|
+
/** Information about the resolved package */
|
|
14
|
+
resolution?: {
|
|
15
|
+
/** The hash of the tarball, to ensure archive integrity */
|
|
16
|
+
integrity: string;
|
|
17
|
+
/** The name of the tarball, if this was from a TGX file */
|
|
18
|
+
tarball?: string;
|
|
19
|
+
};
|
|
20
|
+
/** The list of dependencies and the resolved version */
|
|
21
|
+
dependencies?: {
|
|
22
|
+
[dependency: string]: string;
|
|
23
|
+
};
|
|
24
|
+
/** The list of optional dependencies and the resolved version */
|
|
25
|
+
optionalDependencies?: {
|
|
26
|
+
[dependency: string]: string;
|
|
27
|
+
};
|
|
28
|
+
/** The list of peer dependencies and the resolved version */
|
|
29
|
+
peerDependencies?: {
|
|
30
|
+
[dependency: string]: string;
|
|
31
|
+
};
|
|
32
|
+
/**
|
|
33
|
+
* Used to indicate optional peer dependencies, as described in this RFC:
|
|
34
|
+
* https://github.com/yarnpkg/rfcs/blob/master/accepted/0000-optional-peer-dependencies.md
|
|
35
|
+
*/
|
|
36
|
+
peerDependenciesMeta?: {
|
|
37
|
+
[dependency: string]: IPeerDependenciesMetaYaml;
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
export interface IPnpmShrinkwrapImporterYaml {
|
|
41
|
+
/** The list of resolved version numbers for direct dependencies */
|
|
42
|
+
dependencies?: {
|
|
43
|
+
[dependency: string]: string;
|
|
44
|
+
};
|
|
45
|
+
/** The list of resolved version numbers for dev dependencies */
|
|
46
|
+
devDependencies?: {
|
|
47
|
+
[dependency: string]: string;
|
|
48
|
+
};
|
|
49
|
+
/** The list of resolved version numbers for optional dependencies */
|
|
50
|
+
optionalDependencies?: {
|
|
51
|
+
[dependency: string]: string;
|
|
52
|
+
};
|
|
53
|
+
/** The list of specifiers used to resolve dependency versions */
|
|
54
|
+
specifiers: {
|
|
55
|
+
[dependency: string]: string;
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* This interface represents the raw pnpm-lock.YAML file
|
|
60
|
+
* Example:
|
|
61
|
+
* {
|
|
62
|
+
* "dependencies": {
|
|
63
|
+
* "@rush-temp/project1": "file:./projects/project1.tgz"
|
|
64
|
+
* },
|
|
65
|
+
* "packages": {
|
|
66
|
+
* "file:projects/library1.tgz": {
|
|
67
|
+
* "dependencies: {
|
|
68
|
+
* "markdown": "0.5.0"
|
|
69
|
+
* },
|
|
70
|
+
* "name": "@rush-temp/library1",
|
|
71
|
+
* "resolution": {
|
|
72
|
+
* "tarball": "file:projects/library1.tgz"
|
|
73
|
+
* },
|
|
74
|
+
* "version": "0.0.0"
|
|
75
|
+
* },
|
|
76
|
+
* "markdown/0.5.0": {
|
|
77
|
+
* "resolution": {
|
|
78
|
+
* "integrity": "sha1-KCBbVlqK51kt4gdGPWY33BgnIrI="
|
|
79
|
+
* }
|
|
80
|
+
* }
|
|
81
|
+
* },
|
|
82
|
+
* "registry": "http://localhost:4873/",
|
|
83
|
+
* "shrinkwrapVersion": 3,
|
|
84
|
+
* "specifiers": {
|
|
85
|
+
* "@rush-temp/project1": "file:./projects/project1.tgz"
|
|
86
|
+
* }
|
|
87
|
+
* }
|
|
88
|
+
*/
|
|
89
|
+
export interface IPnpmShrinkwrapYaml {
|
|
90
|
+
/** The list of resolved version numbers for direct dependencies */
|
|
91
|
+
dependencies: {
|
|
92
|
+
[dependency: string]: string;
|
|
93
|
+
};
|
|
94
|
+
/** The list of importers for local workspace projects */
|
|
95
|
+
importers: {
|
|
96
|
+
[relativePath: string]: IPnpmShrinkwrapImporterYaml;
|
|
97
|
+
};
|
|
98
|
+
/** The description of the solved graph */
|
|
99
|
+
packages: {
|
|
100
|
+
[dependencyVersion: string]: IPnpmShrinkwrapDependencyYaml;
|
|
101
|
+
};
|
|
102
|
+
/** URL of the registry which was used */
|
|
103
|
+
registry: string;
|
|
104
|
+
/** The list of specifiers used to resolve direct dependency versions */
|
|
105
|
+
specifiers: {
|
|
106
|
+
[dependency: string]: string;
|
|
107
|
+
};
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* Given an encoded "dependency key" from the PNPM shrinkwrap file, this parses it into an equivalent
|
|
111
|
+
* DependencySpecifier.
|
|
112
|
+
*
|
|
113
|
+
* @returns a SemVer string, or undefined if the version specifier cannot be parsed
|
|
114
|
+
*/
|
|
115
|
+
export declare function parsePnpmDependencyKey(dependencyName: string, dependencyKey: string): DependencySpecifier | undefined;
|
|
116
|
+
export declare class PnpmShrinkwrapFile extends BaseShrinkwrapFile {
|
|
117
|
+
readonly isWorkspaceCompatible: boolean;
|
|
118
|
+
readonly registry: string;
|
|
119
|
+
readonly dependencies: ReadonlyMap<string, string>;
|
|
120
|
+
readonly importers: ReadonlyMap<string, IPnpmShrinkwrapImporterYaml>;
|
|
121
|
+
readonly specifiers: ReadonlyMap<string, string>;
|
|
122
|
+
readonly packages: ReadonlyMap<string, IPnpmShrinkwrapDependencyYaml>;
|
|
123
|
+
private readonly _shrinkwrapJson;
|
|
124
|
+
private readonly _integrities;
|
|
125
|
+
private _pnpmfileConfiguration;
|
|
126
|
+
private constructor();
|
|
127
|
+
static loadFromFile(shrinkwrapYamlFilename: string): PnpmShrinkwrapFile | undefined;
|
|
128
|
+
static loadFromString(shrinkwrapContent: string): PnpmShrinkwrapFile;
|
|
129
|
+
getShrinkwrapHash(experimentsConfig?: IExperimentsJson): string;
|
|
130
|
+
/** @override */
|
|
131
|
+
validate(packageManagerOptionsConfig: PackageManagerOptionsConfigurationBase, policyOptions: IShrinkwrapFilePolicyValidatorOptions, experimentsConfig?: IExperimentsJson): void;
|
|
132
|
+
/** @override */
|
|
133
|
+
getTempProjectNames(): ReadonlyArray<string>;
|
|
134
|
+
/**
|
|
135
|
+
* Gets the path to the tarball file if the package is a tarball.
|
|
136
|
+
* Returns undefined if the package entry doesn't exist or the package isn't a tarball.
|
|
137
|
+
* Example of return value: file:projects/build-tools.tgz
|
|
138
|
+
*/
|
|
139
|
+
getTarballPath(packageName: string): string | undefined;
|
|
140
|
+
getTopLevelDependencyKey(dependencyName: string): string | undefined;
|
|
141
|
+
/**
|
|
142
|
+
* Gets the version number from the list of top-level dependencies in the "dependencies" section
|
|
143
|
+
* of the shrinkwrap file. Sample return values:
|
|
144
|
+
* '2.1.113'
|
|
145
|
+
* '1.9.0-dev.27'
|
|
146
|
+
* 'file:projects/empty-webpart-project.tgz'
|
|
147
|
+
* undefined
|
|
148
|
+
*
|
|
149
|
+
* @override
|
|
150
|
+
*/
|
|
151
|
+
getTopLevelDependencyVersion(dependencyName: string): DependencySpecifier | undefined;
|
|
152
|
+
/**
|
|
153
|
+
* The PNPM shrinkwrap file has top-level dependencies on the temp projects like this:
|
|
154
|
+
*
|
|
155
|
+
* ```
|
|
156
|
+
* dependencies:
|
|
157
|
+
* '@rush-temp/my-app': 'file:projects/my-app.tgz_25c559a5921686293a001a397be4dce0'
|
|
158
|
+
* packages:
|
|
159
|
+
* /@types/node/10.14.15:
|
|
160
|
+
* dev: false
|
|
161
|
+
* 'file:projects/my-app.tgz_25c559a5921686293a001a397be4dce0':
|
|
162
|
+
* dev: false
|
|
163
|
+
* name: '@rush-temp/my-app'
|
|
164
|
+
* version: 0.0.0
|
|
165
|
+
* ```
|
|
166
|
+
*
|
|
167
|
+
* We refer to 'file:projects/my-app.tgz_25c559a5921686293a001a397be4dce0' as the temp project dependency key
|
|
168
|
+
* of the temp project '@rush-temp/my-app'.
|
|
169
|
+
*/
|
|
170
|
+
getTempProjectDependencyKey(tempProjectName: string): string | undefined;
|
|
171
|
+
getShrinkwrapEntryFromTempProjectDependencyKey(tempProjectDependencyKey: string): IPnpmShrinkwrapDependencyYaml | undefined;
|
|
172
|
+
getShrinkwrapEntry(name: string, version: string): IPnpmShrinkwrapDependencyYaml | undefined;
|
|
173
|
+
/**
|
|
174
|
+
* Serializes the PNPM Shrinkwrap file
|
|
175
|
+
*
|
|
176
|
+
* @override
|
|
177
|
+
*/
|
|
178
|
+
protected serialize(): string;
|
|
179
|
+
/**
|
|
180
|
+
* Gets the resolved version number of a dependency for a specific temp project.
|
|
181
|
+
* For PNPM, we can reuse the version that another project is using.
|
|
182
|
+
* Note that this function modifies the shrinkwrap data if tryReusingPackageVersionsFromShrinkwrap is set to true.
|
|
183
|
+
*
|
|
184
|
+
* @override
|
|
185
|
+
*/
|
|
186
|
+
protected tryEnsureDependencyVersion(dependencySpecifier: DependencySpecifier, tempProjectName: string): DependencySpecifier | undefined;
|
|
187
|
+
/** @override */
|
|
188
|
+
findOrphanedProjects(rushConfiguration: RushConfiguration): ReadonlyArray<string>;
|
|
189
|
+
/** @override */
|
|
190
|
+
getProjectShrinkwrap(project: RushConfigurationProject): PnpmProjectShrinkwrapFile;
|
|
191
|
+
getImporterKeys(): Iterable<string>;
|
|
192
|
+
getImporterKeyByPath(workspaceRoot: string, projectFolder: string): string;
|
|
193
|
+
getImporter(importerKey: string): IPnpmShrinkwrapImporterYaml | undefined;
|
|
194
|
+
getIntegrityForImporter(importerKey: string): Map<string, string> | undefined;
|
|
195
|
+
/** @override */
|
|
196
|
+
isWorkspaceProjectModifiedAsync(project: RushConfigurationProject, variant?: string): Promise<boolean>;
|
|
197
|
+
private _getIntegrityForPackage;
|
|
198
|
+
private _addIntegrities;
|
|
199
|
+
/**
|
|
200
|
+
* Gets the package description for a tempProject from the shrinkwrap file.
|
|
201
|
+
*/
|
|
202
|
+
private _getPackageDescription;
|
|
203
|
+
private _getPackageId;
|
|
204
|
+
private _parsePnpmDependencyKey;
|
|
205
|
+
private _serializeInternal;
|
|
206
|
+
}
|
|
207
|
+
//# sourceMappingURL=PnpmShrinkwrapFile.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/pnpm/PnpmShrinkwrapFile");
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/pnpm/PnpmYamlCommon");
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { IPackageJson } from '@rushstack/node-core-library';
|
|
2
|
+
import { RushConfiguration } from '../../api/RushConfiguration';
|
|
3
|
+
/**
|
|
4
|
+
* Options used when generating the pnpmfile shim settings file.
|
|
5
|
+
*/
|
|
6
|
+
export interface IPnpmfileShimOptions {
|
|
7
|
+
/**
|
|
8
|
+
* The variant that the client pnpmfile will be sourced from.
|
|
9
|
+
*/
|
|
10
|
+
variant?: string;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Loads PNPM's pnpmfile.js configuration, and invokes it to preprocess package.json files,
|
|
14
|
+
* optionally utilizing a pnpmfile shim to inject preferred versions.
|
|
15
|
+
*/
|
|
16
|
+
export declare class PnpmfileConfiguration {
|
|
17
|
+
private _context;
|
|
18
|
+
private constructor();
|
|
19
|
+
static initializeAsync(rushConfiguration: RushConfiguration, pnpmfileShimOptions?: IPnpmfileShimOptions): Promise<PnpmfileConfiguration>;
|
|
20
|
+
static writeCommonTempPnpmfileShimAsync(rushConfiguration: RushConfiguration, options?: IPnpmfileShimOptions): Promise<void>;
|
|
21
|
+
private static _getPnpmfileShimSettingsAsync;
|
|
22
|
+
/**
|
|
23
|
+
* Transform a package.json file using the pnpmfile.js hook.
|
|
24
|
+
* @returns the transformed object, or the original input if pnpmfile.js was not found.
|
|
25
|
+
*/
|
|
26
|
+
transform(packageJson: IPackageJson): IPackageJson;
|
|
27
|
+
}
|
|
28
|
+
//# sourceMappingURL=PnpmfileConfiguration.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/pnpm/PnpmfileConfiguration");
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/pnpm/PnpmfileShim");
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { RushConfiguration } from '../../api/RushConfiguration';
|
|
2
|
+
export declare class GitEmailPolicy {
|
|
3
|
+
static validate(rushConfiguration: RushConfiguration): void;
|
|
4
|
+
static getEmailExampleLines(rushConfiguration: RushConfiguration): string[];
|
|
5
|
+
}
|
|
6
|
+
//# sourceMappingURL=GitEmailPolicy.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/policy/GitEmailPolicy");
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { RushConfiguration } from '../../api/RushConfiguration';
|
|
2
|
+
export interface IPolicyValidatorOptions {
|
|
3
|
+
bypassPolicy?: boolean;
|
|
4
|
+
allowShrinkwrapUpdates?: boolean;
|
|
5
|
+
shrinkwrapVariant?: string;
|
|
6
|
+
}
|
|
7
|
+
export declare class PolicyValidator {
|
|
8
|
+
static validatePolicy(rushConfiguration: RushConfiguration, options: IPolicyValidatorOptions): void;
|
|
9
|
+
}
|
|
10
|
+
//# sourceMappingURL=PolicyValidator.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/policy/PolicyValidator");
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { RushConfiguration } from '../../api/RushConfiguration';
|
|
2
|
+
import { IPolicyValidatorOptions } from './PolicyValidator';
|
|
3
|
+
import { RepoStateFile } from '../RepoStateFile';
|
|
4
|
+
export interface IShrinkwrapFilePolicyValidatorOptions extends IPolicyValidatorOptions {
|
|
5
|
+
repoState: RepoStateFile;
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* A policy that validates shrinkwrap files used by package managers.
|
|
9
|
+
*/
|
|
10
|
+
export declare class ShrinkwrapFilePolicy {
|
|
11
|
+
static validate(rushConfiguration: RushConfiguration, options: IPolicyValidatorOptions): void;
|
|
12
|
+
}
|
|
13
|
+
//# sourceMappingURL=ShrinkwrapFilePolicy.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/policy/ShrinkwrapFilePolicy");
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { RushConfiguration } from '../../api/RushConfiguration';
|
|
2
|
+
import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
|
|
3
|
+
import { IEvaluateSelectorOptions, ISelectorParser } from './ISelectorParser';
|
|
4
|
+
export interface IGitSelectorParserOptions {
|
|
5
|
+
/**
|
|
6
|
+
* If set to `true`, consider a project's external dependency installation layout as defined in the
|
|
7
|
+
* package manager lockfile when determining if it has changed.
|
|
8
|
+
*/
|
|
9
|
+
includeExternalDependencies: boolean;
|
|
10
|
+
/**
|
|
11
|
+
* If set to `true` apply the `incrementalBuildIgnoredGlobs` property in a project's `rush-project.json`
|
|
12
|
+
* and exclude matched files from change detection.
|
|
13
|
+
*/
|
|
14
|
+
enableFiltering: boolean;
|
|
15
|
+
}
|
|
16
|
+
export declare class GitChangedProjectSelectorParser implements ISelectorParser<RushConfigurationProject> {
|
|
17
|
+
private readonly _rushConfiguration;
|
|
18
|
+
private readonly _options;
|
|
19
|
+
constructor(rushConfiguration: RushConfiguration, options: IGitSelectorParserOptions);
|
|
20
|
+
evaluateSelectorAsync({ unscopedSelector, terminal }: IEvaluateSelectorOptions): Promise<Iterable<RushConfigurationProject>>;
|
|
21
|
+
getCompletions(): Iterable<string>;
|
|
22
|
+
}
|
|
23
|
+
//# sourceMappingURL=GitChangedProjectSelectorParser.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/selectors/GitChangedProjectSelectorParser");
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { ITerminal } from '@rushstack/node-core-library';
|
|
2
|
+
export interface IEvaluateSelectorOptions {
|
|
3
|
+
unscopedSelector: string;
|
|
4
|
+
terminal: ITerminal;
|
|
5
|
+
parameterName: string;
|
|
6
|
+
}
|
|
7
|
+
export interface ISelectorParser<T> {
|
|
8
|
+
evaluateSelectorAsync(options: IEvaluateSelectorOptions): Promise<Iterable<T>>;
|
|
9
|
+
getCompletions(): Iterable<string>;
|
|
10
|
+
}
|
|
11
|
+
//# sourceMappingURL=ISelectorParser.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/selectors/ISelectorParser");
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { RushConfiguration } from '../../api/RushConfiguration';
|
|
2
|
+
import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
|
|
3
|
+
import type { IEvaluateSelectorOptions, ISelectorParser } from './ISelectorParser';
|
|
4
|
+
export declare class NamedProjectSelectorParser implements ISelectorParser<RushConfigurationProject> {
|
|
5
|
+
private readonly _rushConfiguration;
|
|
6
|
+
constructor(rushConfiguration: RushConfiguration);
|
|
7
|
+
evaluateSelectorAsync({ unscopedSelector, terminal, parameterName }: IEvaluateSelectorOptions): Promise<Iterable<RushConfigurationProject>>;
|
|
8
|
+
getCompletions(): Iterable<string>;
|
|
9
|
+
}
|
|
10
|
+
//# sourceMappingURL=NamedProjectSelectorParser.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/selectors/NamedProjectSelectorParser");
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { RushConfiguration } from '../../api/RushConfiguration';
|
|
2
|
+
import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
|
|
3
|
+
import type { IEvaluateSelectorOptions, ISelectorParser } from './ISelectorParser';
|
|
4
|
+
export declare class TagProjectSelectorParser implements ISelectorParser<RushConfigurationProject> {
|
|
5
|
+
private readonly _rushConfiguration;
|
|
6
|
+
constructor(rushConfiguration: RushConfiguration);
|
|
7
|
+
evaluateSelectorAsync({ unscopedSelector, terminal, parameterName }: IEvaluateSelectorOptions): Promise<Iterable<RushConfigurationProject>>;
|
|
8
|
+
getCompletions(): Iterable<string>;
|
|
9
|
+
}
|
|
10
|
+
//# sourceMappingURL=TagProjectSelectorParser.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/selectors/TagProjectSelectorParser");
|