@salesforce/plugin-deploy-retrieve 3.7.8 → 3.7.10

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.
Files changed (40) hide show
  1. package/README.md +20 -20
  2. package/lib/commands/project/deploy/cancel.js +1 -1
  3. package/lib/commands/project/deploy/cancel.js.map +1 -1
  4. package/lib/commands/project/deploy/quick.js +1 -1
  5. package/lib/commands/project/deploy/quick.js.map +1 -1
  6. package/lib/commands/project/deploy/resume.js +1 -1
  7. package/lib/commands/project/deploy/resume.js.map +1 -1
  8. package/lib/commands/project/deploy/start.js +4 -4
  9. package/lib/commands/project/deploy/start.js.map +1 -1
  10. package/lib/commands/project/deploy/validate.js +3 -3
  11. package/lib/commands/project/deploy/validate.js.map +1 -1
  12. package/lib/commands/project/retrieve/start.js +1 -1
  13. package/lib/commands/project/retrieve/start.js.map +1 -1
  14. package/lib/formatters/asyncDeployCancelResultFormatter.d.ts +1 -2
  15. package/lib/formatters/asyncDeployCancelResultFormatter.js +3 -5
  16. package/lib/formatters/asyncDeployCancelResultFormatter.js.map +1 -1
  17. package/lib/formatters/asyncDeployResultFormatter.d.ts +1 -2
  18. package/lib/formatters/asyncDeployResultFormatter.js +4 -6
  19. package/lib/formatters/asyncDeployResultFormatter.js.map +1 -1
  20. package/lib/utils/deploy.d.ts +1 -1
  21. package/lib/utils/deploy.js +2 -2
  22. package/lib/utils/deploy.js.map +1 -1
  23. package/messages/convert.mdapi.md +3 -3
  24. package/messages/convert.source.md +4 -4
  25. package/messages/delete.source.md +6 -6
  26. package/messages/delete.tracking.md +4 -4
  27. package/messages/deploy.async.md +3 -3
  28. package/messages/deploy.metadata.cancel.md +8 -8
  29. package/messages/deploy.metadata.md +18 -18
  30. package/messages/deploy.metadata.preview.md +8 -8
  31. package/messages/deploy.metadata.quick.md +6 -6
  32. package/messages/deploy.metadata.report.md +7 -7
  33. package/messages/deploy.metadata.resume.md +7 -7
  34. package/messages/deploy.metadata.validate.md +10 -10
  35. package/messages/list.ignored.md +3 -3
  36. package/messages/manifest.generate.md +4 -4
  37. package/messages/retrieve.metadata.preview.md +4 -4
  38. package/messages/retrieve.start.md +17 -17
  39. package/oclif.manifest.json +511 -511
  40. package/package.json +6 -6
@@ -23,19 +23,19 @@ To include multiple metadata components, either set multiple --metadata <name> f
23
23
 
24
24
  - Create a manifest for deploying or retrieving all Apex classes and custom objects:
25
25
 
26
- $ <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata CustomObject
26
+ $ sf <%= command.id %> --metadata ApexClass --metadata CustomObject
27
27
 
28
28
  - Create a manifest for deleting the specified Apex class:
29
29
 
30
- $ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --type destroy
30
+ $ sf <%= command.id %> --metadata ApexClass:MyApexClass --type destroy
31
31
 
32
32
  - Create a manifest for deploying or retrieving all the metadata components in the specified local directory; name the file myNewManifest.xml:
33
33
 
34
- $ <%= config.bin %> <%= command.id %> --source-dir force-app --name myNewManifest
34
+ $ sf <%= command.id %> --source-dir force-app --name myNewManifest
35
35
 
36
36
  - Create a manifest from the metadata components in the specified org and include metadata in any unlocked packages:
37
37
 
38
- $ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --include-packages unlocked
38
+ $ sf <%= command.id %> --from-org test@myorg.com --include-packages unlocked
39
39
 
40
40
  # flags.include-packages.summary
41
41
 
@@ -6,19 +6,19 @@ Preview a retrieval to see what will be retrieved from the org, the potential co
6
6
 
7
7
  You must run this command from within a project.
8
8
 
9
- The command outputs a table that describes what will happen if you run the "<%= config.bin %> project retrieve start" command. The table lists the metadata components that will be retrieved and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won't be retrieved because they're included in your .forceignore file.
9
+ The command outputs a table that describes what will happen if you run the "sf project retrieve start" command. The table lists the metadata components that will be retrieved and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won't be retrieved because they're included in your .forceignore file.
10
10
 
11
- If your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "<%= config.bin %> org create scratch|sandbox" commands.
11
+ If your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "sf org create scratch|sandbox" commands.
12
12
 
13
13
  # examples
14
14
 
15
15
  - Preview the retrieve of all changes from your default org:
16
16
 
17
- <%= config.bin %> <%= command.id %>
17
+ sf <%= command.id %>
18
18
 
