Skip to content

Commit ddb4685

Browse files
fix: messages for "org list metadata-types"
1 parent 75be874 commit ddb4685

File tree

3 files changed

+23
-32
lines changed

3 files changed

+23
-32
lines changed

messages/list.metadata.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Use this command to identify individual components in your manifest file or if you want a high-level view of particular metadata types in your org. For example, you can use this command to return a list of names of all the CustomObject or Layout components in your org, then use this information in a retrieve command that returns a subset of these components.
44

5+
The username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.
6+
57
# summary
68

79
List the metadata components and properties of a specified type.
@@ -22,7 +24,7 @@ List the metadata components and properties of a specified type.
2224

2325
# flags.api-version.summary
2426

25-
API version to use; default is the latest API version.
27+
API version to use; default is the most recent API version.
2628

2729
# flags.output-file.summary
2830

messages/metadata-types.md

Lines changed: 16 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,37 @@
11
# description
22

3-
Use this information to identify the syntax needed for a <name> element in package.xml. The most recent API version is
4-
the default, or you can specify an older version.
3+
The information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other metadata types. Use this information to identify the syntax needed for a <name> element in a manifest file (package.xml).
54

6-
The default target username is the admin user for the default scratch org. The username must have the Modify All Data
7-
permission or the Modify Metadata permission (Beta). For more information about permissions, see Salesforce Help.
5+
The username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.
86

97
# summary
108

11-
display details about the metadata types enabled for your org
9+
Display details about the metadata types that are enabled for your org.
1210

1311
# examples
1412

15-
- $ <%= config.bin %> <%= command.id %> -a 43.0
13+
- Display information about all known and enabled metadata types in the org with alias "my-dev-org" using API version 57.0:
1614

17-
- $ <%= config.bin %> <%= command.id %> -o [email protected]
15+
$ <%= config.bin %> <%= command.id %> --api-version 57.0 --target-org my-dev-org
1816

19-
- $ <%= config.bin %> <%= command.id %> -f /path/to/outputfilename.txt
17+
- Display only the metadata types that aren't yet supported by Salesforce CLI in your default org and write the results to the specified file:
2018

21-
- $ <%= config.bin %> <%= command.id %> -o [email protected] -f /path/to/outputfilename.txt
19+
$ <%= config.bin %> <%= command.id %> --output-file /path/to/outputfilename.txt --filter-known
2220

23-
# flags.api-version
21+
# flags.api-version.summary
2422

25-
API version to use
23+
API version to use; default is the most recent API version.
2624

27-
# flags.output-file
25+
# flags.output-file.summary
2826

29-
path to the file where results are stored
27+
Pathname of the file in which to write the results.
3028

31-
# flags.filterknown
29+
# flags.filter-known.summary
3230

33-
filter metadata known by the CLI
34-
35-
# flagsLong.apiversion
36-
37-
The API version to use. The default is the latest API version
31+
Filter the known metadata types from the result to display only the types not yet fully supported by Salesforce CLI.
3832

39-
# flagsLong.output-file
40-
41-
The path to the file where the results of the command are stored. Directing the output to a file makes it easier to
42-
extract relevant information for your package.xml manifest file. The default output destination is the console.
33+
filter metadata known by the CLI
4334

44-
# flagsLong.filterknown
35+
# flags.output-file.description
4536

46-
Filters all the known metadata from the result such that all that is left are the types not yet fully supported by the
47-
CLI.
37+
Directing the output to a file makes it easier to extract relevant information for your package.xml manifest file. The default output destination is the terminal or command window console.

src/commands/org/list/metadata-types.ts

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,22 @@ export class ListMetadataTypes extends SfCommand<DescribeMetadataResult> {
2323
'api-version': Flags.orgApiVersion({
2424
aliases: ['apiversion', 'a'],
2525
deprecateAliases: true,
26-
summary: messages.getMessage('flags.api-version'),
26+
summary: messages.getMessage('flags.api-version.summary'),
2727
}),
2828
loglevel,
2929
'target-org': requiredOrgFlagWithDeprecations,
3030
'output-file': Flags.file({
3131
aliases: ['resultfile'],
3232
deprecateAliases: true,
3333
char: 'f',
34-
summary: messages.getMessage('flags.output-file'),
35-
description: messages.getMessage('flagsLong.output-file'),
34+
summary: messages.getMessage('flags.output-file.summary'),
35+
description: messages.getMessage('flags.output-file.description'),
3636
}),
3737
'filter-known': Flags.boolean({
3838
aliases: ['filterknown'],
3939
deprecateAliases: true,
4040
char: 'k',
41-
summary: messages.getMessage('flags.filterknown'),
42-
description: messages.getMessage('flagsLong.filterknown'),
41+
summary: messages.getMessage('flags.filter-known.summary'),
4342
hidden: true,
4443
}),
4544
};

0 commit comments

Comments
 (0)