Skip to content

Commit f06919f

Browse files
fix: edit messages
1 parent 697293d commit f06919f

File tree

6 files changed

+38
-18
lines changed

6 files changed

+38
-18
lines changed

messages/convert.mdapi.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ To use Salesforce CLI to work with components that you retrieved via Metadata AP
88

99
To convert files from the source format back to the metadata format, run "<%= config.bin %> project convert source".
1010

11+
To convert 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 --manifest and --source-dir.
12+
1113
# examples
1214

1315
- Convert metadata formatted files in the specified directory into source formatted files; writes converted files to your default package directory:
@@ -32,11 +34,11 @@ File path to manifest (package.xml) of metadata types to convert.
3234

3335
# flags.metadata-dir.summary
3436

35-
Comma-separated list of paths to the local metadata files to convert.
37+
Root of directory or zip file of metadata formatted files to convert.
3638

3739
# flags.metadata.summary
3840

39-
Comma-separated list of metadata component names to convert.
41+
Metadata component names to convert.
4042

4143
# flags.manifest.description
4244

messages/convert.source.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ To convert Metadata API–formatted files into the source format, run "<%= confi
1010

1111
To specify a package name that includes spaces, enclose the name in single quotes.
1212

13+
To convert multiple 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 --manifest and --source-dir.
14+
1315
# examples
1416

1517
- Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:
@@ -38,11 +40,11 @@ Path to the manifest (package.xml) file that specifies the metadata types to con
3840

3941
# flags.source-dir.summary
4042

41-
Comma-separated list of paths to the local source files to convert.
43+
Paths to the local source files to convert.
4244

4345
# flags.metadata.summary
4446

45-
Comma-separated list of metadata component names to convert.
47+
Metadata component names to convert.
4648

4749
# flags.manifest.description
4850

messages/delete.source.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Use this command to delete components from orgs that don’t have source trackin
88

99
When you run this command, both the local source file and the metadata component in the org are deleted.
1010

11+
To delete 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 --manifest and --source-dir.
12+
1113
# examples
1214

1315
- Delete all local Apex source files and all Apex classes from the org with alias "my-scratch":
@@ -32,11 +34,11 @@ When you run this command, both the local source file and the metadata component
3234

3335
# flags.source-dir.summary
3436

35-
Comma-separated list of source file paths to delete.
37+
Source file paths to delete.
3638

3739
# flags.metadata.summary
3840

39-
Comma-separated list of names of metadata components to delete.
41+
Metadata components to delete.
4042

4143
# flags.no-prompt.summary
4244

messages/list.ignored.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,28 @@
1+
# summary
2+
3+
Check your local project package directories for forceignored files.
4+
15
# description
26

3-
check your local project package directories for forceignored files
7+
When deploying or retrieving metadata between your local project and an org, you can specify the source files you want to exclude with a .forceignore file. The .forceignore file structure mimics the .gitignore structure. Each line in .forceignore specifies a pattern that corresponds to one or more files. The files typically represent metadata components, but can be any files you want to exclude, such as LWC configuration JSON files or tests.
48

59
# examples
610

7-
- $ <%= config.bin %> <%= command.id %>
11+
- List all the files in all package directories that are ignored:
12+
13+
<%= config.bin %> <%= command.id %>
14+
15+
- List all the files in a specific directory that are ignored:
16+
17+
<%= config.bin %> <%= command.id %> --source-dir force-app
18+
19+
- Check if a particular file is ignored:
820

9-
- $ <%= config.bin %> <%= command.id %> --source-dir force-app
21+
<%= config.bin %> <%= command.id %> --source-dir package.xml
1022

11-
# flags.source-dir
23+
# flags.source-dir.summary
1224

13-
file or directory of files that the command checks for foreceignored files
25+
File or directory of files that the command checks for foreceignored files.
1426

1527
# invalidSourceDir
1628

messages/manifest.create.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,13 @@ See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/met
1717

1818
Use --manifest-name to specify a custom name for the generated manifest if the pre-defined ones don’t suit your needs. You can specify either --manifest-type or --manifest-name, but not both.
1919

20+
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.
21+
2022
# examples
2123

22-
- Create a manifest for deploying or retrieving all Apex classes:
24+
- Create a manifest for deploying or retrieving all Apex classes and custom objects:
2325

24-
$ <%= config.bin %> <%= command.id %> --metadata ApexClass
26+
$ <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata CustomObject
2527

2628
- Create a manifest for deleting the specified Apex class:
2729

@@ -37,7 +39,7 @@ Use --manifest-name to specify a custom name for the generated manifest if the p
3739

3840
# flags.include-packages.summary
3941

40-
Comma-separated list of package types (managed, unlocked) whose metadata is included in the manifest; by default, metadata in packages is ignored.
42+
Package types (managed, unlocked) whose metadata is included in the manifest; by default, metadata in packages is ignored.
4143

4244
# flags.from-org.summary
4345

@@ -57,11 +59,11 @@ Directory to save the created manifest.
5759

5860
# flags.source-dir.summary
5961

60-
Comma-separated list of paths to the local source files to include in the manifest.
62+
Paths to the local source files to include in the manifest.
6163

6264
# flags.metadata.summary
6365

64-
Comma-separated list of names of metadata components to include in the manifest.
66+
Names of metadata components to include in the manifest.
6567

6668
# success
6769

src/commands/project/list/ignored.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export type SourceIgnoredResults = {
1818
};
1919

2020
export class Ignored extends SfCommand<SourceIgnoredResults> {
21-
public static readonly summary = messages.getMessage('description');
21+
public static readonly summary = messages.getMessage('summary');
2222
public static readonly description = messages.getMessage('description');
2323
public static readonly examples = messages.getMessages('examples');
2424
public static readonly requiresProject = true;
@@ -29,7 +29,7 @@ export class Ignored extends SfCommand<SourceIgnoredResults> {
2929
char: 'p',
3030
aliases: ['sourcepath'],
3131
deprecateAliases: true,
32-
summary: messages.getMessage('flags.source-dir'),
32+
summary: messages.getMessage('flags.source-dir.summary'),
3333
}),
3434
};
3535

0 commit comments

Comments
 (0)