19
19
  - Preview the retrieve when ignoring any conflicts from an org with alias "my-scratch":
20
20
 
21
- <%= config.bin %> <%= command.id %> --ignore-conflicts --target-org my-scratch
21
+ sf <%= command.id %> --ignore-conflicts --target-org my-scratch
22
22
 
23
23
  # flags.target-org.summary
24
24
 
@@ -8,7 +8,7 @@ You must run this command from within a project.
8
8
 
9
9
  Metadata components are retrieved in source format by default. Retrieve them in metadata format by specifying the --target-metadata-dir flag, which retrieves the components into a ZIP file in the specified directory.
10
10
 
11
- If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "<%= config.bin %> org create scratch|sandbox" commands.
11
+ If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "sf org create scratch|sandbox" commands.
12
12
 
13
13
  To retrieve multiple metadata components, either use multiple --metadata <name> flags or use 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
14
 
@@ -16,54 +16,54 @@ To retrieve multiple metadata components, either use multiple --metadata <name>
16
16
 
17
17
  - Retrieve all remote changes from your default org:
18
18
 
19
- <%= config.bin %> <%= command.id %>
19
+ sf <%= command.id %>
20
20
 
21
21
  - Retrieve the source files in the "force-app" directory from an org with alias "my-scratch":
22
22
 
23
- <%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch
23
+ sf <%= command.id %> --source-dir force-app --target-org my-scratch
24
24
 
25
25
  - Retrieve all the Apex classes and custom objects whose source is in the "force-app" directory. The list views, layouts, etc, that are associated with the custom objects are also retrieved. Both examples are equivalent:
26
26
 
27
- <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects
28
- <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects
27
+ sf <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects
28
+ sf <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects
29
29
 
30
30
  - Retrieve all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
31
31
 
32
- <%= config.bin %> <%= command.id %> --metadata ApexClass
32
+ sf <%= command.id %> --metadata ApexClass
33
33
 
34
34
  - Retrieve a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class source files in your local project if there are conflicts!):
35
35
 
36
- <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts
36
+ sf <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts
37
37
 
38
38
  - Retrieve specific Apex classes that match a pattern; in this example, retrieve Apex classes whose names contain the string "MyApex":
39
39
 
40
- <%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*'
40
+ sf <%= command.id %> --metadata 'ApexClass:MyApex*'
41
41
 
42
42
  - Retrieve all custom objects and Apex classes found in all defined package directories (both examples are equivalent):
43
43
 
44
- <%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass
45
- <%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass
44
+ sf <%= command.id %> --metadata CustomObject ApexClass
45
+ sf <%= command.id %> --metadata CustomObject --metadata ApexClass
46
46
 
47
47
  - Retrieve all metadata components listed in a manifest:
48
48
 
49
- <%= config.bin %> <%= command.id %> --manifest path/to/package.xml
49
+ sf <%= command.id %> --manifest path/to/package.xml
50
50
 
51
51
  - Retrieve metadata from a package:
52
52
 
53
- <%= config.bin %> <%= command.id %> --package-name MyPackageName
53
+ sf <%= command.id %> --package-name MyPackageName
54
54
 
55
55
  - Retrieve metadata from multiple packages, one of which has a space in its name (both examples are equivalent):
56
56
 
57
- <%= config.bin %> <%= command.id %> --package-name Package1 "PackageName With Spaces" Package3
58
- <%= config.bin %> <%= command.id %> --package-name Package1 --package-name "PackageName With Spaces" --package-name Package3
57
+ sf <%= command.id %> --package-name Package1 "PackageName With Spaces" Package3
58
+ sf <%= command.id %> --package-name Package1 --package-name "PackageName With Spaces" --package-name Package3
59
59
 
60
60
  - Retrieve the metadata components listed in the force-app directory, but retrieve them in metadata format into a ZIP file in the "output" directory:
61
61
 
62
- <%= config.bin %> <%= command.id %> --source-dir force-app --target-metadata-dir output
62
+ sf <%= command.id %> --source-dir force-app --target-metadata-dir output
63
63
 
64
64
  - Retrieve in metadata format and automatically extract the contents into the "output" directory:
65
65
 
66
- <%= config.bin %> <%= command.id %> --source-dir force-app --target-metadata-dir output --unzip
66
+ sf <%= command.id %> --source-dir force-app --target-metadata-dir output --unzip
67
67
 
68
68
  # flags.api-version.summary
69
69
 
@@ -161,7 +161,7 @@ There are changes in your local files that conflict with the org changes you're
161
161
 
162
162
  - To overwrite the local changes, rerun this command with the --ignore-conflicts flag.
163
163
 
164
- - To overwrite the remote changes, run the "%s project deploy start" command with the --ignore-conflicts flag.
164
+ - To overwrite the remote changes, run the "sf project deploy start" command with the --ignore-conflicts flag.
165
165
 
166
166
  # info.WroteZipFile
167
167