@salesforce/plugin-deploy-retrieve 1.5.2 → 1.5.5

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 (38) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +141 -13
  3. package/lib/commands/deploy/metadata/preview.d.ts +17 -0
  4. package/lib/commands/deploy/metadata/preview.js +86 -0
  5. package/lib/commands/deploy/metadata/preview.js.map +1 -0
  6. package/lib/commands/deploy/metadata/quick.js +2 -3
  7. package/lib/commands/deploy/metadata/quick.js.map +1 -1
  8. package/lib/commands/deploy.d.ts +1 -1
  9. package/lib/commands/deploy.js +20 -12
  10. package/lib/commands/deploy.js.map +1 -1
  11. package/lib/commands/retrieve/metadata/preview.d.ts +14 -0
  12. package/lib/commands/retrieve/metadata/preview.js +63 -0
  13. package/lib/commands/retrieve/metadata/preview.js.map +1 -0
  14. package/lib/commands/retrieve/metadata.js +22 -19
  15. package/lib/commands/retrieve/metadata.js.map +1 -1
  16. package/lib/utils/deploy.js +17 -17
  17. package/lib/utils/deploy.js.map +1 -1
  18. package/lib/utils/metadataDeployer.d.ts +2 -2
  19. package/lib/utils/metadataDeployer.js +9 -7
  20. package/lib/utils/metadataDeployer.js.map +1 -1
  21. package/lib/utils/output.d.ts +1 -1
  22. package/lib/utils/output.js +19 -30
  23. package/lib/utils/output.js.map +1 -1
  24. package/lib/utils/previewOutput.d.ts +30 -0
  25. package/lib/utils/previewOutput.js +199 -0
  26. package/lib/utils/previewOutput.js.map +1 -0
  27. package/lib/utils/progressBar.js +1 -2
  28. package/lib/utils/progressBar.js.map +1 -1
  29. package/messages/deploy.md +36 -0
  30. package/messages/deploy.metadata.md +9 -1
  31. package/messages/deploy.metadata.preview.md +93 -0
  32. package/messages/deploy.metadata.validate.md +1 -1
  33. package/messages/previewMessages.md +39 -0
  34. package/messages/retrieve.metadata.preview.md +59 -0
  35. package/oclif.manifest.json +1 -1
  36. package/package.json +31 -29
  37. package/schemas/deploy-metadata-preview.json +72 -0
  38. package/schemas/retrieve-metadata-preview.json +72 -0
