This repository has been archived by the owner on Jan 14, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 15
/
projectBuilder.js
291 lines (253 loc) · 10.2 KB
/
projectBuilder.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
'use strict';
var path = require('path');
var Q = require('q');
var CustomError = require('./customError'),
fileTools = require('./fileTools'),
log = require('./log'),
manifestTools = require('./manifestTools'),
platformTools = require('./platformTools'),
projectTools = require('./projectTools'),
utils = require('./utils'),
constants = require('./constants'),
validationConstants = require('./constants').validation;
function processPlatformTasks (tasks) {
return Q.allSettled(tasks).then(function (results) {
var result = results.reduce(function (success, result) {
if (result.state !== 'fulfilled') {
log.error(result.reason.getMessage());
return false;
}
return success;
}, true);
if (!result) {
return Q.reject(new Error('One or more platforms could not be generated successfully.'));
} else {
return Q.resolve(results.map(function(result) {
return result.value;
}));
}
});
}
function validateManifest(w3cManifestInfo, platformModules, platforms) {
return manifestTools.applyValidationRules(w3cManifestInfo, platformModules, platforms).then(function (validationResults) {
// output validation results
var invalidManifest = false;
var maxLenSeverity = 10;
validationResults.forEach(function (result) {
var severity = result.level.toUpperCase();
var validationMessage = 'Manifest validation ' + severity + new Array(Math.max(maxLenSeverity - severity.length + 1, 0)).join(' ') + ' - ' + result.description + '(member: ' + result.member + ').';
if (result.level === validationConstants.levels.suggestion || result.level === validationConstants.levels.warning) {
log.warn(validationMessage, result.platform);
} else if (result.level === validationConstants.levels.error) {
log.error(validationMessage, result.platform);
invalidManifest = true;
}
});
// report manifest validation errors
if (invalidManifest) {
return Q.reject(new Error('The manifest is not valid. Review the validation messages above for additional information.'));
}
});
}
function generateImages(w3cManifestInfo, options, callback) {
if (options.image) {
return fileTools.readFile(options.image).then(function (fileContent) {
return manifestTools.generateImagesForManifest(fileContent, w3cManifestInfo.content).then(function (updatedManifest) {
w3cManifestInfo.content = updatedManifest;
options.assets = options.assets || [];
options.assets.push({
fileName: path.basename(options.image),
data: fileContent
});
return Q.resolve();
});
}).nodeify(callback);
}
return Q.resolve.nodeify(callback);
}
function copyAssets(assets, generatedAppDir, callback) {
if (assets && assets instanceof Array && assets.length > 0) {
var assetsDir = path.join(generatedAppDir, constants.ASSETS_FOLDER);
return fileTools.mkdirp(assetsDir).then(function () {
var tasks = assets.map(function (asset) {
log.debug('Copying asset \'' + asset.fileName + '\' to the \'' + assetsDir + '\' folder...');
return fileTools.writeFile(path.join(assetsDir, asset.fileName), asset.data);
});
return Q.all(tasks);
}).nodeify(callback);
}
return Q.resolve().nodeify(callback);
}
function createApps (w3cManifestInfo, rootDir, platforms, options, href, callback) {
// validate arguments
if (arguments.length < 3) {
return Q.reject(new Error('One or more required arguments are missing.')).nodeify(callback);
}
if (arguments.length === 4) {
if (utils.isFunction(options)) {
callback = options;
options = {};
}
}
if (!href) {
href = '/';
}
// determine the path where the app will be created
options.appName = utils.sanitizeName(w3cManifestInfo.content.short_name);
var generatedAppDir = path.join(rootDir, options.appName);
// Add timestamp to manifest information for telemetry purposes only
w3cManifestInfo.timestamp = new Date().toISOString().replace(/T/, ' ').replace(/\.[0-9]+/, ' ');
// create app directory
return fileTools.mkdirp(generatedAppDir).then(function () {
// load the platform modules
return platformTools.loadPlatforms(platforms);
})
.then(function (platformModules) {
// validate the manifest
return validateManifest(w3cManifestInfo, platformModules, platforms).thenResolve(platformModules);
})
.then(function (platformModules) {
// generate missing icons
return generateImages(w3cManifestInfo, options).thenResolve(platformModules);
})
.then(function (platformModules) {
// create apps for each platform
var tasks = platformModules.map(function (platform) {
if (platform) {
log.debug('Creating the \'' + platform.name + '\' app...');
return Q.resolve(generatedAppDir).then(function(generatedAppOutputDir) {
return fileTools.mkdirp(generatedAppOutputDir).then(function() {
var w3cManifestInfoCopy = JSON.parse(JSON.stringify(w3cManifestInfo));
return Q.ninvoke(platform, 'create', w3cManifestInfoCopy, generatedAppOutputDir, options, href).then(function () {
log.info('The ' + platform.name + ' app was created successfully!');
})
.catch(function (err) {
return Q.reject(new CustomError('Failed to create the ' + platform.name + ' app.', err));
});
});
});
}
return Q.resolve();
});
return processPlatformTasks(tasks);
})
.then(function () {
// copy assets to the assets folder
return copyAssets(options.assets, generatedAppDir);
})
// return path to project folder
.thenResolve(generatedAppDir)
.nodeify(callback);
}
function packageApps (platforms, dir, options, callback) {
// validate arguments
if (arguments.length < 2) {
return Q.reject(new Error('One or more required arguments are missing.')).nodeify(callback);
}
if (arguments.length === 3) {
if (utils.isFunction(options)) {
callback = options;
options = {};
}
}
// find the root of the project
return projectTools.getProjectRoot(dir && path.resolve(dir) || process.cwd()).then(function (rootDir) {
if (!rootDir) {
return Q.reject(new Error('The specified directory does not appear to contain a valid pwabuilder project.'));
}
// load all platforms specified in the command line
return platformTools.loadPlatforms(platforms).then(function (platformModules) {
// package apps for each platform
var tasks = platformModules.map(function (platform) {
if (platform) {
log.debug('Packaging the \'' + platform.name + '\' app...');
return Q.resolve(rootDir).then(function(rootOutputDir) {
return Q.ninvoke(platform, 'package', rootOutputDir, options).then(function (path) {
log.info('The ' + platform.name + ' app was packaged successfully!');
return Q.resolve(path);
})
.catch (function (err) {
return Q.reject(new CustomError('Failed to package the ' + platform.name + ' app.', err));
});
});
} else {
return Q.resolve();
}
});
return processPlatformTasks(tasks);
});
})
.nodeify(callback);
}
function runApp (platformId, dir, options, callback) {
// validate arguments
if (arguments.length < 2) {
return Q.reject(new Error('One or more required arguments are missing.')).nodeify(callback);
}
if (arguments.length === 3) {
if (utils.isFunction(options)) {
callback = options;
options = {};
}
}
// find the root of the project
return projectTools.getProjectRoot(dir && path.resolve(dir) || process.cwd()).then(function (rootDir) {
if (!rootDir) {
return Q.reject(new Error('The specified directory does not appear to contain a valid pwabuilder project.'));
}
// load the specified platform
return platformTools.loadPlatforms([platformId]).then(function (platformModules) {
// run the app for the platform
if (platformModules && platformModules.length > 0) {
var platform = platformModules[0];
log.debug('Launching the \'' + platform.name + '\' app ...');
return Q.resolve(rootDir).then(function(rootOutputDir) {
return Q.ninvoke(platform, 'run', rootOutputDir, options).catch(function (err) {
return Q.reject(new CustomError('Failed to launch the ' + platform.name + ' app.', err));
});
});
}
return Q.resolve();
});
})
.nodeify(callback);
}
function openApp (platformId, dir, options, callback) {
// validate arguments
if (arguments.length < 2) {
return Q.reject(new Error('One or more required arguments are missing.')).nodeify(callback);
}
if (arguments.length === 3) {
if (utils.isFunction(options)) {
callback = options;
options = {};
}
}
// find the root of the project
return projectTools.getProjectRoot(dir && path.resolve(dir) || process.cwd()).then(function (rootDir) {
if (!rootDir) {
return Q.reject(new Error('The specified directory does not appear to contain a valid pwabuilder project.'));
}
// load the specified platform
return platformTools.loadPlatforms([platformId]).then(function (platformModules) {
// open the app for the platform
if (platformModules && platformModules.length > 0) {
var platform = platformModules[0];
log.debug('Opening the \'' + platform.name + '\' app...');
return Q.resolve(rootDir).then(function(rootOutputDir) {
return Q.ninvoke(platform, 'open', rootOutputDir, options).catch(function (err) {
return Q.reject(new CustomError('Failed to open the ' + platform.name + ' app.', err));
});
});
}
return Q.resolve();
});
})
.nodeify(callback);
}
module.exports = {
createApps: createApps,
packageApps: packageApps,
runApp: runApp,
openApp: openApp
};