This repository has been archived by the owner on Dec 12, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9
/
package.js
342 lines (283 loc) · 10.6 KB
/
package.js
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
var through = require('through2');
var gutil = require('gulp-util');
var path = require('path');
var fs = require('fs');
var check = require('validator');
var shell = require('shelljs');
var Q = require('q');
var os = require('os');
var exec = require('child_process').exec;
var _strRelPath = path.join('Strings', 'resources.resjson', 'en-US');
var _tempPath = path.join(__dirname, '_temp');
shell.mkdir('-p', _tempPath);
var createError = function(msg) {
return new gutil.PluginError('PackageTask', msg);
}
var validateModule = function(folderName, module) {
var defer = Q.defer();
defer.resolve();
return defer.promise;
}
var validateTask = function(folderName, task) {
var defer = Q.defer();
var vn = (task.name || folderName);
if (!task.id || !check.isUUID(task.id)) {
defer.reject(createError(vn + ': id is a required guid'));
};
if (!task.name || !check.isAlphanumeric(task.name)) {
defer.reject(createError(vn + ': name is a required alphanumeric string'));
}
if (!task.friendlyName || !check.isLength(task.friendlyName, 1, 40)) {
defer.reject(createError(vn + ': friendlyName is a required string <= 40 chars'));
}
if (!task.instanceNameFormat) {
defer.reject(createError(vn + ': instanceNameFormat is required'));
}
// resolve if not already rejected
defer.resolve();
return defer.promise;
};
var LOC_FRIENDLYNAME = 'loc.friendlyName';
var LOC_HELPMARKDOWN = 'loc.helpMarkDown';
var LOC_DESCRIPTION = 'loc.description';
var LOC_INSTFORMAT = 'loc.instanceNameFormat';
var LOC_GROUPDISPLAYNAME = 'loc.group.displayName.';
var LOC_INPUTLABEL = 'loc.input.label.';
var LOC_INPUTHELP = 'loc.input.help.';
var LOC_MESSAGES = 'loc.messages.';
var createStrings = function(task, pkgPath, srcPath) {
var defer = Q.defer();
var strPath = path.join(pkgPath, _strRelPath);
shell.mkdir('-p', strPath);
var srcStrPath = path.join(srcPath, _strRelPath);
shell.mkdir('-p', srcStrPath);
//
// Loc tasks.json and product strings content
//
var strings = {};
strings[LOC_FRIENDLYNAME] = task.friendlyName;
task['friendlyName'] = 'ms-resource:' + LOC_FRIENDLYNAME;
strings[LOC_HELPMARKDOWN] = task.helpMarkDown;
task['helpMarkDown'] = 'ms-resource:' + LOC_HELPMARKDOWN;
strings[LOC_DESCRIPTION] = task.description;
task['description'] = 'ms-resource:' + LOC_DESCRIPTION;
strings[LOC_INSTFORMAT] = task.instanceNameFormat;
task['instanceNameFormat'] = 'ms-resource:' + LOC_INSTFORMAT;
if (task.groups) {
task.groups.forEach(function(group) {
if (group.name) {
var key = LOC_GROUPDISPLAYNAME + group.name;
strings[key] = group.displayName;
group.displayName = 'ms-resource:' + key;
}
});
}
if (task.inputs) {
task.inputs.forEach(function(input) {
if (input.name) {
var labelKey = LOC_INPUTLABEL + input.name;
strings[labelKey] = input.label;
input.label = 'ms-resource:' + labelKey;
if (input.helpMarkDown) {
var helpKey = LOC_INPUTHELP + input.name;
strings[helpKey] = input.helpMarkDown;
input.helpMarkDown = 'ms-resource:' + helpKey;
}
}
});
}
if (task.messages) {
for(var key in task.messages) {
var messageKey = LOC_MESSAGES + key;
strings[messageKey] = task.messages[key];
task.messages[key] = 'ms-resource:' + messageKey;
}
}
//
// Write the tasks.json and strings file in package and back to source
//
var enPath = path.join(strPath, 'resources.resjson');
var enSrcPath = path.join(srcStrPath, 'resources.resjson');
var enContents = JSON.stringify(strings, null, 2);
fs.writeFile(enPath, enContents, function(err) {
if (err) {
defer.reject(createError('could not create: ' + enPath + ' - ' + err.message));
return;
}
var taskPath = path.join(pkgPath, 'task.loc.json');
var contents = JSON.stringify(task, null, 2);
fs.writeFile(taskPath, contents, function(err) {
if (err) {
defer.reject(createError('could not create: ' + taskPath + ' - ' + err.message));
return;
}
// copy the loc assets back to the src so they can be checked in
shell.cp('-f', enPath, enSrcPath);
shell.cp('-f', taskPath, path.join(srcPath, 'task.loc.json'));
defer.resolve();
});
})
return defer.promise;
};
function locCommon() {
return through.obj(
function(moduleJson, encoding, done) {
// Validate the module.json file exists.
if (!fs.existsSync(moduleJson)) {
new gutil.PluginError('PackageModule', 'Module json cannot be found: ' + moduleJson.path);
}
if (moduleJson.isNull() || moduleJson.isDirectory()) {
this.push(moduleJson);
return callback();
}
// Deserialize the module.json.
var jsonContents = moduleJson.contents.toString();
var module = { };
try {
module = JSON.parse(jsonContents);
}
catch (err) {
done(createError('Common module ' + moduleJson.path + ' parse error: ' + err.message));
return;
}
// Build the content for the en-US resjson file.
var strPath = path.join(path.dirname(moduleJson.path), _strRelPath);
shell.mkdir('-p', strPath);
var strings = { };
if (module.messages) {
for (var key in module.messages) {
var messageKey = LOC_MESSAGES + key;
strings[messageKey] = module.messages[key];
}
}
// Create the en-US resjson file.
var enPath = path.join(strPath, 'resources.resjson');
var enContents = JSON.stringify(strings, null, 2);
fs.writeFile(enPath, enContents, function(err) {
if (err) {
done(createError('Could not create: ' + enPath + ' - ' + err.message));
return;
}
})
done();
});
}
function packageVsix(vsixPath, manifestDir) {
var defer = Q.defer();
shell.mkdir('-p', vsixPath);
shell.pushd(manifestDir);
var manifest = "extension-manifest.json";
var tfx = path.join(__dirname, 'node_modules', 'tfx-cli', '_build', 'app', 'app.js');
var commandLine = "node " + tfx + " extension create --manifest-globs " + manifest;
console.log("Running: " + commandLine);
exec(commandLine, function(err, stdout, stderr) {
if (err) {
shell.popd();
defer.reject(err);
return;
}
if (stdout) {
gutil.log(stdout);
}
if (stderr) {
gutil.log(stderr);
}
shell.mv('-f', "*.vsix", vsixPath);
shell.popd();
defer.resolve();
});
return defer.promise;
}
function packageTask(pkgPath, commonDeps, commonSrc){
return through.obj(
function(taskJson, encoding, done) {
if (!fs.existsSync(taskJson)) {
new gutil.PluginError('PackageTask', 'Task json cannot be found: ' + taskJson.path);
}
if (taskJson.isNull() || taskJson.isDirectory()) {
this.push(taskJson);
return callback();
}
var dirName = path.dirname(taskJson.path);
var folderName = path.basename(dirName);
var jsonContents = taskJson.contents.toString();
var extensionPath = path.dirname(dirName);
var vsixPath= path.join(path.dirname(pkgPath), "Package");
var task = {};
try {
task = JSON.parse(jsonContents);
}
catch (err) {
done(createError(folderName + ' parse error: ' + err.message));
return;
}
var tgtPath;
validateTask(folderName, task)
.then(function() {
// Copy the task to the layout folder.
gutil.log('Packaging: ' + task.name);
tgtPath = path.join(pkgPath, task.name);
shell.mkdir('-p', tgtPath);
shell.cp('-R', path.join(dirName, '*'), tgtPath);
shell.rm(path.join(tgtPath, '*.csproj'));
shell.rm(path.join(tgtPath, '*.md'));
// Build a list of external task lib dependencies.
var externals = require('./externals.json');
var libDeps = [ ];
if (task.execution['Node']) {
libDeps.push({
"name": "vsts-task-lib",
"src": "node_modules",
"dest": "node_modules"
});
}
if (task.execution['PowerShell3']) {
libDeps.push({
"name": "vsts-task-sdk",
"src": path.join("node_modules", "vsts-task-sdk", "VstsTaskSdk"),
"dest": path.join("ps_modules", "VstsTaskSdk")
});
}
// Statically link the required external task libs.
libDeps.forEach(function (libDep) {
var libVer = externals[libDep.name];
if (!libVer) {
throw new Error('External ' + libDep.name + ' not defined in externals.json.');
}
gutil.log('Linking ' + libDep.name + ' ' + libVer + ' into ' + task.name);
var tskLibSrc = path.join(__dirname, '_temp', libDep.name, libVer, libDep.src);
if (shell.test('-d', tskLibSrc)) {
new gutil.PluginError('PackageTask', libDep.name + ' not found: ' + tskLibSrc);
}
var dest = path.join(tgtPath, libDep.dest)
shell.mkdir('-p', dest);
shell.cp('-R', path.join(tskLibSrc, '*'), dest);
})
// Statically link the required internal common modules.
var taskDeps;
if ((taskDeps = commonDeps[task.name])) {
taskDeps.forEach(function (dep) {
console.log("remove me -- "+ dep);
gutil.log('Linking ' + dep.module + ' into ' + task.name);
var src = path.join(commonSrc, dep.module);
var dest = path.join(tgtPath, dep.dest);
shell.mkdir('-p', dest);
shell.cp('-R', src, dest);
})
}
return;
})
.then(function() {
return createStrings(task, tgtPath, dirName);
})
.then(function() {
done();
})
.fail(function(err) {
done(err);
})
});
}
exports.LocCommon = locCommon;
exports.PackageTask = packageTask;
exports.PackageVsix = packageVsix;