Skip to content

Commit 0183306

Browse files
Copiloticlanton
andauthored
address code-review feedback: harmonize schema descriptions with TSDoc; fix shold→should typo
Agent-Logs-Url: https://github.com/microsoft/rushstack/sessions/b7297c08-8212-4a0e-b5fa-f4d4ff39a8db Co-authored-by: iclanton <5010588+iclanton@users.noreply.github.com>
1 parent 1003aae commit 0183306

2 files changed

Lines changed: 9 additions & 6 deletions

File tree

libraries/rush-schemas/src/build-cache.zod.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ const amazonS3Configuration: z.ZodObject<{
126126
.describe(
127127
'(Required unless s3Bucket is specified) The Amazon S3 endpoint of the bucket to use for build cache ' +
128128
'(e.g. "my-bucket.s3.us-east-2.amazonaws.com" or "http://localhost:9000").\n' +
129-
'This shold not include any path, use the s3Prefix to set the path.'
129+
'This should not include any path, use the s3Prefix to set the path.'
130130
)
131131
.optional(),
132132
s3Region: z

libraries/rush-schemas/src/experiments.zod.ts

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -175,19 +175,20 @@ export const experimentsSchema = withSchemaMeta(
175175

176176
usePnpmFrozenLockfileForRushInstall: booleanFlag(
177177
"By default, 'rush install' passes --no-prefer-frozen-lockfile to 'pnpm install'. " +
178-
"Set this option to true to pass '--frozen-lockfile' instead."
178+
"Set this option to true to pass '--frozen-lockfile' instead for faster installs."
179179
),
180180
usePnpmPreferFrozenLockfileForRushUpdate: booleanFlag(
181181
"By default, 'rush update' passes --no-prefer-frozen-lockfile to 'pnpm install'. " +
182-
"Set this option to true to pass '--prefer-frozen-lockfile' instead."
182+
"Set this option to true to pass '--prefer-frozen-lockfile' instead to minimize shrinkwrap changes."
183183
),
184184
usePnpmLockfileOnlyThenFrozenLockfileForRushUpdate: booleanFlag(
185185
"By default, 'rush update' runs as a single operation. Set this option to true to instead update the lockfile with `--lockfile-only`, then perform a `--frozen-lockfile` install. " +
186186
'Necessary when using the `afterAllResolved` hook in .pnpmfile.cjs.'
187187
),
188188
omitImportersFromPreventManualShrinkwrapChanges: booleanFlag(
189-
"If using the 'preventManualShrinkwrapChanges' option, only prevent manual changes to the total set of external dependencies referenced by the repository, not which projects reference which dependencies. " +
190-
'This offers a balance between lockfile integrity and merge conflicts.'
189+
"If using the 'preventManualShrinkwrapChanges' option, restricts the hash to only include the layout of " +
190+
'external dependencies. Used to allow links between workspace projects or the addition/removal of ' +
191+
'references to existing dependency versions to not cause hash changes.'
191192
),
192193
noChmodFieldInTarHeaderNormalization: booleanFlag(
193194
'If true, the chmod field in temporary project tar headers will not be normalized. This normalization can help ensure consistent tarball integrity across platforms.'
@@ -220,7 +221,9 @@ export const experimentsSchema = withSchemaMeta(
220221
'If true, when running in watch mode, Rush will check for phase scripts named `_phase:<name>:ipc` and run them instead of `_phase:<name>` if they exist. The created child process will be provided with an IPC channel and expected to persist across invocations.'
221222
),
222223
allowCobuildWithoutCache: booleanFlag(
223-
'When using cobuilds, this experiment allows uncacheable operations to benefit from cobuild orchestration without using the build cache.'
224+
'Allow cobuilds without using the build cache to store previous execution info. When setting up ' +
225+
'distributed builds, Rush will allow uncacheable projects to still leverage the cobuild feature. ' +
226+
"This is useful when you want to speed up operations that can't (or shouldn't) be cached."
224227
),
225228
rushAlerts: booleanFlag(
226229
"(UNDER DEVELOPMENT) The Rush alerts feature provides a way to send announcements to engineers working in the monorepo, by printing directly in the user's shell window when they invoke Rush commands. This ensures that important notices will be seen by anyone doing active development, since people often ignore normal discussion group messages or don't know to subscribe."

0 commit comments

Comments
 (0)