generated from salesforcecli/plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 15
/
preview.ts
99 lines (88 loc) · 3.75 KB
/
preview.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
/*
* Copyright (c) 2022, salesforce.com, inc.
* All rights reserved.
* Licensed under the BSD 3-Clause license.
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
*/
import { Messages } from '@salesforce/core';
import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
import { SourceTracking } from '@salesforce/source-tracking';
import { ForceIgnore } from '@salesforce/source-deploy-retrieve';
import { buildComponentSet } from '../../../utils/deploy.js';
import { PreviewResult, printTables, compileResults, getConflictFiles } from '../../../utils/previewOutput.js';
Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
const messages = Messages.loadMessages('@salesforce/plugin-deploy-retrieve', 'deploy.metadata.preview');
const exclusiveFlags = ['manifest', 'source-dir', 'metadata'];
export default class DeployMetadataPreview extends SfCommand<PreviewResult> {
public static readonly description = messages.getMessage('description');
public static readonly summary = messages.getMessage('summary');
public static readonly examples = messages.getMessages('examples');
public static readonly requiresProject = true;
public static readonly aliases = ['deploy:metadata:preview'];
public static readonly deprecateAliases = true;
public static readonly flags = {
'ignore-conflicts': Flags.boolean({
char: 'c',
summary: messages.getMessage('flags.ignore-conflicts.summary'),
description: messages.getMessage('flags.ignore-conflicts.description'),
default: false,
}),
manifest: Flags.file({
char: 'x',
description: messages.getMessage('flags.manifest.description'),
summary: messages.getMessage('flags.manifest.summary'),
exclusive: exclusiveFlags.filter((f) => f !== 'manifest'),
exists: true,
}),
metadata: Flags.string({
char: 'm',
summary: messages.getMessage('flags.metadata.summary'),
multiple: true,
exclusive: exclusiveFlags.filter((f) => f !== 'metadata'),
}),
'source-dir': Flags.string({
char: 'd',
description: messages.getMessage('flags.source-dir.description'),
summary: messages.getMessage('flags.source-dir.summary'),
multiple: true,
exclusive: exclusiveFlags.filter((f) => f !== 'source-dir'),
}),
'target-org': Flags.requiredOrg(),
concise: Flags.boolean({
summary: messages.getMessage('flags.concise.summary'),
default: false,
}),
};
public async run(): Promise<PreviewResult> {
const { flags } = await this.parse(DeployMetadataPreview);
const deploySpecified = [flags.manifest, flags.metadata, flags['source-dir']].some((f) => f !== undefined);
const forceIgnore = ForceIgnore.findAndCreate(this.project!.getDefaultPackage().path);
// we'll need STL both to check conflicts and to get the list of local changes if no flags are provided
const stl =
flags['ignore-conflicts'] && deploySpecified
? undefined
: await SourceTracking.create({
org: flags['target-org'],
project: this.project!,
});
if (stl) {
// This helps prevent a race condition when the status is being generated for the first time
await stl.ensureLocalTracking();
}
const [componentSet, filesWithConflicts] = await Promise.all([
buildComponentSet({ ...flags, 'target-org': flags['target-org'].getUsername() }, stl),
getConflictFiles(stl, flags['ignore-conflicts']),
]);
const output = compileResults({
componentSet,
projectPath: this.project!.getPath(),
filesWithConflicts,
forceIgnore,
baseOperation: 'deploy',
});
if (!this.jsonEnabled()) {
printTables(output, 'deploy', flags.concise);
}
return output;
}
}