@salesforce/plugin-deploy-retrieve 3.8.4 → 3.9.1

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 (61) hide show
  1. package/README.md +47 -45
  2. package/lib/commands/project/convert/source-behavior.d.ts +4 -4
  3. package/lib/commands/project/convert/source.d.ts +5 -5
  4. package/lib/commands/project/delete/tracking.d.ts +4 -4
  5. package/lib/commands/project/deploy/cancel.d.ts +5 -5
  6. package/lib/commands/project/deploy/preview.d.ts +6 -6
  7. package/lib/commands/project/deploy/quick.d.ts +8 -8
  8. package/lib/commands/project/deploy/report.d.ts +7 -7
  9. package/lib/commands/project/deploy/resume.d.ts +8 -8
  10. package/lib/commands/project/deploy/start.d.ts +23 -23
  11. package/lib/commands/project/deploy/validate.d.ts +20 -20
  12. package/lib/commands/project/generate/manifest.d.ts +9 -9
  13. package/lib/commands/project/list/ignored.d.ts +1 -1
  14. package/lib/commands/project/reset/tracking.d.ts +5 -5
  15. package/lib/commands/project/retrieve/preview.d.ts +3 -3
  16. package/lib/formatters/asyncDeployCancelResultFormatter.js +2 -1
  17. package/lib/formatters/asyncDeployCancelResultFormatter.js.map +1 -1
  18. package/lib/formatters/asyncDeployResultFormatter.js +2 -1
  19. package/lib/formatters/asyncDeployResultFormatter.js.map +1 -1
  20. package/lib/formatters/deleteResultFormatter.js +6 -7
  21. package/lib/formatters/deleteResultFormatter.js.map +1 -1
  22. package/lib/formatters/deployCancelResultFormatter.js +4 -2
  23. package/lib/formatters/deployCancelResultFormatter.js.map +1 -1
  24. package/lib/formatters/deployReportResultFormatter.js +2 -1
  25. package/lib/formatters/deployReportResultFormatter.js.map +1 -1
  26. package/lib/formatters/deployResultFormatter.js +4 -3
  27. package/lib/formatters/deployResultFormatter.js.map +1 -1
  28. package/lib/formatters/metadataConvertResultFormatter.js +3 -2
  29. package/lib/formatters/metadataConvertResultFormatter.js.map +1 -1
  30. package/lib/formatters/metadataRetrieveResultFormatter.js +2 -1
  31. package/lib/formatters/metadataRetrieveResultFormatter.js.map +1 -1
  32. package/lib/formatters/retrieveResultFormatter.js +1 -1
  33. package/lib/formatters/retrieveResultFormatter.js.map +1 -1
  34. package/lib/formatters/sourceConvertResultFormatter.js +2 -1
  35. package/lib/formatters/sourceConvertResultFormatter.js.map +1 -1
  36. package/lib/formatters/testResultsFormatter.js +3 -2
  37. package/lib/formatters/testResultsFormatter.js.map +1 -1
  38. package/lib/utils/conflicts.js +2 -1
  39. package/lib/utils/conflicts.js.map +1 -1
  40. package/lib/utils/flags.d.ts +6 -6
  41. package/lib/utils/previewOutput.js +2 -1
  42. package/lib/utils/previewOutput.js.map +1 -1
  43. package/lib/utils/progressBar.js +3 -3
  44. package/lib/utils/progressBar.js.map +1 -1
  45. package/messages/convert.mdapi.md +2 -2
  46. package/messages/convert.source.md +4 -4
  47. package/messages/delete.source.md +5 -5
  48. package/messages/delete.tracking.md +4 -4
  49. package/messages/deploy.metadata.cancel.md +8 -8
  50. package/messages/deploy.metadata.md +15 -15
  51. package/messages/deploy.metadata.preview.md +7 -7
  52. package/messages/deploy.metadata.quick.md +6 -6
  53. package/messages/deploy.metadata.report.md +7 -7
  54. package/messages/deploy.metadata.resume.md +7 -7
  55. package/messages/deploy.metadata.validate.md +9 -9
  56. package/messages/list.ignored.md +3 -3
  57. package/messages/manifest.generate.md +4 -4
  58. package/messages/retrieve.metadata.preview.md +4 -4
  59. package/messages/retrieve.start.md +16 -16
  60. package/oclif.manifest.json +508 -508
  61. package/package.json +8 -8
package/messages/retrieve.start.md CHANGED
@@ -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 "sf 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 "<%= config.bin %> 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,28 +16,28 @@ 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
- sf <%= command.id %>
19
+ <%= config.bin %> <%= 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
- sf <%= command.id %> --source-dir force-app --target-org my-scratch
23
+ <%= config.bin %> <%= 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
- 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
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
29
29
 
30
30
  - Retrieve all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
31
31
 
32
- sf <%= command.id %> --metadata ApexClass
32
+ <%= config.bin %> <%= 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
- sf <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts
36
+ <%= config.bin %> <%= 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
- sf <%= command.id %> --metadata 'ApexClass:MyApex*'
40
+ <%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*'
41
41
 
42
42
  - Retrieve a custom object called ExcitingObject that's in the SBQQ namespace:
43
43
 
@@ -49,29 +49,29 @@ To retrieve multiple metadata components, either use multiple --metadata <name>
49
49
 
50
50
  - Retrieve all custom objects and Apex classes found in all defined package directories (both examples are equivalent):
51
51
 
52
- sf <%= command.id %> --metadata CustomObject ApexClass
53
- sf <%= command.id %> --metadata CustomObject --metadata ApexClass
52
+ <%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass
53
+ <%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass
54
54
 
55
55
  - Retrieve all metadata components listed in a manifest:
56
56
 
57
- sf <%= command.id %> --manifest path/to/package.xml
57
+ <%= config.bin %> <%= command.id %> --manifest path/to/package.xml
58
58
 
59
59
  - Retrieve metadata from a package:
60
60
 
61
- sf <%= command.id %> --package-name MyPackageName
61
+ <%= config.bin %> <%= command.id %> --package-name MyPackageName
62
62
 
63
63
  - Retrieve metadata from multiple packages, one of which has a space in its name (both examples are equivalent):
64
64
 
65
- sf <%= command.id %> --package-name Package1 "PackageName With Spaces" Package3
66
- sf <%= command.id %> --package-name Package1 --package-name "PackageName With Spaces" --package-name Package3
65
+ <%= config.bin %> <%= command.id %> --package-name Package1 "PackageName With Spaces" Package3
66
+ <%= config.bin %> <%= command.id %> --package-name Package1 --package-name "PackageName With Spaces" --package-name Package3
67
67
 
68
68
  - Retrieve the metadata components listed in the force-app directory, but retrieve them in metadata format into a ZIP file in the "output" directory:
69
69
 
70
- sf <%= command.id %> --source-dir force-app --target-metadata-dir output
70
+ <%= config.bin %> <%= command.id %> --source-dir force-app --target-metadata-dir output
71
71
 
72
72
  - Retrieve in metadata format and automatically extract the contents into the "output" directory:
73
73
 
74
- sf <%= command.id %> --source-dir force-app --target-metadata-dir output --unzip
74
+ <%= config.bin %> <%= command.id %> --source-dir force-app --target-metadata-dir output --unzip
75
75
 
76
76
  # flags.api-version.summary
77
77