Skip to content

Commit c51330c

Browse files
committed
fix: flag name and help text edits
1 parent 9218257 commit c51330c

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

command-snapshot.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@
239239
"flagChars": ["c", "d", "m", "n", "p", "t"],
240240
"flags": [
241241
"api-version",
242-
"exclude-metadata",
242+
"excluded-metadata",
243243
"flags-dir",
244244
"from-org",
245245
"include-packages",

messages/manifest.generate.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Use --name to specify a custom name for the generated manifest if the pre-define
1919

2020
To include multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --include-packages and --source-dir.
2121

22-
To build a manifest from the metadata in an org use the --from-org flag optionally combining it with the --metadata flag to only include certain metadata types, or the --exclude-metadata flag to exclude certain metadata types. When building a manifest from an org, the command makes many API calls concurrently to discover the metadata that exists in the org. To limit the number of concurrent requests use the `SF_LIST_METADATA_BATCH_SIZE` environment variable and set it to a size that works best for your org and environment. If you are experiencing timeouts and/or inconsistent manifest contents then setting this environment variable should improve accuracy. However, the command will take longer to run since it sends fewer requests at a time.
22+
To build a manifest from the metadata in an org, use the --from-org flag. You can combine --from-org with the --metadata flag to include only certain metadata types, or with the --excluded-metadata flag to exclude certain metadata types. When building a manifest from an org, the command makes many concurrent API calls to discover the metadata that exists in the org. To limit the number of concurrent requests, use the SF_LIST_METADATA_BATCH_SIZE environment variable and set it to a size that works best for your org and environment. If you experience timeouts or inconsistent manifest contents, then setting this environment variable can improve accuracy. However, the command takes longer to run because it sends fewer requests at a time.
2323

2424
# examples
2525

@@ -45,15 +45,15 @@ To build a manifest from the metadata in an org use the --from-org flag optional
4545

4646
- Create a manifest from all metadata components in an org excluding specific metadata types:
4747

48-
$ <%= config.bin %> <%= command.id %> --from-org [email protected] --exclude-metadata StandardValueSet
48+
$ <%= config.bin %> <%= command.id %> --from-org [email protected] --excluded-metadata StandardValueSet
4949

5050
# flags.include-packages.summary
5151

5252
Package types (managed, unlocked) whose metadata is included in the manifest; by default, metadata in managed and unlocked packages is excluded. Metadata in unmanaged packages is always included.
5353

54-
# flags.exclude-metadata.summary
54+
# flags.excluded-metadata.summary
5555

56-
Metadata types (types only; not names) to exclude when building a manifest from an org.
56+
Metadata types to exclude when building a manifest from an org. Specify the name of the type, not the name of a specific component.
5757

5858
# flags.from-org.summary
5959

src/commands/project/generate/manifest.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -85,10 +85,10 @@ export class ManifestGenerate extends SfCommand<ManifestGenerateCommandResult> {
8585
char: 'c',
8686
dependsOn: ['from-org'],
8787
}),
88-
'exclude-metadata': Flags.string({
88+
'excluded-metadata': Flags.string({
8989
multiple: true,
9090
delimiter: ',',
91-
summary: messages.getMessage('flags.exclude-metadata.summary'),
91+
summary: messages.getMessage('flags.excluded-metadata.summary'),
9292
dependsOn: ['from-org'],
9393
exclusive: ['metadata'],
9494
}),
@@ -128,11 +128,11 @@ export class ManifestGenerate extends SfCommand<ManifestGenerateCommandResult> {
128128
apiversion: flags['api-version'] ?? (await getSourceApiVersion()),
129129
sourcepath: flags['source-dir'],
130130
metadata:
131-
flags.metadata ?? flags['exclude-metadata']
131+
flags.metadata ?? flags['excluded-metadata']
132132
? {
133133
metadataEntries: flags.metadata ?? [],
134134
directoryPaths: await getPackageDirs(),
135-
excludedEntries: flags['exclude-metadata'],
135+
excludedEntries: flags['excluded-metadata'],
136136
}
137137
: undefined,
138138
org: flags['from-org']

0 commit comments

Comments
 (0)