@@ -0,0 +1,199 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getConflictFiles = exports.printTables = exports.compileResults = void 0;
4
+ /*
5
+ * Copyright (c) 2022, salesforce.com, inc.
6
+ * All rights reserved.
7
+ * Licensed under the BSD 3-Clause license.
8
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
9
+ */
10
+ const path = require("path");
11
+ const core_1 = require("@oclif/core");
12
+ const sf_plugins_core_1 = require("@salesforce/sf-plugins-core");
13
+ const chalk_1 = require("chalk");
14
+ const core_2 = require("@salesforce/core");
15
+ const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
16
+ const filePathGenerator_1 = require("@salesforce/source-deploy-retrieve/lib/src/utils/filePathGenerator");
17
+ core_2.Messages.importMessagesDirectory(__dirname);
18
+ const messages = core_2.Messages.load('@salesforce/plugin-deploy-retrieve', 'previewMessages', [
19
+ 'conflicts.header',
20
+ 'conflicts.none',
21
+ 'ignored.header',
22
+ 'ignored.none',
23
+ 'deploy.none',
24
+ 'deploy.header',
25
+ 'delete.header',
26
+ 'delete.none',
27
+ 'retrieve.header',
28
+ 'retrieve.none',
29
+ ]);
30
+ const ensureAbsolutePath = (f) => (path.isAbsolute(f) ? f : path.resolve(f));
31
+ // borrowed from STL populateFilesPaths.
32
+ // TODO: this goes in SDR maybe?
33
+ const resolvePaths = (filenames) => {
34
+ // component set generated from the filenames on all local changes
35
+ const resolver = new source_deploy_retrieve_1.MetadataResolver(undefined, source_deploy_retrieve_1.VirtualTreeContainer.fromFilePaths(filenames), false);
36
+ const sourceComponents = filenames
37
+ .flatMap((filename) => {
38
+ try {
39
+ return resolver.getComponentsFromPath(filename);
40
+ }
41
+ catch (e) {
42
+ // resolver will do logging before throw we don't do it here
43
+ return undefined;
44
+ }
45
+ })
46
+ .filter((sc) => sc && 'fullName' in sc && 'type' in sc)
47
+ .map((sc) => ({ fullName: sc.fullName, type: sc.type.name, path: ensureAbsolutePath(sc.xml) }));
48
+ // dedupe by xml path
49
+ return Array.from(new Map(sourceComponents.map((sc) => [sc.path, sc])).values());
50
+ };
51
+ const calculateDeployOperation = (destructiveChangesType) => {
52
+ switch (destructiveChangesType) {
53
+ case source_deploy_retrieve_1.DestructiveChangesType.POST:
54
+ return 'deletePost';
55
+ case source_deploy_retrieve_1.DestructiveChangesType.PRE:
56
+ return 'deletePre';
57
+ default:
58
+ return 'deploy';
59
+ }
60
+ };
61
+ const getNonIgnoredConflicts = (files) => files.filter((f) => f.conflict && !f.ignored);
62
+ const willGo = (previewFile) => !previewFile.conflict && !previewFile.ignored;
63
+ const getWillDeploy = (files) => files.filter((f) => willGo(f) && f.operation === 'deploy');
64
+ const getWillRetrieve = (files) => files.filter((f) => willGo(f) && f.operation === 'retrieve');
65
+ const getWillDelete = (files) => files.filter((f) => willGo(f) && ['deletePre', 'deletePost'].includes(f.operation));
66
+ // relative paths are easier on tables
67
+ const columns = { type: {}, fullName: {}, projectRelativePath: { header: 'Path' } };
68
+ const makeKey = ({ type, fullName }) => `${type.name}#${fullName}`;
69
+ const compileResults = ({ componentSet, projectPath, filesWithConflicts, forceIgnore, baseOperation, remoteDeletes, }) => {
70
+ // when we iterate all the componentSet,
71
+ // this map makes it easy to get the source-backed local components
72
+ const sourceBackedComponents = new Map(componentSet.getSourceComponents().map((sc) => [makeKey({ type: sc.type, fullName: sc.fullName }), sc]));
73
+ const sourceComponentToPreviewFile = (c) => ({
74
+ type: c.type.name,
75
+ fullName: c.fullName,
76
+ conflict: [c.xml, c.content].some((v) => v && filesWithConflicts.has(v)),
77
+ ignored: [c.xml, c.content].some((v) => v && forceIgnore.denies(v)),
78
+ path: path.isAbsolute(c.xml) ? c.xml : path.resolve(c.xml),
79
+ projectRelativePath: path.relative(projectPath, c.xml), // for cleaner output
80
+ // There should not be anything in forceignore returned by the componentSet
81
+ });
82
+ const actionableFiles = componentSet
83
+ .toArray()
84
+ .map((c) => sourceBackedComponents.get(makeKey(c)) ?? c)
85
+ .map((cmp) => {
86
+ const maybeSourceBackedComponent = sourceBackedComponents.get(makeKey(cmp)) ?? cmp;
87
+ if ('xml' in maybeSourceBackedComponent) {
88
+ // source backed components exist locally
89
+ return {
90
+ ...sourceComponentToPreviewFile(maybeSourceBackedComponent),
91
+ operation: baseOperation === 'deploy'
92
+ ? calculateDeployOperation(maybeSourceBackedComponent.getDestructiveChangesType())
93
+ : baseOperation,
94
+ };
95
+ }
96
+ else {
97
+ return {
98
+ type: maybeSourceBackedComponent.type.name,
99
+ fullName: maybeSourceBackedComponent.fullName,
100
+ // if it doesn't exist locally, it can't be a conflict
101
+ conflict: false,
102
+ operation: baseOperation,
103
+ // we have to calculate the "potential filename" to know if a remote retrieve would be ignored
104
+ ignored: (0, filePathGenerator_1.filePathsFromMetadataComponent)(maybeSourceBackedComponent).some((p) => forceIgnore.denies(p)),
105
+ };
106
+ }
107
+ })
108
+ // remote deletes are not in the componentSet
109
+ .concat((remoteDeletes ?? []).map((c) => ({
110
+ ...sourceComponentToPreviewFile(c),
111
+ operation: 'deletePre',
112
+ })));
113
+ // Source backed components won't appear in the ComponentSet if ignored
114
+ const ignoredSourceComponents = resolvePaths([...(componentSet.forceIgnoredPaths ?? [])]).map((resolved) => ({
115
+ ...resolved,
116
+ projectRelativePath: path.relative(projectPath, resolved.path),
117
+ conflict: false,
118
+ ignored: true,
119
+ }));
120
+ return {
121
+ ignored: ignoredSourceComponents.concat(actionableFiles.filter((f) => f.ignored)),
122
+ toDeploy: getWillDeploy(actionableFiles),
123
+ toRetrieve: getWillRetrieve(actionableFiles),
124
+ toDelete: getWillDelete(actionableFiles),
125
+ conflicts: getNonIgnoredConflicts(actionableFiles),
126
+ };
127
+ };
128
+ exports.compileResults = compileResults;
129
+ const printDeployTable = (files) => {
130
+ core_1.CliUx.ux.log();
131
+ if (files.length === 0) {
132
+ core_1.CliUx.ux.log((0, chalk_1.dim)(messages.getMessage('deploy.none')));
133
+ }
134
+ else {
135
+ // not using table title property to avoid all the ASCII art
136
+ core_1.CliUx.ux.log(sf_plugins_core_1.StandardColors.success((0, chalk_1.bold)(messages.getMessage('deploy.header', [files.length]))));
137
+ core_1.CliUx.ux.table(files, columns);
138
+ }
139
+ };
140
+ const printRetrieveTable = (files) => {
141
+ core_1.CliUx.ux.log();
142
+ if (files.length === 0) {
143
+ core_1.CliUx.ux.log((0, chalk_1.dim)(messages.getMessage('retrieve.none')));
144
+ }
145
+ else {
146
+ // not using table title property to avoid all the ASCII art
147
+ core_1.CliUx.ux.log(sf_plugins_core_1.StandardColors.success((0, chalk_1.bold)(messages.getMessage('retrieve.header', [files.length]))));
148
+ core_1.CliUx.ux.table(files, columns);
149
+ }
150
+ };
151
+ const printDeleteTable = (files) => {
152
+ core_1.CliUx.ux.log();
153
+ if (files.length === 0) {
154
+ core_1.CliUx.ux.log((0, chalk_1.dim)(messages.getMessage('delete.none')));
155
+ }
156
+ else {
157
+ core_1.CliUx.ux.log(sf_plugins_core_1.StandardColors.warning((0, chalk_1.bold)(messages.getMessage('delete.header', [files.length]))));
158
+ core_1.CliUx.ux.table(files, columns);
159
+ }
160
+ };
161
+ const printConflictsTable = (files, baseOperation) => {
162
+ core_1.CliUx.ux.log();
163
+ if (files.length === 0) {
164
+ core_1.CliUx.ux.log((0, chalk_1.dim)(messages.getMessage('conflicts.none')));
165
+ }
166
+ else {
167
+ core_1.CliUx.ux.log(sf_plugins_core_1.StandardColors.error((0, chalk_1.bold)(messages.getMessage('conflicts.header', [files.length, baseOperation]))));
168
+ core_1.CliUx.ux.table(files, columns, { sort: 'path' });
169
+ }
170
+ };
171
+ const printIgnoredTable = (files, baseOperation) => {
172
+ core_1.CliUx.ux.log();
173
+ if (files.length === 0) {
174
+ core_1.CliUx.ux.log((0, chalk_1.dim)(messages.getMessage('ignored.none')));
175
+ }
176
+ else {
177
+ core_1.CliUx.ux.log((0, chalk_1.dim)(messages.getMessage('ignored.header', [files.length, baseOperation])));
178
+ core_1.CliUx.ux.table(files, columns, { sort: 'path' });
179
+ }
180
+ };
181
+ const printTables = (result, baseOperation) => {
182
+ printConflictsTable(result.conflicts, baseOperation);
183
+ printDeleteTable(result.toDelete);
184
+ if (baseOperation === 'deploy') {
185
+ printDeployTable(result.toDeploy);
186
+ }
187
+ else if (baseOperation === 'retrieve') {
188
+ printRetrieveTable(result.toRetrieve);
189
+ }
190
+ printIgnoredTable(result.ignored, baseOperation);
191
+ };
192
+ exports.printTables = printTables;
193
+ const getConflictFiles = async (stl, ignore = false) => {
194
+ return !stl || ignore
195
+ ? new Set()
196
+ : new Set((await stl.getConflicts()).flatMap((conflict) => conflict.filenames.map((f) => path.resolve(f))));
197
+ };
198
+ exports.getConflictFiles = getConflictFiles;
199
+ //# sourceMappingURL=previewOutput.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"previewOutput.js","sourceRoot":"","sources":["../../src/utils/previewOutput.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,6BAA6B;AAC7B,sCAAoC;AACpC,iEAA6D;AAC7D,iCAAkC;AAClC,2CAA4C;AAC5C,+EAQ4C;AAC5C,0GAAoH;AAIpH,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,IAAI,CAAC,oCAAoC,EAAE,iBAAiB,EAAE;IACtF,kBAAkB;IAClB,gBAAgB;IAChB,gBAAgB;IAChB,cAAc;IACd,aAAa;IACb,eAAe;IACf,eAAe;IACf,aAAa;IACb,iBAAiB;IACjB,eAAe;CAChB,CAAC,CAAC;AAwBH,MAAM,kBAAkB,GAAG,CAAC,CAAS,EAAU,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AAE7F,wCAAwC;AACxC,gCAAgC;AAChC,MAAM,YAAY,GAAG,CAAC,SAAmB,EAA0D,EAAE;IACnG,kEAAkE;IAClE,MAAM,QAAQ,GAAG,IAAI,yCAAgB,CAAC,SAAS,EAAE,6CAAoB,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,CAAC;IACvG,MAAM,gBAAgB,GAAG,SAAS;SAC/B,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QACpB,IAAI;YACF,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;SACjD;QAAC,OAAO,CAAC,EAAE;YACV,4DAA4D;YAC5D,OAAO,SAAS,CAAC;SAClB;IACH,CAAC,CAAC;SACD,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,UAAU,IAAI,EAAE,IAAI,MAAM,IAAI,EAAE,CAAC;SACtD,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,kBAAkB,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IAClG,qBAAqB;IACrB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;AACnF,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,sBAA+C,EAA4B,EAAE;IAC7G,QAAQ,sBAAsB,EAAE;QAC9B,KAAK,+CAAsB,CAAC,IAAI;YAC9B,OAAO,YAAY,CAAC;QACtB,KAAK,+CAAsB,CAAC,GAAG;YAC7B,OAAO,WAAW,CAAC;QACrB;YACE,OAAO,QAAQ,CAAC;KACnB;AACH,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,KAAoB,EAAiB,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;AAEtH,MAAM,MAAM,GAAG,CAAC,WAAwB,EAAW,EAAE,CAAC,CAAC,WAAW,CAAC,QAAQ,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;AAEpG,MAAM,aAAa,GAAG,CAAC,KAAoB,EAAiB,EAAE,CAC5D,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC;AAE7D,MAAM,eAAe,GAAG,CAAC,KAAoB,EAAiB,EAAE,CAC9D,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,KAAK,UAAU,CAAC,CAAC;AAE/D,MAAM,aAAa,GAAG,CAAC,KAAoB,EAAiB,EAAE,CAC5D,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;AAEtF,sCAAsC;AACtC,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,mBAAmB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC;AACpF,MAAM,OAAO,GAAG,CAAC,EAAE,IAAI,EAAE,QAAQ,EAA4C,EAAU,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,IAAI,QAAQ,EAAE,CAAC;AAE9G,MAAM,cAAc,GAAG,CAAC,EAC7B,YAAY,EACZ,WAAW,EACX,kBAAkB,EAClB,WAAW,EACX,aAAa,EACb,aAAa,GAQd,EAAiB,EAAE;IAClB,wCAAwC;IACxC,mEAAmE;IACnE,MAAM,sBAAsB,GAAG,IAAI,GAAG,CACpC,YAAY,CAAC,mBAAmB,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CACxG,CAAC;IAEF,MAAM,4BAA4B,GAAG,CAAC,CAAkB,EAAkC,EAAE,CAAC,CAAC;QAC5F,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI;QACjB,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,QAAQ,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACxE,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACnE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;QAC1D,mBAAmB,EAAE,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,qBAAqB;QAC7E,2EAA2E;KAC5E,CAAC,CAAC;IAEH,MAAM,eAAe,GAAG,YAAY;SACjC,OAAO,EAAE;SACT,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SACvD,GAAG,CAAC,CAAC,GAAG,EAAe,EAAE;QACxB,MAAM,0BAA0B,GAAG,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC;QACnF,IAAI,KAAK,IAAI,0BAA0B,EAAE;YACvC,yCAAyC;YACzC,OAAO;gBACL,GAAG,4BAA4B,CAAC,0BAA0B,CAAC;gBAC3D,SAAS,EACP,aAAa,KAAK,QAAQ;oBACxB,CAAC,CAAC,wBAAwB,CAAC,0BAA0B,CAAC,yBAAyB,EAAE,CAAC;oBAClF,CAAC,CAAC,aAAa;aACpB,CAAC;SACH;aAAM;YACL,OAAO;gBACL,IAAI,EAAE,0BAA0B,CAAC,IAAI,CAAC,IAAI;gBAC1C,QAAQ,EAAE,0BAA0B,CAAC,QAAQ;gBAC7C,sDAAsD;gBACtD,QAAQ,EAAE,KAAK;gBACf,SAAS,EAAE,aAAa;gBACxB,8FAA8F;gBAC9F,OAAO,EAAE,IAAA,kDAA8B,EAAC,0BAA0B,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;aACvG,CAAC;SACH;IACH,CAAC,CAAC;QACF,6CAA6C;SAC5C,MAAM,CACL,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,GAAG,CACvB,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC;QACnB,GAAG,4BAA4B,CAAC,CAAC,CAAC;QAClC,SAAS,EAAE,WAAW;KACvB,CAAC,CACH,CACF,CAAC;IAEJ,uEAAuE;IACvE,MAAM,uBAAuB,GAAG,YAAY,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAC3F,CAAC,QAAQ,EAAe,EAAE,CAAC,CAAC;QAC1B,GAAG,QAAQ;QACX,mBAAmB,EAAE,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC;QAC9D,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,IAAI;KACd,CAAC,CACH,CAAC;IAEF,OAAO;QACL,OAAO,EAAE,uBAAuB,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACjF,QAAQ,EAAE,aAAa,CAAC,eAAe,CAAC;QACxC,UAAU,EAAE,eAAe,CAAC,eAAe,CAAC;QAC5C,QAAQ,EAAE,aAAa,CAAC,eAAe,CAAC;QACxC,SAAS,EAAE,sBAAsB,CAAC,eAAe,CAAC;KACnD,CAAC;AACJ,CAAC,CAAC;AApFW,QAAA,cAAc,kBAoFzB;AAEF,MAAM,gBAAgB,GAAG,CAAC,KAAoB,EAAQ,EAAE;IACtD,YAAK,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC;IACf,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QACtB,YAAK,CAAC,EAAE,CAAC,GAAG,CAAC,IAAA,WAAG,EAAC,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;KACvD;SAAM;QACL,4DAA4D;QAC5D,YAAK,CAAC,EAAE,CAAC,GAAG,CAAC,gCAAc,CAAC,OAAO,CAAC,IAAA,YAAI,EAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACjG,YAAK,CAAC,EAAE,CAAC,KAAK,CAAc,KAAK,EAAE,OAAO,CAAC,CAAC;KAC7C;AACH,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,KAAoB,EAAQ,EAAE;IACxD,YAAK,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC;IACf,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QACtB,YAAK,CAAC,EAAE,CAAC,GAAG,CAAC,IAAA,WAAG,EAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;KACzD;SAAM;QACL,4DAA4D;QAC5D,YAAK,CAAC,EAAE,CAAC,GAAG,CAAC,gCAAc,CAAC,OAAO,CAAC,IAAA,YAAI,EAAC,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACnG,YAAK,CAAC,EAAE,CAAC,KAAK,CAAc,KAAK,EAAE,OAAO,CAAC,CAAC;KAC7C;AACH,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,KAAoB,EAAQ,EAAE;IACtD,YAAK,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC;IACf,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QACtB,YAAK,CAAC,EAAE,CAAC,GAAG,CAAC,IAAA,WAAG,EAAC,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;KACvD;SAAM;QACL,YAAK,CAAC,EAAE,CAAC,GAAG,CAAC,gCAAc,CAAC,OAAO,CAAC,IAAA,YAAI,EAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACjG,YAAK,CAAC,EAAE,CAAC,KAAK,CAAc,KAAK,EAAE,OAAO,CAAC,CAAC;KAC7C;AACH,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,KAAoB,EAAE,aAA4B,EAAQ,EAAE;IACvF,YAAK,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC;IACf,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QACtB,YAAK,CAAC,EAAE,CAAC,GAAG,CAAC,IAAA,WAAG,EAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;KAC1D;SAAM;QACL,YAAK,CAAC,EAAE,CAAC,GAAG,CAAC,gCAAc,CAAC,KAAK,CAAC,IAAA,YAAI,EAAC,QAAQ,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACjH,YAAK,CAAC,EAAE,CAAC,KAAK,CAAc,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;KAC/D;AACH,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,KAAoB,EAAE,aAA4B,EAAQ,EAAE;IACrF,YAAK,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC;IACf,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QACtB,YAAK,CAAC,EAAE,CAAC,GAAG,CAAC,IAAA,WAAG,EAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;KACxD;SAAM;QACL,YAAK,CAAC,EAAE,CAAC,GAAG,CAAC,IAAA,WAAG,EAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QACxF,YAAK,CAAC,EAAE,CAAC,KAAK,CAAc,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;KAC/D;AACH,CAAC,CAAC;AAEK,MAAM,WAAW,GAAG,CAAC,MAAqB,EAAE,aAA4B,EAAQ,EAAE;IACvF,mBAAmB,CAAC,MAAM,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;IACrD,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAClC,IAAI,aAAa,KAAK,QAAQ,EAAE;QAC9B,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;KACnC;SAAM,IAAI,aAAa,KAAK,UAAU,EAAE;QACvC,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;KACvC;IACD,iBAAiB,CAAC,MAAM,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;AACnD,CAAC,CAAC;AATW,QAAA,WAAW,eAStB;AAEK,MAAM,gBAAgB,GAAG,KAAK,EAAE,GAAoB,EAAE,MAAM,GAAG,KAAK,EAAwB,EAAE;IACnG,OAAO,CAAC,GAAG,IAAI,MAAM;QACnB,CAAC,CAAC,IAAI,GAAG,EAAU;QACnB,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAChH,CAAC,CAAC;AAJW,QAAA,gBAAgB,oBAI3B"}
@@ -20,7 +20,6 @@ class DeployProgress extends sf_plugins_core_1.Progress {
20
20
  start() {
21
21
  super.start(0, { status: 'Waiting' }, DeployProgress.OPTIONS);
22
22
  this.deploy.onUpdate((data) => {
23
- var _a;
24
23
  // the numCompTot. isn't computed right away, wait to start until we know how many we have
25
24
  if (data.numberComponentsTotal) {
26
25
  this.setTotal(data.numberComponentsTotal + data.numberTestsTotal);
@@ -29,7 +28,7 @@ class DeployProgress extends sf_plugins_core_1.Progress {
29
28
  });
30
29
  }
31
30
  else {
32
- this.update(0, { status: (_a = mdTrasferMessages.getMessage(data.status)) !== null && _a !== void 0 ? _a : 'Waiting' });
31
+ this.update(0, { status: mdTrasferMessages.getMessage(data.status) ?? 'Waiting' });
33
32
  }
34
33
  // the numTestsTot. isn't computed until validated as tests by the server, update the PB once we know
35
34
  if (data.numberTestsTotal && data.numberComponentsTotal) {
@@ -1 +1 @@
1
- {"version":3,"file":"progressBar.js","sourceRoot":"","sources":["../../src/utils/progressBar.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,2CAAuE;AAEvE,2CAA4C;AAC5C,iEAAuD;AAEvD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,iBAAiB,GAAG,eAAQ,CAAC,YAAY,CAAC,oCAAoC,EAAE,mBAAmB,CAAC,CAAC;AAE3G,MAAa,cAAe,SAAQ,0BAAQ;IAS1C,YAA2B,MAAyB,EAAE,WAAW,GAAG,KAAK;QACvE,KAAK,CAAC,CAAC,WAAW,IAAI,cAAG,CAAC,UAAU,CAAC,0BAAmB,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC,CAAC;QAD5D,WAAM,GAAN,MAAM,CAAmB;IAEpD,CAAC;IAEM,KAAK;QACV,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;QAC9D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE;;YAC5B,0FAA0F;YAC1F,IAAI,IAAI,CAAC,qBAAqB,EAAE;gBAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;gBAClE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC,oBAAoB,EAAE;oBACrE,MAAM,EAAE,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC;iBAClD,CAAC,CAAC;aACJ;iBAAM;gBACL,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,MAAA,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,mCAAI,SAAS,EAAE,CAAC,CAAC;aACpF;YAED,qGAAqG;YACrG,IAAI,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,qBAAqB,EAAE;gBACvD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;aACnE;QACH,CAAC,CAAC,CAAC;QAEH,8CAA8C;QAC9C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAE5G,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAExC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAY,EAAE,EAAE;YACnC,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,MAAM,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;;AAzCH,wCA0CC;AAzCgB,sBAAO,GAAG;IACvB,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,mDAAmD;IAC3D,eAAe,EAAE,QAAQ;IACzB,iBAAiB,EAAE,QAAQ;IAC3B,QAAQ,EAAE,IAAI;CACf,CAAC"}
1
+ {"version":3,"file":"progressBar.js","sourceRoot":"","sources":["../../src/utils/progressBar.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,2CAAuE;AAEvE,2CAA4C;AAC5C,iEAAuD;AAEvD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,iBAAiB,GAAG,eAAQ,CAAC,YAAY,CAAC,oCAAoC,EAAE,mBAAmB,CAAC,CAAC;AAE3G,MAAa,cAAe,SAAQ,0BAAQ;IAS1C,YAA2B,MAAyB,EAAE,WAAW,GAAG,KAAK;QACvE,KAAK,CAAC,CAAC,WAAW,IAAI,cAAG,CAAC,UAAU,CAAC,0BAAmB,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC,CAAC;QAD5D,WAAM,GAAN,MAAM,CAAmB;IAEpD,CAAC;IAEM,KAAK;QACV,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;QAC9D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE;YAC5B,0FAA0F;YAC1F,IAAI,IAAI,CAAC,qBAAqB,EAAE;gBAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;gBAClE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC,oBAAoB,EAAE;oBACrE,MAAM,EAAE,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC;iBAClD,CAAC,CAAC;aACJ;iBAAM;gBACL,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC;aACpF;YAED,qGAAqG;YACrG,IAAI,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,qBAAqB,EAAE;gBACvD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;aACnE;QACH,CAAC,CAAC,CAAC;QAEH,8CAA8C;QAC9C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAE5G,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAExC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAY,EAAE,EAAE;YACnC,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,MAAM,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;;AAzCH,wCA0CC;AAzCgB,sBAAO,GAAG;IACvB,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,mDAAmD;IAC3D,eAAe,EAAE,QAAQ;IACzB,iBAAiB,EAAE,QAAQ;IAC3B,QAAQ,EAAE,IAAI;CACf,CAAC"}
@@ -44,3 +44,39 @@ Initialization Failures. The following table describes each failure:
44
44
  # warning.TargetOrgIsExpired
45
45
 
46
46
  The target-org, "%s", is expired. Do you want to pick another org?
47
+
48
+ # AnalyzingProject
49
+
50
+ Analyzing project
51
+
52
+ # UsingOptionsFromFile
53
+
54
+ Using options found in %s.
55
+
56
+ # FoundNothingToDeploy
57
+
58
+ Found nothing in the project to deploy.
59
+
60
+ # NothingSelectedToDeploy
61
+
62
+ Nothing was selected to deploy.
63
+
64
+ # DeployOptionsSavedToFile
65
+
66
+ Your deploy options have been saved to %s.
67
+
68
+ # DeployOptionsIncludedInGitIgnore
69
+
70
+ We added %s to the .gitignore for you.
71
+
72
+ # DeployersHaveNonZeroExitCode
73
+
74
+ One or more of the selected deployers exited with a non-zero exit code.
75
+
76
+ # DeployerExitCode
77
+
78
+ Deployer "%s" exited with code %d.
79
+
80
+ # save.as.default
81
+
82
+ Save username %s as default?
@@ -156,7 +156,7 @@ Target API version for the deploy.
156
156
 
157
157
  # flags.api-version.description
158
158
 
159
- Use this flag to override the default API version, which is the latest version supported the CLI, with the API version of your package.xml file.
159
+ Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.
160
160
 
161
161
  # flags.async.summary
162
162
 
@@ -204,3 +204,11 @@ There are changes in the org that conflict with the local changes you're trying
204
204
  - To overwrite the remote changes, rerun this command with the --ignore-conflicts flag.
205
205
 
206
206
  - To overwrite the local changes, run the "sf retrieve metadata" command with the --ignore-conflicts flag.
207
+
208
+ # error.nothingToDeploy
209
+
210
+ No local changes to deploy.
211
+
212
+ # error.nothingToDeploy.Actions
213
+
214
+ - To see conflicts and ignored files, run "sf deploy metadata preview" with any of the manifest, directory, or metadata flags.
@@ -0,0 +1,93 @@
1
+ # summary
2
+
3
+ Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.
4
+
5
+ # description
6
+
7
+ You must run this command from within a project.
8
+
9
+ The command outputs a table that describes what will happen if you run the "sf deploy metadata" command. The table lists the metadata components that will be deployed 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 deployed because they're included in your .forceignore file.
10
+
11
+ If your org allows source tracking, then this command considers conflicts between the org and local. Some orgs, such as production orgs, never allow source tracking. Use the "--no-track-source" flag when you create a scratch or sandbox org to disable source tracking.
12
+
13
+ To preview the deployment of 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.
14
+
15
+ # examples
16
+
17
+ - NOTE: The commands to preview a deployment and actually deploy it use similar flags. We provide a few preview examples here, but see the help for "sf deploy metadata" for more examples that you can adapt for previewing.
18
+
19
+ - Preview the deployment of source files in a directory, such as force-app:
20
+
21
+ <%= config.bin %> <%= command.id %> --source-dir force-app
22
+
23
+ - Preview the deployment of all Apex classes:
24
+
25
+ <%= config.bin %> <%= command.id %> --metadata ApexClass
26
+
27
+ - Preview deployment of a specific Apex class:
28
+
29
+ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass
30
+
31
+ - Preview deployment of all components listed in a manifest:
32
+
33
+ <%= config.bin %> <%= command.id %> --manifest path/to/package.xml
34
+
35
+ # flags.target-org.summary
36
+
37
+ Login username or alias for the target org.
38
+
39
+ # flags.target-org.description
40
+
41
+ Overrides your default org.
42
+
43
+ # flags.metadata.summary
44
+
45
+ Metadata component names to preview.
46
+
47
+ # flags.source-dir.summary
48
+
49
+ Path to the local source files to preview.
50
+
51
+ # flags.source-dir.description
52
+
53
+ The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its subdirectories).
54
+
55
+ If you specify this flag, don’t specify --metadata or --manifest.
56
+
57
+ # flags.manifest.summary
58
+
59
+ Full file path for manifest (package.xml) of components to preview.
60
+
61
+ # flags.manifest.description
62
+
63
+ All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
64
+
65
+ # flags.ignore-conflicts.summary
66
+
67
+ Ignore conflicts and deploy local files, even if they overwrite changes in the org.
68
+
69
+ # flags.ignore-conflicts.description
70
+
71
+ This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as production orgs.
72
+
73
+ # flags.concise.summary
74
+
75
+ Omit ignored files.
76
+
77
+ # flags.api-version.summary
78
+
79
+ Target API version for the preview.
80
+
81
+ # flags.api-version.description
82
+
83
+ Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.
84
+
85
+ # error.Conflicts
86
+
87
+ There are changes in the org that conflict with the local changes you're trying to preview.
88
+
89
+ # error.Conflicts.Actions
90
+
91
+ - To overwrite the remote changes, rerun this command with the --ignore-conflicts flag.
92
+
93
+ - To overwrite the local changes, run the "sf retrieve metadata" command with the --ignore-conflicts flag.
@@ -104,7 +104,7 @@ Target API version for the validation.
104
104
 
105
105
  # flags.api-version.description
106
106
 
107
- Use this flag to override the default API version, which is the latest version supported the CLI, with the API version in your package.xml file.
107
+ Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.
108
108
 
109
109
  # flags.async.summary
110
110
 
@@ -0,0 +1,39 @@
1
+ # conflicts.none
2
+
3
+ No conflicts found.
4
+
5
+ # conflicts.header
6
+
7
+ Conflicts [%s]. Run the command with the --ignore-conflicts flag to override.
8
+
9
+ # ignored.none
10
+
11
+ No files were ignored. Update your your .forceignore file if you want to ignore certain files.
12
+
13
+ # ignored.header
14
+
15
+ Ignored [%s] files. These files won't %s because they're ignored by your .forceignore file.
16
+
17
+ # deploy.header
18
+
19
+ Will Deploy [%s] files.
20
+
21
+ # deploy.none
22
+
23
+ No files will be deployed.
24
+
25
+ # retrieve.header
26
+
27
+ Will Retrieve [%s] files.
28
+
29
+ # retrieve.none
30
+
31
+ No files will be retrieved.
32
+
33
+ # delete.header
34
+
35
+ Will Delete [%s] files.
36
+
37
+ # delete.none
38
+
39
+ No files will be deleted.
@@ -0,0 +1,59 @@
1
+ # summary
2
+
3
+ Preview a retrieval to see what will be retrieved from the org, the potential conflicts, and the ignored files.
4
+
5
+ # description
6
+
7
+ You must run this command from within a project.
8
+
9
+ The command outputs a table that describes what will happen if you run the "sf retrieve metadata" 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
+
11
+ If your org allows source tracking, then this command considers conflicts between the org and local. Some orgs, such as production orgs, never allow source tracking. Use the "--no-track-source" flag when you create a scratch or sandbox org to disable source tracking.
12
+
13
+ # examples
14
+
15
+ - Preview the retrieve of all changes from the org:
16
+
17
+ <%= config.bin %> <%= command.id %>
18
+
19
+ - Preview the retrieve when ignoring any conflicts:
20
+
21
+ <%= config.bin %> <%= command.id %> --ignore-conflicts
22
+
23
+ # flags.target-org.summary
24
+
25
+ Login username or alias for the target org.
26
+
27
+ # flags.target-org.description
28
+
29
+ Overrides your default org.
30
+
31
+ # flags.ignore-conflicts.summary
32
+
33
+ Ignore conflicts and preview the retrieve of remote components, even if they will overwrite local changes.
34
+
35
+ # flags.ignore-conflicts.description
36
+
37
+ This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as production orgs.
38
+
39
+ # flags.concise.summary
40
+
41
+ Omit ignored files.
42
+
43
+ # flags.api-version.summary
44
+
45
+ Target API version for the deploy.
46
+
47
+ # flags.api-version.description
48
+
49
+ Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.
50
+
51
+ # error.Conflicts
52
+
53
+ There are local changes that conflict with the remote changes that would be retrieved.
54
+
55
+ # error.Conflicts.Actions
56
+
57
+ - To overwrite the remote changes, run the "sf deploy metadata" command with the --ignore-conflicts flag.
58
+
59
+ - To overwrite the local changes, run the "sf retrieve metadata" command with the --ignore-conflicts flag.