@rushstack/rush-sdk 5.125.0 → 5.126.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/lib/cli/actions/ChangeAction.d.ts +5 -5
- package/lib/cli/actions/PublishAction.d.ts +5 -5
- package/lib/cli/actions/VersionAction.d.ts +1 -1
- package/lib/index.d.ts +33 -33
- package/lib/logic/Git.d.ts +24 -20
- package/lib/logic/PackageJsonUpdaterTypes.d.ts +1 -1
- package/lib/logic/PublishGit.d.ts +10 -10
- package/lib/logic/PublishUtilities.d.ts +1 -1
- package/lib/logic/operations/CacheableOperationPlugin.d.ts +2 -3
- package/lib/logic/operations/ProjectLogWritable.d.ts +23 -15
- package/lib/logic/policy/GitEmailPolicy.d.ts +1 -1
- package/lib/utilities/Npm.d.ts +2 -2
- package/lib/utilities/Utilities.d.ts +11 -29
- package/{dist → lib-shim}/tsdoc-metadata.json +1 -1
- package/package.json +7 -7
|
@@ -18,10 +18,10 @@ export declare class ChangeAction extends BaseRushAction {
|
|
|
18
18
|
runAsync(): Promise<void>;
|
|
19
19
|
private _generateHostMap;
|
|
20
20
|
private _verifyAsync;
|
|
21
|
-
private
|
|
21
|
+
private _getTargetBranchAsync;
|
|
22
22
|
private _getChangedProjectNamesAsync;
|
|
23
|
-
private
|
|
24
|
-
private
|
|
23
|
+
private _validateChangeFileAsync;
|
|
24
|
+
private _getChangeFilesAsync;
|
|
25
25
|
/**
|
|
26
26
|
* The main loop which prompts the user for information on changed projects.
|
|
27
27
|
*/
|
|
@@ -48,7 +48,7 @@ export declare class ChangeAction extends BaseRushAction {
|
|
|
48
48
|
* Asks the user for their email address
|
|
49
49
|
*/
|
|
50
50
|
private _promptForEmailAsync;
|
|
51
|
-
private
|
|
51
|
+
private _warnUnstagedChangesAsync;
|
|
52
52
|
/**
|
|
53
53
|
* Writes change files to the common/changes folder. Will prompt for overwrite if file already exists.
|
|
54
54
|
*/
|
|
@@ -60,6 +60,6 @@ export declare class ChangeAction extends BaseRushAction {
|
|
|
60
60
|
*/
|
|
61
61
|
private _writeFile;
|
|
62
62
|
private _logNoChangeFileRequired;
|
|
63
|
-
private
|
|
63
|
+
private _stageAndCommitGitChangesAsync;
|
|
64
64
|
}
|
|
65
65
|
//# sourceMappingURL=ChangeAction.d.ts.map
|
|
@@ -35,11 +35,11 @@ export declare class PublishAction extends BaseRushAction {
|
|
|
35
35
|
*/
|
|
36
36
|
private _validate;
|
|
37
37
|
private _publishChangesAsync;
|
|
38
|
-
private
|
|
39
|
-
private
|
|
40
|
-
private
|
|
41
|
-
private
|
|
42
|
-
private
|
|
38
|
+
private _publishAllAsync;
|
|
39
|
+
private _gitAddTagsAsync;
|
|
40
|
+
private _npmPublishAsync;
|
|
41
|
+
private _packageExistsAsync;
|
|
42
|
+
private _npmPackAsync;
|
|
43
43
|
private _calculateTarballName;
|
|
44
44
|
private _setDependenciesBeforePublish;
|
|
45
45
|
private _setDependenciesBeforeCommit;
|
|
@@ -17,6 +17,6 @@ export declare class VersionAction extends BaseRushAction {
|
|
|
17
17
|
private _overwritePolicyVersionIfNeeded;
|
|
18
18
|
private _validateInput;
|
|
19
19
|
private _validateResult;
|
|
20
|
-
private
|
|
20
|
+
private _gitProcessAsync;
|
|
21
21
|
}
|
|
22
22
|
//# sourceMappingURL=VersionAction.d.ts.map
|
package/lib/index.d.ts
CHANGED
|
@@ -3,57 +3,57 @@
|
|
|
3
3
|
* @packageDocumentation
|
|
4
4
|
*/
|
|
5
5
|
export { ApprovedPackagesPolicy } from './api/ApprovedPackagesPolicy';
|
|
6
|
-
export { RushConfiguration, ITryFindRushJsonLocationOptions } from './api/RushConfiguration';
|
|
6
|
+
export { RushConfiguration, type ITryFindRushJsonLocationOptions } from './api/RushConfiguration';
|
|
7
7
|
export { Subspace } from './api/Subspace';
|
|
8
8
|
export { SubspacesConfiguration } from './api/SubspacesConfiguration';
|
|
9
|
-
export { IPackageManagerOptionsJsonBase, IConfigurationEnvironment, IConfigurationEnvironmentVariable, PackageManagerOptionsConfigurationBase } from './logic/base/BasePackageManagerOptionsConfiguration';
|
|
10
|
-
export { INpmOptionsJson as _INpmOptionsJson, NpmOptionsConfiguration } from './logic/npm/NpmOptionsConfiguration';
|
|
11
|
-
export { IYarnOptionsJson as _IYarnOptionsJson, YarnOptionsConfiguration } from './logic/yarn/YarnOptionsConfiguration';
|
|
12
|
-
export { IPnpmOptionsJson as _IPnpmOptionsJson, PnpmStoreLocation, IPnpmLockfilePolicies, IPnpmPackageExtension, IPnpmPeerDependencyRules, IPnpmPeerDependenciesMeta, PnpmStoreOptions, PnpmOptionsConfiguration, PnpmResolutionMode } from './logic/pnpm/PnpmOptionsConfiguration';
|
|
9
|
+
export { type IPackageManagerOptionsJsonBase, type IConfigurationEnvironment, type IConfigurationEnvironmentVariable, PackageManagerOptionsConfigurationBase } from './logic/base/BasePackageManagerOptionsConfiguration';
|
|
10
|
+
export { type INpmOptionsJson as _INpmOptionsJson, NpmOptionsConfiguration } from './logic/npm/NpmOptionsConfiguration';
|
|
11
|
+
export { type IYarnOptionsJson as _IYarnOptionsJson, YarnOptionsConfiguration } from './logic/yarn/YarnOptionsConfiguration';
|
|
12
|
+
export { type IPnpmOptionsJson as _IPnpmOptionsJson, type PnpmStoreLocation, type IPnpmLockfilePolicies, type IPnpmPackageExtension, type IPnpmPeerDependencyRules, type IPnpmPeerDependenciesMeta, type PnpmStoreOptions, PnpmOptionsConfiguration, type PnpmResolutionMode } from './logic/pnpm/PnpmOptionsConfiguration';
|
|
13
13
|
export { BuildCacheConfiguration } from './api/BuildCacheConfiguration';
|
|
14
|
-
export { CobuildConfiguration, ICobuildJson } from './api/CobuildConfiguration';
|
|
15
|
-
export { GetCacheEntryIdFunction, IGenerateCacheEntryIdOptions } from './logic/buildCache/CacheEntryId';
|
|
16
|
-
export { FileSystemBuildCacheProvider, IFileSystemBuildCacheProviderOptions } from './logic/buildCache/FileSystemBuildCacheProvider';
|
|
17
|
-
export { IPhase, PhaseBehaviorForMissingScript as IPhaseBehaviorForMissingScript } from './api/CommandLineConfiguration';
|
|
18
|
-
export { EnvironmentConfiguration, EnvironmentVariableNames, IEnvironmentConfigurationInitializeOptions } from './api/EnvironmentConfiguration';
|
|
14
|
+
export { CobuildConfiguration, type ICobuildJson } from './api/CobuildConfiguration';
|
|
15
|
+
export type { GetCacheEntryIdFunction, IGenerateCacheEntryIdOptions } from './logic/buildCache/CacheEntryId';
|
|
16
|
+
export { FileSystemBuildCacheProvider, type IFileSystemBuildCacheProviderOptions } from './logic/buildCache/FileSystemBuildCacheProvider';
|
|
17
|
+
export type { IPhase, PhaseBehaviorForMissingScript as IPhaseBehaviorForMissingScript } from './api/CommandLineConfiguration';
|
|
18
|
+
export { EnvironmentConfiguration, EnvironmentVariableNames, type IEnvironmentConfigurationInitializeOptions } from './api/EnvironmentConfiguration';
|
|
19
19
|
export { RushConstants } from './logic/RushConstants';
|
|
20
|
-
export { PackageManagerName, PackageManager } from './api/packageManager/PackageManager';
|
|
20
|
+
export { type PackageManagerName, PackageManager } from './api/packageManager/PackageManager';
|
|
21
21
|
export { RushConfigurationProject } from './api/RushConfigurationProject';
|
|
22
|
-
export { IRushProjectJson as _IRushProjectJson, IOperationSettings, RushProjectConfiguration, IRushPhaseSharding } from './api/RushProjectConfiguration';
|
|
22
|
+
export { type IRushProjectJson as _IRushProjectJson, type IOperationSettings, RushProjectConfiguration, type IRushPhaseSharding } from './api/RushProjectConfiguration';
|
|
23
23
|
export { RushUserConfiguration } from './api/RushUserConfiguration';
|
|
24
24
|
export { RushGlobalFolder as _RushGlobalFolder } from './api/RushGlobalFolder';
|
|
25
25
|
export { ApprovedPackagesItem, ApprovedPackagesConfiguration } from './api/ApprovedPackagesConfiguration';
|
|
26
26
|
export { CommonVersionsConfiguration } from './api/CommonVersionsConfiguration';
|
|
27
27
|
export { PackageJsonEditor, PackageJsonDependency, DependencyType, PackageJsonDependencyMeta } from './api/PackageJsonEditor';
|
|
28
28
|
export { RepoStateFile } from './logic/RepoStateFile';
|
|
29
|
-
export { LookupByPath, IPrefixMatch } from './logic/LookupByPath';
|
|
29
|
+
export { LookupByPath, type IPrefixMatch } from './logic/LookupByPath';
|
|
30
30
|
export { EventHooks, Event } from './api/EventHooks';
|
|
31
31
|
export { ChangeManager } from './api/ChangeManager';
|
|
32
32
|
export { FlagFile as _FlagFile } from './api/FlagFile';
|
|
33
33
|
export { VersionPolicyDefinitionName, BumpType, LockStepVersionPolicy, IndividualVersionPolicy, VersionPolicy } from './api/VersionPolicy';
|
|
34
34
|
export { VersionPolicyConfiguration } from './api/VersionPolicyConfiguration';
|
|
35
|
-
export { ILaunchOptions, Rush } from './api/Rush';
|
|
35
|
+
export { type ILaunchOptions, Rush } from './api/Rush';
|
|
36
36
|
export { RushInternals as _RushInternals } from './api/RushInternals';
|
|
37
|
-
export { ExperimentsConfiguration, IExperimentsJson } from './api/ExperimentsConfiguration';
|
|
38
|
-
export { CustomTipsConfiguration, CustomTipId, ICustomTipsJson, ICustomTipInfo, ICustomTipItemJson, CustomTipSeverity, CustomTipType } from './api/CustomTipsConfiguration';
|
|
39
|
-
export { ProjectChangeAnalyzer, IGetChangedProjectsOptions, IRawRepoState as _IRawRepoState } from './logic/ProjectChangeAnalyzer';
|
|
40
|
-
export { IOperationRunner, IOperationRunnerContext } from './logic/operations/IOperationRunner';
|
|
41
|
-
export { IExecutionResult, IOperationExecutionResult } from './logic/operations/IOperationExecutionResult';
|
|
42
|
-
export { IOperationOptions, Operation } from './logic/operations/Operation';
|
|
37
|
+
export { ExperimentsConfiguration, type IExperimentsJson } from './api/ExperimentsConfiguration';
|
|
38
|
+
export { CustomTipsConfiguration, CustomTipId, type ICustomTipsJson, type ICustomTipInfo, type ICustomTipItemJson, CustomTipSeverity, CustomTipType } from './api/CustomTipsConfiguration';
|
|
39
|
+
export { ProjectChangeAnalyzer, type IGetChangedProjectsOptions, type IRawRepoState as _IRawRepoState } from './logic/ProjectChangeAnalyzer';
|
|
40
|
+
export type { IOperationRunner, IOperationRunnerContext } from './logic/operations/IOperationRunner';
|
|
41
|
+
export type { IExecutionResult, IOperationExecutionResult } from './logic/operations/IOperationExecutionResult';
|
|
42
|
+
export { type IOperationOptions, Operation } from './logic/operations/Operation';
|
|
43
43
|
export { OperationStatus } from './logic/operations/OperationStatus';
|
|
44
|
-
export { RushSession, IRushSessionOptions, CloudBuildCacheProviderFactory, CobuildLockProviderFactory } from './pluginFramework/RushSession';
|
|
45
|
-
export { IRushCommand, IGlobalCommand, IPhasedCommand, RushLifecycleHooks } from './pluginFramework/RushLifeCycle';
|
|
46
|
-
export { ICreateOperationsContext, IExecuteOperationsContext, PhasedCommandHooks } from './pluginFramework/PhasedCommandHooks';
|
|
47
|
-
export { IRushPlugin } from './pluginFramework/IRushPlugin';
|
|
48
|
-
export { IBuiltInPluginConfiguration as _IBuiltInPluginConfiguration } from './pluginFramework/PluginLoader/BuiltInPluginLoader';
|
|
49
|
-
export { IRushPluginConfigurationBase as _IRushPluginConfigurationBase } from './api/RushPluginsConfiguration';
|
|
50
|
-
export { ILogger } from './pluginFramework/logging/Logger';
|
|
51
|
-
export { ICloudBuildCacheProvider } from './logic/buildCache/ICloudBuildCacheProvider';
|
|
52
|
-
export { ICobuildLockProvider, ICobuildContext, ICobuildCompletedState } from './logic/cobuild/ICobuildLockProvider';
|
|
53
|
-
export { ICredentialCacheOptions, ICredentialCacheEntry, CredentialCache } from './logic/CredentialCache';
|
|
44
|
+
export { RushSession, type IRushSessionOptions, type CloudBuildCacheProviderFactory, type CobuildLockProviderFactory } from './pluginFramework/RushSession';
|
|
45
|
+
export { type IRushCommand, type IGlobalCommand, type IPhasedCommand, RushLifecycleHooks } from './pluginFramework/RushLifeCycle';
|
|
46
|
+
export { type ICreateOperationsContext, type IExecuteOperationsContext, PhasedCommandHooks } from './pluginFramework/PhasedCommandHooks';
|
|
47
|
+
export type { IRushPlugin } from './pluginFramework/IRushPlugin';
|
|
48
|
+
export type { IBuiltInPluginConfiguration as _IBuiltInPluginConfiguration } from './pluginFramework/PluginLoader/BuiltInPluginLoader';
|
|
49
|
+
export type { IRushPluginConfigurationBase as _IRushPluginConfigurationBase } from './api/RushPluginsConfiguration';
|
|
50
|
+
export type { ILogger } from './pluginFramework/logging/Logger';
|
|
51
|
+
export type { ICloudBuildCacheProvider } from './logic/buildCache/ICloudBuildCacheProvider';
|
|
52
|
+
export type { ICobuildLockProvider, ICobuildContext, ICobuildCompletedState } from './logic/cobuild/ICobuildLockProvider';
|
|
53
|
+
export { type ICredentialCacheOptions, type ICredentialCacheEntry, CredentialCache } from './logic/CredentialCache';
|
|
54
54
|
export type { ITelemetryData, ITelemetryMachineInfo, ITelemetryOperationResult } from './logic/Telemetry';
|
|
55
|
-
export { IStopwatchResult } from './utilities/Stopwatch';
|
|
56
|
-
export { OperationStateFile as _OperationStateFile, IOperationStateFileOptions as _IOperationStateFileOptions, IOperationStateJson as _IOperationStateJson } from './logic/operations/OperationStateFile';
|
|
57
|
-
export { OperationMetadataManager as _OperationMetadataManager, IOperationMetadataManagerOptions as _IOperationMetadataManagerOptions, IOperationMetaData as _IOperationMetadata } from './logic/operations/OperationMetadataManager';
|
|
55
|
+
export type { IStopwatchResult } from './utilities/Stopwatch';
|
|
56
|
+
export { OperationStateFile as _OperationStateFile, type IOperationStateFileOptions as _IOperationStateFileOptions, type IOperationStateJson as _IOperationStateJson } from './logic/operations/OperationStateFile';
|
|
57
|
+
export { OperationMetadataManager as _OperationMetadataManager, type IOperationMetadataManagerOptions as _IOperationMetadataManagerOptions, type IOperationMetaData as _IOperationMetadata } from './logic/operations/OperationMetadataManager';
|
|
58
58
|
export { RushCommandLine, type IRushCommandLineSpec, type IRushCommandLineParameter, type IRushCommandLineAction } from './api/RushCommandLine';
|
|
59
59
|
//# sourceMappingURL=index.d.ts.map
|
package/lib/logic/Git.d.ts
CHANGED
|
@@ -31,31 +31,31 @@ export declare class Git {
|
|
|
31
31
|
* the result of `this.getGitInfo()` is used.
|
|
32
32
|
*/
|
|
33
33
|
isPathUnderGitWorkingTree(repoInfo?: gitInfo.GitRepoInfo): boolean;
|
|
34
|
-
/**
|
|
35
|
-
* If a Git email address is configured and is nonempty, this returns it.
|
|
36
|
-
* Otherwise, undefined is returned.
|
|
37
|
-
*/
|
|
38
|
-
tryGetGitEmail(): string | undefined;
|
|
39
34
|
/**
|
|
40
35
|
* If a Git email address is configured and is nonempty, this returns it.
|
|
41
36
|
* Otherwise, configuration instructions are printed to the console,
|
|
42
37
|
* and AlreadyReportedError is thrown.
|
|
43
38
|
*/
|
|
44
|
-
|
|
39
|
+
getGitEmailAsync(): Promise<string>;
|
|
40
|
+
/**
|
|
41
|
+
* If the Git email address is configured and non-empty, this returns it. Otherwise
|
|
42
|
+
* it prints an error message and throws.
|
|
43
|
+
*/
|
|
44
|
+
validateGitEmail(userEmail: string | undefined): string;
|
|
45
45
|
/**
|
|
46
46
|
* Get the folder where Git hooks should go for the current working tree.
|
|
47
47
|
* Returns undefined if the current path is not under a Git working tree.
|
|
48
48
|
*/
|
|
49
49
|
getHooksFolder(): string | undefined;
|
|
50
|
-
|
|
51
|
-
|
|
50
|
+
getIsHooksPathDefaultAsync(): Promise<boolean>;
|
|
51
|
+
getConfigHooksPathAsync(): Promise<string>;
|
|
52
52
|
/**
|
|
53
53
|
* Get information about the current Git working tree.
|
|
54
54
|
* Returns undefined if rush.json is not under a Git working tree.
|
|
55
55
|
*/
|
|
56
56
|
getGitInfo(): Readonly<gitInfo.GitRepoInfo> | undefined;
|
|
57
|
-
|
|
58
|
-
|
|
57
|
+
getMergeBaseAsync(targetBranch: string, terminal: ITerminal, shouldFetch?: boolean): Promise<string>;
|
|
58
|
+
getBlobContentAsync({ blobSpec, repositoryRoot }: IGetBlobOptions): Promise<string>;
|
|
59
59
|
/**
|
|
60
60
|
* @param pathPrefix - An optional path prefix "git diff"s should be filtered by.
|
|
61
61
|
* @returns
|
|
@@ -63,7 +63,7 @@ export declare class Git {
|
|
|
63
63
|
* those in the provided {@param targetBranch}. If a {@param pathPrefix} is provided,
|
|
64
64
|
* this function only returns results under the that path.
|
|
65
65
|
*/
|
|
66
|
-
|
|
66
|
+
getChangedFilesAsync(targetBranch: string, terminal: ITerminal, skipFetch?: boolean, pathPrefix?: string): Promise<string[]>;
|
|
67
67
|
/**
|
|
68
68
|
* Gets the remote default branch that maps to the provided repository url.
|
|
69
69
|
* This method is used by 'Rush change' to find the default remote branch to compare against.
|
|
@@ -73,15 +73,15 @@ export declare class Git {
|
|
|
73
73
|
*
|
|
74
74
|
* @param rushConfiguration - rush configuration
|
|
75
75
|
*/
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
76
|
+
getRemoteDefaultBranchAsync(): Promise<string>;
|
|
77
|
+
hasUncommittedChangesAsync(): Promise<boolean>;
|
|
78
|
+
hasUnstagedChangesAsync(): Promise<boolean>;
|
|
79
79
|
/**
|
|
80
80
|
* The list of files changed but not committed
|
|
81
81
|
*/
|
|
82
|
-
|
|
82
|
+
getUncommittedChangesAsync(): Promise<ReadonlyArray<string>>;
|
|
83
83
|
getTagSeparator(): string;
|
|
84
|
-
|
|
84
|
+
getGitStatusAsync(): Promise<Iterable<IGitStatusEntry>>;
|
|
85
85
|
/**
|
|
86
86
|
* Git remotes can use different URL syntaxes; this converts them all to a normalized HTTPS
|
|
87
87
|
* representation for matching purposes. IF THE INPUT IS NOT ALREADY HTTPS, THE OUTPUT IS
|
|
@@ -91,18 +91,22 @@ export declare class Git {
|
|
|
91
91
|
* `git@github.com:ExampleOrg/ExampleProject.git` --> `https://github.com/ExampleOrg/ExampleProject`
|
|
92
92
|
*/
|
|
93
93
|
static normalizeGitUrlForComparison(gitUrl: string): string;
|
|
94
|
-
|
|
95
|
-
|
|
94
|
+
/**
|
|
95
|
+
* Returns an object containing either the result of the `git config user.email`
|
|
96
|
+
* command or an error.
|
|
97
|
+
*/
|
|
98
|
+
tryGetGitEmailAsync(): Promise<string | undefined>;
|
|
99
|
+
private _tryGetGitHooksPathAsync;
|
|
96
100
|
private _tryFetchRemoteBranch;
|
|
97
101
|
private _fetchRemoteBranch;
|
|
98
102
|
/**
|
|
99
103
|
* @internal
|
|
100
104
|
*/
|
|
101
|
-
|
|
105
|
+
_executeGitCommandAndCaptureOutputAsync(gitPath: string, args: string[], repositoryRoot?: string): Promise<string>;
|
|
102
106
|
/**
|
|
103
107
|
*
|
|
104
108
|
* @param ref Given a ref which can be branch name, commit hash, tag name, etc, check if it is a commit hash
|
|
105
109
|
*/
|
|
106
|
-
|
|
110
|
+
determineIfRefIsACommitAsync(ref: string): Promise<boolean>;
|
|
107
111
|
}
|
|
108
112
|
//# sourceMappingURL=Git.d.ts.map
|
|
@@ -2,7 +2,7 @@ import type { RushConfigurationProject } from '../api/RushConfigurationProject';
|
|
|
2
2
|
/**
|
|
3
3
|
* The type of SemVer range specifier that is prepended to the version
|
|
4
4
|
*/
|
|
5
|
-
export declare
|
|
5
|
+
export declare enum SemVerStyle {
|
|
6
6
|
Exact = "exact",
|
|
7
7
|
Caret = "caret",
|
|
8
8
|
Tilde = "tilde",
|
|
@@ -5,15 +5,15 @@ export declare class PublishGit {
|
|
|
5
5
|
private readonly _gitPath;
|
|
6
6
|
private readonly _gitTagSeparator;
|
|
7
7
|
constructor(git: Git, targetBranch: string | undefined);
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
8
|
+
checkoutAsync(branchName: string | undefined, createBranch?: boolean): Promise<void>;
|
|
9
|
+
mergeAsync(branchName: string, verify?: boolean): Promise<void>;
|
|
10
|
+
deleteBranchAsync(branchName: string | undefined, hasRemote?: boolean, verify?: boolean): Promise<void>;
|
|
11
|
+
pullAsync(verify?: boolean): Promise<void>;
|
|
12
|
+
fetchAsync(): Promise<void>;
|
|
13
|
+
addChangesAsync(pathspec?: string, workingDirectory?: string): Promise<void>;
|
|
14
|
+
addTagAsync(shouldExecute: boolean, packageName: string, packageVersion: string, commitId: string | undefined, preReleaseName?: string): Promise<void>;
|
|
15
|
+
hasTagAsync(packageConfig: RushConfigurationProject): Promise<boolean>;
|
|
16
|
+
commitAsync(commitMessage: string, verify?: boolean): Promise<void>;
|
|
17
|
+
pushAsync(branchName: string | undefined, verify?: boolean): Promise<void>;
|
|
18
18
|
}
|
|
19
19
|
//# sourceMappingURL=PublishGit.d.ts.map
|
|
@@ -38,7 +38,7 @@ export declare class PublishUtilities {
|
|
|
38
38
|
* @param secretSubstring -- if specified, a substring to be replaced by `<<SECRET>>` to avoid printing secrets
|
|
39
39
|
* on the console
|
|
40
40
|
*/
|
|
41
|
-
static
|
|
41
|
+
static execCommandAsync(shouldExecute: boolean, command: string, args?: string[], workingDirectory?: string, environment?: IEnvironment, secretSubstring?: string): Promise<void>;
|
|
42
42
|
static getNewDependencyVersion(dependencies: {
|
|
43
43
|
[key: string]: string;
|
|
44
44
|
}, dependencyName: string, newProjectVersion: string): string;
|
|
@@ -47,9 +47,8 @@ export declare class CacheableOperationPlugin implements IPhasedCommandPlugin {
|
|
|
47
47
|
private _tryGetProjectBuildCacheAsync;
|
|
48
48
|
private _tryGetLogOnlyProjectBuildCacheAsync;
|
|
49
49
|
private _tryGetCobuildLockAsync;
|
|
50
|
-
private
|
|
51
|
-
private
|
|
52
|
-
private _tryGetBuildCacheProjectLogWritable;
|
|
50
|
+
private _createBuildCacheTerminalAsync;
|
|
51
|
+
private _tryGetBuildCacheProjectLogWritableAsync;
|
|
53
52
|
}
|
|
54
53
|
export declare function clusterOperations(initialClusters: DisjointSet<Operation>, operationBuildCacheMap: Map<Operation, {
|
|
55
54
|
cacheDisabledReason: string | undefined;
|
|
@@ -1,6 +1,26 @@
|
|
|
1
1
|
import { TerminalWritable, type ITerminalChunk } from '@rushstack/terminal';
|
|
2
2
|
import type { CollatedTerminal } from '@rushstack/stream-collator';
|
|
3
3
|
import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
|
|
4
|
+
export interface IProjectLogWritableOptions {
|
|
5
|
+
project: RushConfigurationProject;
|
|
6
|
+
terminal: CollatedTerminal;
|
|
7
|
+
logFilenameIdentifier: string;
|
|
8
|
+
enableChunkedOutput?: boolean;
|
|
9
|
+
}
|
|
10
|
+
export interface ILogFilePaths {
|
|
11
|
+
logFolderPath: string;
|
|
12
|
+
logChunksFolderPath: string;
|
|
13
|
+
logPath: string;
|
|
14
|
+
logChunksPath: string;
|
|
15
|
+
errorLogPath: string;
|
|
16
|
+
relativeLogPath: string;
|
|
17
|
+
relativeErrorLogPath: string;
|
|
18
|
+
relativeLogChunksPath: string;
|
|
19
|
+
}
|
|
20
|
+
export interface IGetLogFilePathsOptions {
|
|
21
|
+
project: RushConfigurationProject;
|
|
22
|
+
logFilenameIdentifier: string;
|
|
23
|
+
}
|
|
4
24
|
export declare class ProjectLogWritable extends TerminalWritable {
|
|
5
25
|
private readonly _terminal;
|
|
6
26
|
readonly logPath: string;
|
|
@@ -38,21 +58,9 @@ export declare class ProjectLogWritable extends TerminalWritable {
|
|
|
38
58
|
*/
|
|
39
59
|
private _chunkWriter;
|
|
40
60
|
private _enableChunkedOutput;
|
|
41
|
-
constructor(
|
|
42
|
-
|
|
43
|
-
});
|
|
44
|
-
static getLogFilePaths({ project, logFilenameIdentifier, isLegacyLog }: {
|
|
45
|
-
project: RushConfigurationProject;
|
|
46
|
-
logFilenameIdentifier: string;
|
|
47
|
-
isLegacyLog?: boolean;
|
|
48
|
-
}): {
|
|
49
|
-
logPath: string;
|
|
50
|
-
logChunksPath: string;
|
|
51
|
-
errorLogPath: string;
|
|
52
|
-
relativeLogPath: string;
|
|
53
|
-
relativeErrorLogPath: string;
|
|
54
|
-
relativeLogChunksPath: string;
|
|
55
|
-
};
|
|
61
|
+
private constructor();
|
|
62
|
+
static initializeAsync({ project, terminal, logFilenameIdentifier, enableChunkedOutput }: IProjectLogWritableOptions): Promise<ProjectLogWritable>;
|
|
63
|
+
static getLogFilePaths({ project: { projectFolder, packageName }, logFilenameIdentifier }: IGetLogFilePathsOptions): ILogFilePaths;
|
|
56
64
|
writeChunk(chunk: ITerminalChunk): void;
|
|
57
65
|
protected onWriteChunk(chunk: ITerminalChunk): void;
|
|
58
66
|
protected onClose(): void;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { RushConfiguration } from '../../api/RushConfiguration';
|
|
2
2
|
import type { IPolicyValidatorOptions } from './PolicyValidator';
|
|
3
|
-
export declare function
|
|
3
|
+
export declare function validateAsync(rushConfiguration: RushConfiguration, options: IPolicyValidatorOptions): Promise<void>;
|
|
4
4
|
export declare function getEmailExampleLines(rushConfiguration: RushConfiguration): string[];
|
|
5
5
|
//# sourceMappingURL=GitEmailPolicy.d.ts.map
|
package/lib/utilities/Npm.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export declare class Npm {
|
|
2
|
-
static
|
|
2
|
+
static getPublishedVersionsAsync(packageName: string, cwd: string, env: {
|
|
3
3
|
[key: string]: string | undefined;
|
|
4
|
-
}, extraArgs?: string[]): string[]
|
|
4
|
+
}, extraArgs?: string[]): Promise<string[]>;
|
|
5
5
|
}
|
|
6
6
|
//# sourceMappingURL=Npm.d.ts.map
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
|
-
/// <reference types="node" />
|
|
3
2
|
import * as child_process from 'child_process';
|
|
4
3
|
import type { RushConfiguration } from '../api/RushConfiguration';
|
|
5
4
|
import { syncNpmrc } from './npmrcUtilities';
|
|
@@ -9,7 +8,7 @@ export interface IEnvironment {
|
|
|
9
8
|
[environmentVariableName: string]: string | undefined;
|
|
10
9
|
}
|
|
11
10
|
/**
|
|
12
|
-
* Options for Utilities.
|
|
11
|
+
* Options for {@link Utilities.executeCommandAsync}.
|
|
13
12
|
*/
|
|
14
13
|
export interface IExecuteCommandOptions {
|
|
15
14
|
command: string;
|
|
@@ -18,9 +17,13 @@ export interface IExecuteCommandOptions {
|
|
|
18
17
|
environment?: IEnvironment;
|
|
19
18
|
suppressOutput?: boolean;
|
|
20
19
|
keepEnvironment?: boolean;
|
|
20
|
+
/**
|
|
21
|
+
* Note that this takes precedence over {@link IExecuteCommandOptions.suppressOutput}
|
|
22
|
+
*/
|
|
23
|
+
onStdoutStreamChunk?: (chunk: string) => string | void;
|
|
21
24
|
}
|
|
22
25
|
/**
|
|
23
|
-
* Options for Utilities.
|
|
26
|
+
* Options for {@link Utilities.installPackageInDirectoryAsync}.
|
|
24
27
|
*/
|
|
25
28
|
export interface IInstallPackageInDirectoryOptions {
|
|
26
29
|
directory: string;
|
|
@@ -120,30 +123,16 @@ export declare class Utilities {
|
|
|
120
123
|
* Executes the command with the specified command-line parameters, and waits for it to complete.
|
|
121
124
|
* The current directory will be set to the specified workingDirectory.
|
|
122
125
|
*/
|
|
123
|
-
static
|
|
126
|
+
static executeCommandAsync({ command, args, workingDirectory, suppressOutput, onStdoutStreamChunk, environment, keepEnvironment }: IExecuteCommandOptions): Promise<void>;
|
|
124
127
|
/**
|
|
125
128
|
* Executes the command with the specified command-line parameters, and waits for it to complete.
|
|
126
129
|
* The current directory will be set to the specified workingDirectory.
|
|
127
|
-
*
|
|
128
|
-
* It's basically the same as executeCommand() except that it returns a Promise.
|
|
129
130
|
*/
|
|
130
|
-
static
|
|
131
|
-
/**
|
|
132
|
-
* Executes the command with the specified command-line parameters, and waits for it to complete.
|
|
133
|
-
* The current directory will be set to the specified workingDirectory.
|
|
134
|
-
*/
|
|
135
|
-
static executeCommandAndCaptureOutput(command: string, args: string[], workingDirectory: string, environment?: IEnvironment, keepEnvironment?: boolean): string;
|
|
131
|
+
static executeCommandAndCaptureOutputAsync(command: string, args: string[], workingDirectory: string, environment?: IEnvironment, keepEnvironment?: boolean): Promise<string>;
|
|
136
132
|
/**
|
|
137
133
|
* Attempts to run Utilities.executeCommand() up to maxAttempts times before giving up.
|
|
138
134
|
*/
|
|
139
|
-
static
|
|
140
|
-
/**
|
|
141
|
-
* Attempts to run Utilities.executeCommand() up to maxAttempts times before giving up.
|
|
142
|
-
* Using `onStdoutStreamChunk` to process the output of the command.
|
|
143
|
-
*
|
|
144
|
-
* Note: This is similar to {@link executeCommandWithRetry} except that it returns a Promise and provides a callback to process the output.
|
|
145
|
-
*/
|
|
146
|
-
static executeCommandAndProcessOutputWithRetryAsync(options: IExecuteCommandOptions, maxAttempts: number, onStdoutStreamChunk?: (chunk: string) => string | void, retryCallback?: () => void): Promise<void>;
|
|
135
|
+
static executeCommandWithRetryAsync(options: IExecuteCommandOptions, maxAttempts: number, retryCallback?: () => void): Promise<void>;
|
|
147
136
|
/**
|
|
148
137
|
* Executes the command using cmd if running on windows, or using sh if running on a non-windows OS.
|
|
149
138
|
* @param command - the command to run on shell
|
|
@@ -166,7 +155,7 @@ export declare class Utilities {
|
|
|
166
155
|
/**
|
|
167
156
|
* Installs a package by name and version in the specified directory.
|
|
168
157
|
*/
|
|
169
|
-
static
|
|
158
|
+
static installPackageInDirectoryAsync({ packageName, version, tempPackageTitle, commonRushConfigFolder, maxInstallAttempts, suppressOutput, directory }: IInstallPackageInDirectoryOptions): Promise<void>;
|
|
170
159
|
/**
|
|
171
160
|
* Copies the file "sourcePath" to "destinationPath", overwriting the target file location.
|
|
172
161
|
* If the source file does not exist, then the target file is deleted.
|
|
@@ -196,18 +185,11 @@ export declare class Utilities {
|
|
|
196
185
|
* "/foobar/node_modules/.bin:/bin"
|
|
197
186
|
*/
|
|
198
187
|
private static _prependNodeModulesBinToPath;
|
|
199
|
-
/**
|
|
200
|
-
* Executes the command with the specified command-line parameters, and waits for it to complete.
|
|
201
|
-
* The current directory will be set to the specified workingDirectory.
|
|
202
|
-
*
|
|
203
|
-
* It's the same as _executeCommandInternal except that it returns a promise.
|
|
204
|
-
*/
|
|
205
|
-
private static _executeCommandAndInspectOutputInternalAsync;
|
|
206
188
|
/**
|
|
207
189
|
* Executes the command with the specified command-line parameters, and waits for it to complete.
|
|
208
190
|
* The current directory will be set to the specified workingDirectory.
|
|
209
191
|
*/
|
|
210
|
-
private static
|
|
192
|
+
private static _executeCommandInternalAsync;
|
|
211
193
|
private static _processResult;
|
|
212
194
|
}
|
|
213
195
|
//# sourceMappingURL=Utilities.d.ts.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rushstack/rush-sdk",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.126.0",
|
|
4
4
|
"description": "An API for interacting with the Rush engine",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -25,17 +25,17 @@
|
|
|
25
25
|
"dependencies": {
|
|
26
26
|
"@types/node-fetch": "2.6.2",
|
|
27
27
|
"tapable": "2.2.1",
|
|
28
|
-
"@rushstack/node-core-library": "5.1
|
|
29
|
-
"@rushstack/terminal": "0.
|
|
28
|
+
"@rushstack/node-core-library": "5.4.1",
|
|
29
|
+
"@rushstack/terminal": "0.13.0"
|
|
30
30
|
},
|
|
31
31
|
"devDependencies": {
|
|
32
32
|
"@types/semver": "7.5.0",
|
|
33
33
|
"@types/webpack-env": "1.18.0",
|
|
34
|
-
"@rushstack/
|
|
34
|
+
"@rushstack/ts-command-line": "4.22.0",
|
|
35
|
+
"@rushstack/heft": "0.66.17",
|
|
36
|
+
"@microsoft/rush-lib": "5.126.0",
|
|
35
37
|
"local-node-rig": "1.0.0",
|
|
36
|
-
"@
|
|
37
|
-
"@rushstack/stream-collator": "4.1.50",
|
|
38
|
-
"@rushstack/ts-command-line": "4.21.2"
|
|
38
|
+
"@rushstack/stream-collator": "4.1.55"
|
|
39
39
|
},
|
|
40
40
|
"scripts": {
|
|
41
41
|
"build": "heft build --clean",
|