/
cleanup.ts
202 lines (175 loc) · 7.1 KB
/
cleanup.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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
/*
* Copyright (c) 2022, jayree
* 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 { CLIError } from '@oclif/core/lib/parser/errors.js';
import chalk from 'chalk';
import fs from 'fs-extra';
import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
import { ensureArray } from '@salesforce/kit';
import { PackageTypeMembers } from '@salesforce/source-deploy-retrieve';
import { XMLParser, XMLBuilder } from 'fast-xml-parser';
import { XML_DECL, XML_NS_KEY, XML_NS_URL } from '@salesforce/source-deploy-retrieve/lib/src/common/index.js';
Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
const messages = Messages.loadMessages('@jayree/sfdx-plugin-manifest', 'manifestcleanup');
interface PackageManifestObject {
Package: {
types: PackageTypeMembers[];
version: string;
[XML_NS_KEY]?: string;
};
}
export default class CleanupManifest extends SfCommand<void> {
public static readonly summary = messages.getMessage('summary');
public static readonly description = messages.getMessage('description');
public static readonly examples = messages.getMessages('examples');
public static readonly requiresProject = true;
public static readonly flags = {
manifest: Flags.file({
char: 'x',
summary: messages.getMessage('flags.manifest.summary'),
}),
file: Flags.file({
char: 'f',
required: true,
summary: messages.getMessage('flags.file.summary'),
}),
};
public async run(): Promise<void> {
const { flags } = await this.parse(CleanupManifest);
const file = flags['file'];
if (!(await fs.pathExists(file))) {
await fs.ensureFile(file);
await fs.writeFile(
file,
`<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<name>Audience</name>
<!--Remove all members/the entire type-->
<members>*</members>
</types>
<types>
<name>SharingRules</name>
<!--Remove specified members from type-->
<members>VideoCall</members>
<!--Remove all members starting with Video from type-->
<members>Video*</members>
</types>
<types>
<name>Report</name>
<!--Remove all members from type, but keep members: MyFolder, MyFolder/MyReport. If you don't need all your reports in your repository-->
<members>*</members>
<members>MyFolder</members>
<members>MyFolder/MyReport</members>
</types>
<types>
<name>CustomObjectTranslation</name>
<!--Remove all members from type, but keep members ending with -de. If you don't want to store all CustomObjectTranslation in your repository-->
<members>*</members>
<members>*-de</members>
</types>
<types>
<name>CustomObject</name>
<!--Add members ObjectName1, ObjectName2. If you have used 'excludemanaged' with 'jayree:manifest:generate' to re-add required managed components-->
<members>!ObjectName1</members>
<members>!ObjectName2</members>
</types>
<version>52.0</version>
</Package>
`,
);
this.log(`Cleanup manifest file template '${file}' was created`);
} else {
if (!flags['manifest'] || !(await fs.pathExists(flags['manifest']))) {
throw new CLIError(`The following error occurred:\n ${chalk.dim('Missing required flag manifest')}`);
}
await this.cleanupManifestFile(flags['manifest'], file);
}
return;
}
private async cleanupManifestFile(manifest: string, ignoreManifest: string): Promise<void> {
const { packageTypeMembers: manifestTypeMembers, version } = parseManifest(fs.readFileSync(manifest, 'utf8'));
this.log(`apply '${ignoreManifest}' to '${manifest}'`);
const typeMap = new Map<string, string[]>();
manifestTypeMembers.forEach((value) => {
typeMap.set(value.name, ensureArray(value.members));
});
const { packageTypeMembers: ignoreTypeMembers } = parseManifest(fs.readFileSync(ignoreManifest, 'utf8'));
const resolveWildCard = (name: string, members: string[]): string[] => {
members
.filter((m) => m.includes('*') && m.length > 1)
.forEach((i) => {
members.splice(members.indexOf(i), 1);
const wildCard = i.split('*');
members = members.concat(
typeMap.get(name)?.filter((m) => {
if (wildCard.length === 2) {
if (i.startsWith('*')) {
return m.endsWith(wildCard[1]);
} else if (i.endsWith('*')) {
return m.startsWith(wildCard[0]);
} else {
return m.startsWith(wildCard[0]) && m.endsWith(wildCard[1]);
}
}
}) as string[],
);
});
return members;
};
ignoreTypeMembers.forEach((types) => {
if (!typeMap.get(types.name)) {
typeMap.set(types.name, []);
}
const packageTypeMembers = resolveWildCard(types.name, ensureArray(types.members));
if (packageTypeMembers.includes('*') && packageTypeMembers.length > 1) {
const includemembers = packageTypeMembers.slice();
includemembers.splice(includemembers.indexOf('*'), 1);
const includedmembers = typeMap.get(types.name)?.filter((value) => includemembers.includes(value));
if (includedmembers?.length) {
this.log('include only members ' + includedmembers.toString() + ' for type ' + types.name);
typeMap.set(types.name, includedmembers);
}
}
if (packageTypeMembers.includes('*') && packageTypeMembers.length === 1) {
this.log('exclude all members for type ' + types.name);
typeMap.delete(types.name);
}
if (!packageTypeMembers.includes('*')) {
const includedmembers = typeMap.get(types.name)?.filter((value) => !packageTypeMembers.includes(value));
if (includedmembers) {
typeMap.set(types.name, includedmembers);
}
}
packageTypeMembers.forEach((member) => {
if (member.startsWith('!') && !typeMap.get(types.name)?.includes(member.substring(1))) {
typeMap.get(types.name)?.push(member.substring(1));
}
});
});
const typeMembers: PackageTypeMembers[] = [];
for (const [typeName, members] of typeMap.entries()) {
if (members.length) {
typeMembers.push({ members, name: typeName });
}
}
await fs.writeFile(manifest, js2Manifest({ Package: { types: typeMembers, version } }));
}
}
function parseManifest(xmlData: string): { packageTypeMembers: PackageTypeMembers[]; version: string } {
const parser = new XMLParser({ stopNodes: ['version'], parseTagValue: false });
const {
Package: { types, version },
} = parser.parse(xmlData) as PackageManifestObject;
const packageTypeMembers = ensureArray(types);
return { packageTypeMembers, version };
}
function js2Manifest(jsData: PackageManifestObject): string {
const js2Xml = new XMLBuilder({ format: true, indentBy: ' ', ignoreAttributes: false });
jsData.Package[XML_NS_KEY] = XML_NS_URL;
return XML_DECL.concat(js2Xml.build(jsData) as string);
}