@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,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 VersionPolicyProjectSelectorParser 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=VersionPolicyProjectSelectorParser.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/selectors/VersionPolicyProjectSelectorParser");
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
export interface IArtifactoryPackageRegistryJson {
|
|
2
|
+
enabled: boolean;
|
|
3
|
+
userNpmrcLinesToAdd?: string[];
|
|
4
|
+
registryUrl: string;
|
|
5
|
+
artifactoryWebsiteUrl: string;
|
|
6
|
+
credentialType?: 'password' | 'authToken';
|
|
7
|
+
messageOverrides?: {
|
|
8
|
+
introduction?: string;
|
|
9
|
+
obtainAnAccount?: string;
|
|
10
|
+
visitWebsite?: string;
|
|
11
|
+
locateUserName?: string;
|
|
12
|
+
locateApiKey?: string;
|
|
13
|
+
};
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* This interface represents the raw artifactory.json file.
|
|
17
|
+
* @beta
|
|
18
|
+
*/
|
|
19
|
+
export interface IArtifactoryJson {
|
|
20
|
+
packageRegistry: IArtifactoryPackageRegistryJson;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Use this class to load the "common/config/rush/artifactory.json" config file.
|
|
24
|
+
* It configures the "rush setup" command.
|
|
25
|
+
*/
|
|
26
|
+
export declare class ArtifactoryConfiguration {
|
|
27
|
+
private static _jsonSchema;
|
|
28
|
+
private readonly _jsonFileName;
|
|
29
|
+
/**
|
|
30
|
+
* Get the artifactory configuration.
|
|
31
|
+
*/
|
|
32
|
+
readonly configuration: Readonly<IArtifactoryJson>;
|
|
33
|
+
/**
|
|
34
|
+
* @internal
|
|
35
|
+
*/
|
|
36
|
+
constructor(jsonFileName: string);
|
|
37
|
+
}
|
|
38
|
+
//# sourceMappingURL=ArtifactoryConfiguration.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/setup/ArtifactoryConfiguration");
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
/// <reference types="node" />
|
|
3
|
+
import * as readline from 'readline';
|
|
4
|
+
export declare class KeyboardLoop {
|
|
5
|
+
protected stdin: NodeJS.ReadStream;
|
|
6
|
+
protected stderr: NodeJS.WriteStream;
|
|
7
|
+
private _readlineInterface;
|
|
8
|
+
private _resolvePromise;
|
|
9
|
+
private _rejectPromise;
|
|
10
|
+
private _cursorHidden;
|
|
11
|
+
constructor();
|
|
12
|
+
get capturedInput(): boolean;
|
|
13
|
+
private _captureInput;
|
|
14
|
+
private _checkForTTY;
|
|
15
|
+
private _uncaptureInput;
|
|
16
|
+
protected hideCursor(): void;
|
|
17
|
+
protected unhideCursor(): void;
|
|
18
|
+
startAsync(): Promise<void>;
|
|
19
|
+
protected resolveAsync(): void;
|
|
20
|
+
protected rejectAsync(error: Error): void;
|
|
21
|
+
/** @virtual */
|
|
22
|
+
protected onStart(): void;
|
|
23
|
+
/** @virtual */
|
|
24
|
+
protected onKeypress(character: string, key: readline.Key): void;
|
|
25
|
+
private _onKeypress;
|
|
26
|
+
}
|
|
27
|
+
//# sourceMappingURL=KeyboardLoop.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/setup/KeyboardLoop");
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import { RushConfiguration } from '../../api/RushConfiguration';
|
|
2
|
+
export interface ISetupPackageRegistryOptions {
|
|
3
|
+
rushConfiguration: RushConfiguration;
|
|
4
|
+
isDebug: boolean;
|
|
5
|
+
/**
|
|
6
|
+
* Whether Utilities.syncNpmrc() has already been called.
|
|
7
|
+
*/
|
|
8
|
+
syncNpmrcAlreadyCalled: boolean;
|
|
9
|
+
}
|
|
10
|
+
export declare class SetupPackageRegistry {
|
|
11
|
+
private readonly _options;
|
|
12
|
+
readonly rushConfiguration: RushConfiguration;
|
|
13
|
+
private readonly _terminal;
|
|
14
|
+
private readonly _artifactoryConfiguration;
|
|
15
|
+
private readonly _messages;
|
|
16
|
+
constructor(options: ISetupPackageRegistryOptions);
|
|
17
|
+
private _writeInstructionBlock;
|
|
18
|
+
/**
|
|
19
|
+
* Test whether the NPM token is valid.
|
|
20
|
+
*
|
|
21
|
+
* @returns - `true` if valid, `false` if not valid
|
|
22
|
+
*/
|
|
23
|
+
checkOnly(): Promise<boolean>;
|
|
24
|
+
/**
|
|
25
|
+
* Test whether the NPM token is valid. If not, prompt to update it.
|
|
26
|
+
*/
|
|
27
|
+
checkAndSetup(): Promise<void>;
|
|
28
|
+
/**
|
|
29
|
+
* Fetch a valid NPM token from the Artifactory service and add it to the `~/.npmrc` file,
|
|
30
|
+
* preserving other settings in that file.
|
|
31
|
+
*/
|
|
32
|
+
private _fetchTokenAndUpdateNpmrc;
|
|
33
|
+
/**
|
|
34
|
+
* Update the `~/.npmrc` file by adding `linesToAdd` to it.
|
|
35
|
+
* @remarks
|
|
36
|
+
*
|
|
37
|
+
* If the `.npmrc` file has existing content, it gets merged as follows:
|
|
38
|
+
* - If `linesToAdd` contains key/value pairs and the key already appears in .npmrc,
|
|
39
|
+
* that line will be overwritten in place
|
|
40
|
+
* - If `linesToAdd` contains non-key lines (e.g. a comment) and it exactly matches a
|
|
41
|
+
* line in .npmrc, then that line will be kept where it is
|
|
42
|
+
* - The remaining `linesToAdd` that weren't handled by one of the two rules above
|
|
43
|
+
* are simply appended to the end of the file
|
|
44
|
+
* - Under no circumstances is a duplicate key/value added to the file; in the case of
|
|
45
|
+
* duplicates, the earliest line in `linesToAdd` takes precedence
|
|
46
|
+
*/
|
|
47
|
+
private _mergeLinesIntoNpmrc;
|
|
48
|
+
private static _getNpmrcKey;
|
|
49
|
+
private static _isCommentLine;
|
|
50
|
+
/**
|
|
51
|
+
* This is a workaround for https://github.com/npm/cli/issues/2740 where the NPM tool sometimes
|
|
52
|
+
* mixes together JSON and terminal messages in a single STDERR stream.
|
|
53
|
+
*
|
|
54
|
+
* @remarks
|
|
55
|
+
* Given an input like this:
|
|
56
|
+
* ```
|
|
57
|
+
* npm ERR! 404 Note that you can also install from a
|
|
58
|
+
* npm ERR! 404 tarball, folder, http url, or git url.
|
|
59
|
+
* {
|
|
60
|
+
* "error": {
|
|
61
|
+
* "code": "E404",
|
|
62
|
+
* "summary": "Not Found - GET https://registry.npmjs.org/@rushstack%2fnonexistent-package - Not found"
|
|
63
|
+
* }
|
|
64
|
+
* }
|
|
65
|
+
* npm ERR! A complete log of this run can be found in:
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @returns the JSON section, or `undefined` if a JSON object could not be detected
|
|
69
|
+
*/
|
|
70
|
+
private static _tryFindJson;
|
|
71
|
+
}
|
|
72
|
+
//# sourceMappingURL=SetupPackageRegistry.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/setup/SetupPackageRegistry");
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
export interface IBasePromptOptions {
|
|
2
|
+
message: string;
|
|
3
|
+
}
|
|
4
|
+
export interface IPromptYesNoOptions extends IBasePromptOptions {
|
|
5
|
+
defaultValue?: boolean | undefined;
|
|
6
|
+
}
|
|
7
|
+
export interface IPromptPasswordOptions extends IBasePromptOptions {
|
|
8
|
+
/**
|
|
9
|
+
* The string length must not be longer than 1. An empty string means to show the input text.
|
|
10
|
+
* @defaultValue `*`
|
|
11
|
+
*/
|
|
12
|
+
passwordCharacter?: string;
|
|
13
|
+
}
|
|
14
|
+
export interface IPromptLineOptions extends IBasePromptOptions {
|
|
15
|
+
}
|
|
16
|
+
export declare class TerminalInput {
|
|
17
|
+
private static _readLine;
|
|
18
|
+
static promptYesNo(options: IPromptYesNoOptions): Promise<boolean>;
|
|
19
|
+
static promptLine(options: IPromptLineOptions): Promise<string>;
|
|
20
|
+
static promptPasswordLine(options: IPromptLineOptions): Promise<string>;
|
|
21
|
+
}
|
|
22
|
+
//# sourceMappingURL=TerminalInput.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/setup/TerminalInput");
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { RushConfiguration } from '../../api/RushConfiguration';
|
|
2
|
+
import { VersionMismatchFinderEntity } from './VersionMismatchFinderEntity';
|
|
3
|
+
export interface IVersionMismatchFinderOptions {
|
|
4
|
+
variant?: string | undefined;
|
|
5
|
+
}
|
|
6
|
+
export interface IVersionMismatchFinderRushCheckOptions extends IVersionMismatchFinderOptions {
|
|
7
|
+
printAsJson?: boolean | undefined;
|
|
8
|
+
truncateLongPackageNameLists?: boolean | undefined;
|
|
9
|
+
}
|
|
10
|
+
export interface IVersionMismatchFinderEnsureConsistentVersionsOptions extends IVersionMismatchFinderOptions {
|
|
11
|
+
}
|
|
12
|
+
export interface IVersionMismatchFinderGetMismatchesOptions extends IVersionMismatchFinderOptions {
|
|
13
|
+
}
|
|
14
|
+
export interface IMismatchDependency {
|
|
15
|
+
dependencyName: string;
|
|
16
|
+
versions: IMismatchDependencyVersion[];
|
|
17
|
+
}
|
|
18
|
+
export interface IMismatchDependencyVersion {
|
|
19
|
+
version: string;
|
|
20
|
+
projects: string[];
|
|
21
|
+
}
|
|
22
|
+
export interface IMismatchDependencies {
|
|
23
|
+
mismatchedVersions: IMismatchDependency[];
|
|
24
|
+
}
|
|
25
|
+
export declare class VersionMismatchFinder {
|
|
26
|
+
private _allowedAlternativeVersion;
|
|
27
|
+
private _mismatches;
|
|
28
|
+
private _projects;
|
|
29
|
+
constructor(projects: VersionMismatchFinderEntity[], allowedAlternativeVersions?: Map<string, ReadonlyArray<string>>);
|
|
30
|
+
static rushCheck(rushConfiguration: RushConfiguration, options?: IVersionMismatchFinderRushCheckOptions): void;
|
|
31
|
+
static ensureConsistentVersions(rushConfiguration: RushConfiguration, options?: IVersionMismatchFinderEnsureConsistentVersionsOptions): void;
|
|
32
|
+
/**
|
|
33
|
+
* Populates a version mismatch finder object given a Rush Configuration.
|
|
34
|
+
* Intentionally considers preferred versions.
|
|
35
|
+
*/
|
|
36
|
+
static getMismatches(rushConfiguration: RushConfiguration, options?: IVersionMismatchFinderOptions): VersionMismatchFinder;
|
|
37
|
+
private static _checkForInconsistentVersions;
|
|
38
|
+
get mismatches(): ReadonlyMap<string, ReadonlyMap<string, readonly VersionMismatchFinderEntity[]>>;
|
|
39
|
+
get numberOfMismatches(): number;
|
|
40
|
+
getMismatches(): string[];
|
|
41
|
+
getVersionsOfMismatch(mismatch: string): string[] | undefined;
|
|
42
|
+
getConsumersOfMismatch(mismatch: string, version: string): VersionMismatchFinderEntity[] | undefined;
|
|
43
|
+
printAsJson(): void;
|
|
44
|
+
print(truncateLongPackageNameLists?: boolean): void;
|
|
45
|
+
private _analyze;
|
|
46
|
+
private _isVersionAllowedAlternative;
|
|
47
|
+
private _getKeys;
|
|
48
|
+
}
|
|
49
|
+
//# sourceMappingURL=VersionMismatchFinder.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/versionMismatch/VersionMismatchFinder");
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { PackageJsonDependency, DependencyType } from '../../api/PackageJsonEditor';
|
|
2
|
+
import { CommonVersionsConfiguration } from '../../api/CommonVersionsConfiguration';
|
|
3
|
+
import { VersionMismatchFinderEntity } from './VersionMismatchFinderEntity';
|
|
4
|
+
export declare class VersionMismatchFinderCommonVersions extends VersionMismatchFinderEntity {
|
|
5
|
+
private _fileManager;
|
|
6
|
+
constructor(commonVersionsConfiguration: CommonVersionsConfiguration);
|
|
7
|
+
get filePath(): string;
|
|
8
|
+
get allDependencies(): ReadonlyArray<PackageJsonDependency>;
|
|
9
|
+
tryGetDependency(packageName: string): PackageJsonDependency | undefined;
|
|
10
|
+
tryGetDevDependency(packageName: string): PackageJsonDependency | undefined;
|
|
11
|
+
addOrUpdateDependency(packageName: string, newVersion: string, dependencyType: DependencyType): void;
|
|
12
|
+
removeDependency(packageName: string): void;
|
|
13
|
+
saveIfModified(): boolean;
|
|
14
|
+
private _getPackageJsonDependency;
|
|
15
|
+
}
|
|
16
|
+
//# sourceMappingURL=VersionMismatchFinderCommonVersions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/versionMismatch/VersionMismatchFinderCommonVersions");
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { PackageJsonDependency, DependencyType } from '../../api/PackageJsonEditor';
|
|
2
|
+
export interface IVersionMismatchFinderEntityOptions {
|
|
3
|
+
friendlyName: string;
|
|
4
|
+
decoupledLocalDependencies: Set<string>;
|
|
5
|
+
skipRushCheck?: boolean;
|
|
6
|
+
}
|
|
7
|
+
export declare abstract class VersionMismatchFinderEntity {
|
|
8
|
+
readonly friendlyName: string;
|
|
9
|
+
readonly decoupledLocalDependencies: Set<string>;
|
|
10
|
+
readonly skipRushCheck: boolean | undefined;
|
|
11
|
+
constructor(options: IVersionMismatchFinderEntityOptions);
|
|
12
|
+
abstract get filePath(): string;
|
|
13
|
+
abstract get allDependencies(): ReadonlyArray<PackageJsonDependency>;
|
|
14
|
+
abstract tryGetDependency(packageName: string): PackageJsonDependency | undefined;
|
|
15
|
+
abstract tryGetDevDependency(packageName: string): PackageJsonDependency | undefined;
|
|
16
|
+
abstract addOrUpdateDependency(packageName: string, newVersion: string, dependencyType: DependencyType): void;
|
|
17
|
+
abstract removeDependency(packageName: string, dependencyType: DependencyType): void;
|
|
18
|
+
abstract saveIfModified(): boolean;
|
|
19
|
+
}
|
|
20
|
+
//# sourceMappingURL=VersionMismatchFinderEntity.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/versionMismatch/VersionMismatchFinderEntity");
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { VersionMismatchFinderEntity } from './VersionMismatchFinderEntity';
|
|
2
|
+
import { PackageJsonDependency, DependencyType } from '../../api/PackageJsonEditor';
|
|
3
|
+
import { RushConfigurationProject } from '../../api/RushConfigurationProject';
|
|
4
|
+
export declare class VersionMismatchFinderProject extends VersionMismatchFinderEntity {
|
|
5
|
+
packageName: string;
|
|
6
|
+
private _fileManager;
|
|
7
|
+
constructor(project: RushConfigurationProject);
|
|
8
|
+
get filePath(): string;
|
|
9
|
+
get allDependencies(): ReadonlyArray<PackageJsonDependency>;
|
|
10
|
+
tryGetDependency(packageName: string): PackageJsonDependency | undefined;
|
|
11
|
+
tryGetDevDependency(packageName: string): PackageJsonDependency | undefined;
|
|
12
|
+
addOrUpdateDependency(packageName: string, newVersion: string, dependencyType: DependencyType): void;
|
|
13
|
+
removeDependency(packageName: string, dependencyType: DependencyType): void;
|
|
14
|
+
saveIfModified(): boolean;
|
|
15
|
+
}
|
|
16
|
+
//# sourceMappingURL=VersionMismatchFinderProject.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/versionMismatch/VersionMismatchFinderProject");
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { IPackageManagerOptionsJsonBase, PackageManagerOptionsConfigurationBase } from '../base/BasePackageManagerOptionsConfiguration';
|
|
2
|
+
/**
|
|
3
|
+
* Part of IRushConfigurationJson.
|
|
4
|
+
* @internal
|
|
5
|
+
*/
|
|
6
|
+
export interface IYarnOptionsJson extends IPackageManagerOptionsJsonBase {
|
|
7
|
+
/**
|
|
8
|
+
* If true, then Rush will add the "--ignore-engines" option when invoking Yarn.
|
|
9
|
+
* This allows "rush install" to succeed if there are dependencies with engines defined in
|
|
10
|
+
* package.json which do not match the current environment.
|
|
11
|
+
*
|
|
12
|
+
* The default value is false.
|
|
13
|
+
*/
|
|
14
|
+
ignoreEngines?: boolean;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Options that are only used when the yarn package manager is selected.
|
|
18
|
+
*
|
|
19
|
+
* @remarks
|
|
20
|
+
* It is valid to define these options in rush.json even if the yarn package manager
|
|
21
|
+
* is not being used.
|
|
22
|
+
*
|
|
23
|
+
* @public
|
|
24
|
+
*/
|
|
25
|
+
export declare class YarnOptionsConfiguration extends PackageManagerOptionsConfigurationBase {
|
|
26
|
+
/**
|
|
27
|
+
* If true, then Rush will add the "--ignore-engines" option when invoking Yarn.
|
|
28
|
+
* This allows "rush install" to succeed if there are dependencies with engines defined in
|
|
29
|
+
* package.json which do not match the current environment.
|
|
30
|
+
*
|
|
31
|
+
* The default value is false.
|
|
32
|
+
*/
|
|
33
|
+
readonly ignoreEngines: boolean;
|
|
34
|
+
/** @internal */
|
|
35
|
+
constructor(json: IYarnOptionsJson);
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=YarnOptionsConfiguration.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/yarn/YarnOptionsConfiguration");
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { BaseShrinkwrapFile } from '../base/BaseShrinkwrapFile';
|
|
2
|
+
import { DependencySpecifier } from '../DependencySpecifier';
|
|
3
|
+
import { RushConfigurationProject } from '../../api/RushConfigurationProject';
|
|
4
|
+
import { BaseProjectShrinkwrapFile } from '../base/BaseProjectShrinkwrapFile';
|
|
5
|
+
/**
|
|
6
|
+
* Support for consuming the "yarn.lock" file.
|
|
7
|
+
*
|
|
8
|
+
* Yarn refers to its shrinkwrap file as a "lock file", even though it has nothing to do
|
|
9
|
+
* with file locking. Apparently this was based on a convention of the Ruby bundler.
|
|
10
|
+
* Since Rush has to work interchangeably with 3 different package managers, here we refer
|
|
11
|
+
* generically to yarn.lock as a "shrinkwrap file".
|
|
12
|
+
*
|
|
13
|
+
* If Rush's Yarn support gains popularity, we will try to improve the wording of
|
|
14
|
+
* logging messages to use terminology more consistent with Yarn's own documentation.
|
|
15
|
+
*/
|
|
16
|
+
export declare class YarnShrinkwrapFile extends BaseShrinkwrapFile {
|
|
17
|
+
readonly isWorkspaceCompatible: boolean;
|
|
18
|
+
private static _packageNameAndSemVerRegExp;
|
|
19
|
+
private _shrinkwrapJson;
|
|
20
|
+
private _tempProjectNames;
|
|
21
|
+
private constructor();
|
|
22
|
+
static loadFromFile(shrinkwrapFilename: string): YarnShrinkwrapFile | undefined;
|
|
23
|
+
static loadFromString(shrinkwrapContent: string): YarnShrinkwrapFile;
|
|
24
|
+
/**
|
|
25
|
+
* The `@yarnpkg/lockfile` API only partially deserializes its data, and expects the caller
|
|
26
|
+
* to parse the yarn.lock lookup keys (sometimes called a "pattern").
|
|
27
|
+
*
|
|
28
|
+
* Example input: "js-tokens@^3.0.0 || ^4.0.0"
|
|
29
|
+
* Example output: { packageName: "js-tokens", semVerRange: "^3.0.0 || ^4.0.0" }
|
|
30
|
+
*/
|
|
31
|
+
private static _decodePackageNameAndSemVer;
|
|
32
|
+
/**
|
|
33
|
+
* This is the inverse of _decodePackageNameAndSemVer():
|
|
34
|
+
* Given an IPackageNameAndSemVer object, recreate the yarn.lock lookup key
|
|
35
|
+
* (sometimes called a "pattern").
|
|
36
|
+
*/
|
|
37
|
+
private static _encodePackageNameAndSemVer;
|
|
38
|
+
/** @override */
|
|
39
|
+
getTempProjectNames(): ReadonlyArray<string>;
|
|
40
|
+
/** @override */
|
|
41
|
+
hasCompatibleTopLevelDependency(dependencySpecifier: DependencySpecifier): boolean;
|
|
42
|
+
/** @override */
|
|
43
|
+
tryEnsureCompatibleDependency(dependencySpecifier: DependencySpecifier, tempProjectName: string): boolean;
|
|
44
|
+
/** @override */
|
|
45
|
+
protected serialize(): string;
|
|
46
|
+
/** @override */
|
|
47
|
+
protected getTopLevelDependencyVersion(dependencyName: string): DependencySpecifier | undefined;
|
|
48
|
+
/** @override */
|
|
49
|
+
protected tryEnsureDependencyVersion(dependencySpecifier: DependencySpecifier, tempProjectName: string): DependencySpecifier | undefined;
|
|
50
|
+
/** @override */
|
|
51
|
+
getProjectShrinkwrap(project: RushConfigurationProject): BaseProjectShrinkwrapFile<YarnShrinkwrapFile> | undefined;
|
|
52
|
+
/** @override */
|
|
53
|
+
isWorkspaceProjectModifiedAsync(project: RushConfigurationProject, variant?: string): Promise<boolean>;
|
|
54
|
+
}
|
|
55
|
+
//# sourceMappingURL=YarnShrinkwrapFile.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/yarn/YarnShrinkwrapFile");
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { RushConfiguration } from '../api/RushConfiguration';
|
|
2
|
+
import type { RushSession } from './RushSession';
|
|
3
|
+
/**
|
|
4
|
+
* @beta
|
|
5
|
+
*/
|
|
6
|
+
export interface IRushPlugin {
|
|
7
|
+
apply(rushSession: RushSession, rushConfiguration: RushConfiguration): void;
|
|
8
|
+
}
|
|
9
|
+
//# sourceMappingURL=IRushPlugin.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("pluginFramework/IRushPlugin");
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
import { AsyncSeriesHook, AsyncSeriesWaterfallHook, SyncHook } from 'tapable';
|
|
2
|
+
import type { CommandLineParameter } from '@rushstack/ts-command-line';
|
|
3
|
+
import type { BuildCacheConfiguration } from '../api/BuildCacheConfiguration';
|
|
4
|
+
import type { IPhase } from '../api/CommandLineConfiguration';
|
|
5
|
+
import type { RushConfiguration } from '../api/RushConfiguration';
|
|
6
|
+
import type { RushConfigurationProject } from '../api/RushConfigurationProject';
|
|
7
|
+
import type { Operation } from '../logic/operations/Operation';
|
|
8
|
+
import type { ProjectChangeAnalyzer } from '../logic/ProjectChangeAnalyzer';
|
|
9
|
+
import { IExecutionResult } from '../logic/operations/IOperationExecutionResult';
|
|
10
|
+
/**
|
|
11
|
+
* A plugin that interacts with a phased commands.
|
|
12
|
+
* @alpha
|
|
13
|
+
*/
|
|
14
|
+
export interface IPhasedCommandPlugin {
|
|
15
|
+
/**
|
|
16
|
+
* Applies this plugin.
|
|
17
|
+
*/
|
|
18
|
+
apply(hooks: PhasedCommandHooks): void;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Context used for creating operations to be executed.
|
|
22
|
+
* @alpha
|
|
23
|
+
*/
|
|
24
|
+
export interface ICreateOperationsContext {
|
|
25
|
+
/**
|
|
26
|
+
* The configuration for the build cache, if the feature is enabled.
|
|
27
|
+
*/
|
|
28
|
+
readonly buildCacheConfiguration: BuildCacheConfiguration | undefined;
|
|
29
|
+
/**
|
|
30
|
+
* The set of custom parameters for the executing command.
|
|
31
|
+
* Maps from the `longName` field in command-line.json to the parser configuration in ts-command-line.
|
|
32
|
+
*/
|
|
33
|
+
readonly customParameters: ReadonlyMap<string, CommandLineParameter>;
|
|
34
|
+
/**
|
|
35
|
+
* If true, projects may read their output from cache or be skipped if already up to date.
|
|
36
|
+
* If false, neither of the above may occur, e.g. "rush rebuild"
|
|
37
|
+
*/
|
|
38
|
+
readonly isIncrementalBuildAllowed: boolean;
|
|
39
|
+
/**
|
|
40
|
+
* If true, this is the initial run of the command.
|
|
41
|
+
* If false, this execution is in response to changes.
|
|
42
|
+
*/
|
|
43
|
+
readonly isInitial: boolean;
|
|
44
|
+
/**
|
|
45
|
+
* If true, the command is running in watch mode.
|
|
46
|
+
*/
|
|
47
|
+
readonly isWatch: boolean;
|
|
48
|
+
/**
|
|
49
|
+
* The set of phases selected for the current command execution.
|
|
50
|
+
*/
|
|
51
|
+
readonly phaseSelection: ReadonlySet<IPhase>;
|
|
52
|
+
/**
|
|
53
|
+
* The current state of the repository
|
|
54
|
+
*/
|
|
55
|
+
readonly projectChangeAnalyzer: ProjectChangeAnalyzer;
|
|
56
|
+
/**
|
|
57
|
+
* The set of Rush projects selected for the current command execution.
|
|
58
|
+
*/
|
|
59
|
+
readonly projectSelection: ReadonlySet<RushConfigurationProject>;
|
|
60
|
+
/**
|
|
61
|
+
* The set of Rush projects that have not been built in the current process since they were last modified.
|
|
62
|
+
* When `isInitial` is true, this will be an exact match of `projectSelection`.
|
|
63
|
+
*/
|
|
64
|
+
readonly projectsInUnknownState: ReadonlySet<RushConfigurationProject>;
|
|
65
|
+
/**
|
|
66
|
+
* The Rush configuration
|
|
67
|
+
*/
|
|
68
|
+
readonly rushConfiguration: RushConfiguration;
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Hooks into the execution process for phased commands
|
|
72
|
+
* @alpha
|
|
73
|
+
*/
|
|
74
|
+
export declare class PhasedCommandHooks {
|
|
75
|
+
/**
|
|
76
|
+
* Hook invoked to create operations for execution.
|
|
77
|
+
* Use the context to distinguish between the initial run and phased runs.
|
|
78
|
+
*/
|
|
79
|
+
readonly createOperations: AsyncSeriesWaterfallHook<[Set<Operation>, ICreateOperationsContext]>;
|
|
80
|
+
/**
|
|
81
|
+
* Hook invoked after executing a set of operations.
|
|
82
|
+
* Use the context to distinguish between the initial run and phased runs.
|
|
83
|
+
* Hook is series for stable output.
|
|
84
|
+
*/
|
|
85
|
+
readonly afterExecuteOperations: AsyncSeriesHook<[IExecutionResult, ICreateOperationsContext]>;
|
|
86
|
+
/**
|
|
87
|
+
* Hook invoked after a run has finished and the command is watching for changes.
|
|
88
|
+
* May be used to display additional relevant data to the user.
|
|
89
|
+
* Only relevant when running in watch mode.
|
|
90
|
+
*/
|
|
91
|
+
readonly waitingForChanges: SyncHook<void>;
|
|
92
|
+
}
|
|
93
|
+
//# sourceMappingURL=PhasedCommandHooks.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("pluginFramework/PhasedCommandHooks");
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { JsonObject } from '@rushstack/node-core-library';
|
|
2
|
+
import { IRushPluginConfiguration } from '../../api/RushPluginsConfiguration';
|
|
3
|
+
import { Autoinstaller } from '../../logic/Autoinstaller';
|
|
4
|
+
import { IPluginLoaderOptions, PluginLoaderBase } from './PluginLoaderBase';
|
|
5
|
+
interface IAutoinstallerPluginLoaderOptions extends IPluginLoaderOptions<IRushPluginConfiguration> {
|
|
6
|
+
restrictConsoleOutput: boolean;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* @beta
|
|
10
|
+
*/
|
|
11
|
+
export declare class AutoinstallerPluginLoader extends PluginLoaderBase<IRushPluginConfiguration> {
|
|
12
|
+
readonly packageFolder: string;
|
|
13
|
+
readonly autoinstaller: Autoinstaller;
|
|
14
|
+
constructor(options: IAutoinstallerPluginLoaderOptions);
|
|
15
|
+
/**
|
|
16
|
+
* The folder where rush plugins static files are stored.
|
|
17
|
+
* Example: `C:\MyRepo\common\autoinstallers\<autoinstaller_name>\rush-plugins`
|
|
18
|
+
*/
|
|
19
|
+
static getPluginAutoinstallerStorePath(autoinstaller: Autoinstaller): string;
|
|
20
|
+
update(): void;
|
|
21
|
+
protected _getCommandLineAdditionalPathFolders(): string[];
|
|
22
|
+
protected _getPluginOptions(): JsonObject;
|
|
23
|
+
protected _getManifestPath(): string;
|
|
24
|
+
protected _getCommandLineJsonFilePath(): string;
|
|
25
|
+
}
|
|
26
|
+
export {};
|
|
27
|
+
//# sourceMappingURL=AutoinstallerPluginLoader.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("pluginFramework/PluginLoader/AutoinstallerPluginLoader");
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { IRushPluginConfigurationBase } from '../../api/RushPluginsConfiguration';
|
|
2
|
+
import { IPluginLoaderOptions, PluginLoaderBase } from './PluginLoaderBase';
|
|
3
|
+
/**
|
|
4
|
+
* @internal
|
|
5
|
+
*/
|
|
6
|
+
export interface IBuiltInPluginConfiguration extends IRushPluginConfigurationBase {
|
|
7
|
+
pluginPackageFolder: string;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* @remarks
|
|
11
|
+
* Used to load plugins that are dependencies of Rush.
|
|
12
|
+
*/
|
|
13
|
+
export declare class BuiltInPluginLoader extends PluginLoaderBase<IBuiltInPluginConfiguration> {
|
|
14
|
+
readonly packageFolder: string;
|
|
15
|
+
constructor(options: IPluginLoaderOptions<IBuiltInPluginConfiguration>);
|
|
16
|
+
}
|
|
17
|
+
//# sourceMappingURL=BuiltInPluginLoader.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("pluginFramework/PluginLoader/BuiltInPluginLoader");
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { ITerminal, JsonObject, JsonSchema } from '@rushstack/node-core-library';
|
|
2
|
+
import { CommandLineConfiguration } from '../../api/CommandLineConfiguration';
|
|
3
|
+
import { RushConfiguration } from '../../api/RushConfiguration';
|
|
4
|
+
import { IRushPluginConfigurationBase } from '../../api/RushPluginsConfiguration';
|
|
5
|
+
import { IRushPlugin } from '../IRushPlugin';
|
|
6
|
+
export interface IRushPluginManifest {
|
|
7
|
+
pluginName: string;
|
|
8
|
+
description: string;
|
|
9
|
+
entryPoint?: string;
|
|
10
|
+
optionsSchema?: string;
|
|
11
|
+
associatedCommands?: string[];
|
|
12
|
+
commandLineJsonFilePath?: string;
|
|
13
|
+
}
|
|
14
|
+
export interface IRushPluginManifestJson {
|
|
15
|
+
plugins: IRushPluginManifest[];
|
|
16
|
+
}
|
|
17
|
+
export interface IPluginLoaderOptions<TPluginConfiguration extends IRushPluginConfigurationBase> {
|
|
18
|
+
pluginConfiguration: TPluginConfiguration;
|
|
19
|
+
rushConfiguration: RushConfiguration;
|
|
20
|
+
terminal: ITerminal;
|
|
21
|
+
}
|
|
22
|
+
export declare abstract class PluginLoaderBase<TPluginConfiguration extends IRushPluginConfigurationBase = IRushPluginConfigurationBase> {
|
|
23
|
+
protected static _jsonSchema: JsonSchema;
|
|
24
|
+
readonly packageName: Readonly<string>;
|
|
25
|
+
readonly pluginName: Readonly<string>;
|
|
26
|
+
protected readonly _rushConfiguration: RushConfiguration;
|
|
27
|
+
protected readonly _terminal: ITerminal;
|
|
28
|
+
protected _manifestCache: Readonly<IRushPluginManifest> | undefined;
|
|
29
|
+
/**
|
|
30
|
+
* The folder that should be used for resolving the plugin's NPM package.
|
|
31
|
+
*/
|
|
32
|
+
abstract readonly packageFolder: string;
|
|
33
|
+
constructor({ pluginConfiguration, rushConfiguration, terminal }: IPluginLoaderOptions<TPluginConfiguration>);
|
|
34
|
+
load(): IRushPlugin | undefined;
|
|
35
|
+
get pluginManifest(): IRushPluginManifest;
|
|
36
|
+
getCommandLineConfiguration(): CommandLineConfiguration | undefined;
|
|
37
|
+
protected _getCommandLineAdditionalPathFolders(): string[];
|
|
38
|
+
protected _getCommandLineJsonFilePath(): string | undefined;
|
|
39
|
+
private _loadAndValidatePluginPackage;
|
|
40
|
+
private _resolvePlugin;
|
|
41
|
+
protected _getPluginOptions(): JsonObject;
|
|
42
|
+
protected _getPluginOptionsJsonFilePath(): string;
|
|
43
|
+
protected _getRushPluginOptionsSchema(): JsonSchema | undefined;
|
|
44
|
+
private _getRushPluginManifest;
|
|
45
|
+
protected _getManifestPath(): string;
|
|
46
|
+
}
|
|
47
|
+
//# sourceMappingURL=PluginLoaderBase.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("pluginFramework/PluginLoader/PluginLoaderBase");
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("pluginFramework/PluginLoader/RushSdk");
|