-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.js
432 lines (358 loc) · 9.28 KB
/
index.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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
/**
* @module @nuintun/gulp-css
* @author nuintun
* @license MIT
* @version 3.0.0
* @description A gulp plugin for cmd transport and concat.
* @see https://github.com/nuintun/gulp-css#readme
*/
'use strict';
const gutil = require('@nuintun/gulp-util');
const path = require('path');
const cssDeps = require('@nuintun/css-deps');
const Bundler = require('@nuintun/bundler');
const through = require('@nuintun/through');
/**
* @module lifecycle
* @license MIT
* @version 2018/07/03
*/
const lifecycle = {
moduleDidLoaded: 'moduleDidLoaded',
moduleDidParsed: 'moduleDidParsed',
moduleDidCompleted: 'moduleDidCompleted'
};
const cwd = process.cwd();
const optionsSchemas = {
title: 'gulp-css',
description: 'A gulp plugin for cmd transport and concat.',
type: 'object',
properties: {
root: {
type: 'string',
default: cwd
},
map: {
instanceof: 'Function'
},
combine: {
oneOf: [
{
type: 'boolean'
},
{
instanceof: 'Function'
}
],
default: false,
errorMessage: 'should be boolean or function'
},
onpath: {
instanceof: 'Function'
},
onbundle: {
instanceof: 'Function'
},
plugins: {
type: 'array',
items: {
type: 'object',
properties: {
name: {
type: 'string'
},
moduleDidLoaded: {
instanceof: 'Function',
errorMessage: 'should be function'
},
moduleDidParsed: {
instanceof: 'Function',
errorMessage: 'should be function'
},
moduleDidCompleted: {
instanceof: 'Function',
errorMessage: 'should be function'
}
}
},
default: []
}
},
additionalProperties: false
};
/**
* @module utils
* @license MIT
* @version 2018/03/26
*/
/**
* @function resolve
* @description Resolve a request path
* @param {string} request
* @param {string} referer
* @param {Object} options
* @returns {string}
*/
function resolve(request, referer, options) {
const root = options.root;
if (gutil.isAbsolute(request)) {
request = path.join(root, request);
} else {
request = path.join(path.dirname(referer), request);
if (gutil.isOutBounds(request, root)) {
throw new RangeError(`File ${gutil.normalize(request)} is out of bounds of root.`);
}
}
return request;
}
/**
* @function initOptions
* @param {Object} options
* @returns {Object}
*/
function initOptions(options) {
// Init attrs
gutil.validateOptions(optionsSchemas, options, 'gulp-css');
// Init root and base
options.root = path.resolve(options.root);
// Init files cache
options.cache = new Map();
// Init combine
const combine = options.combine;
const fnCombine = gutil.typpy(combine, Function);
options.combine = module => (fnCombine ? combine(module) : combine);
// Freeze
return Object.freeze(options);
}
/**
* @module css
* @license MIT
* @version 2018/03/26
*/
/**
* @namespace cssPackager
*/
const css = {
/**
* @method parse
* @param {string} path
* @param {string} contents
* @param {Object} options
* @returns {Object}
*/
parse(path, contents, options) {
const root = options.root;
const dependencies = new Set();
const combine = options.combine;
/**
* @function onpath
* @param {string} prop
* @param {string} value
*/
const onpath = (prop, value) => {
value = gutil.isUrl(value) ? value : gutil.normalize(value);
// Get onpath
const onpath = options.onpath;
// Returned value
return onpath ? onpath(prop, value, path) : value;
};
// Parse module
const meta = cssDeps(
contents,
(dependency, media) => {
if (gutil.isUrl(dependency)) {
// Relative file path from cwd
const rpath = JSON.stringify(gutil.path2cwd(path));
// Output warn
gutil.logger.warn(
gutil.chalk.yellow(`Found remote css file ${JSON.stringify(dependency)} at ${rpath}, unsupported.`),
'\x07'
);
} else {
if (media.length) {
// Get media
media = JSON.stringify(media.join(', '));
// Relative file path from cwd
const rpath = JSON.stringify(gutil.path2cwd(path));
// Output warn
gutil.logger.warn(gutil.chalk.yellow(`Found import media queries ${media} at ${rpath}, unsupported.`), '\x07');
}
// Normalize
dependency = gutil.normalize(dependency);
// Resolve dependency
const resolved = resolve(dependency, path, { root });
// Module can read
if (gutil.fsSafeAccess(resolved)) {
dependencies.add(resolved);
} else {
// Relative file path from cwd
const rpath = JSON.stringify(gutil.path2cwd(path));
// Output warn
gutil.logger.warn(gutil.chalk.yellow(`Module ${JSON.stringify(dependency)} at ${rpath} can't be found.`), '\x07');
}
// Parse map
dependency = gutil.parseMap(dependency, resolved, options.map);
dependency = gutil.normalize(dependency);
}
return combine(path) ? false : dependency;
},
{ onpath, media: true }
);
// Get contents
contents = meta.code;
return { dependencies, contents };
}
};
/**
* @module index
* @license MIT
* @version 2018/03/26
*/
const packagers = /*#__PURE__*/Object.freeze({
__proto__: null,
css: css
});
/**
* @module parser
* @license MIT
* @version 2018/03/30
*/
/**
* @function parser
* @param {Vinyl} vinyl
* @param {Object} options
* @returns {Object}
*/
async function parser(vinyl, options) {
let path = vinyl.path;
let dependencies = new Set();
let contents = vinyl.contents;
const ext = vinyl.extname.slice(1).toLowerCase();
const packager = packagers[ext];
if (packager) {
const root = options.root;
const plugins = options.plugins;
// Get code
contents = contents.toString();
// Execute did load hook
contents = await gutil.pipeline(plugins, lifecycle.moduleDidLoaded, path, contents, { root });
// Parse metadata
const meta = await packager.parse(path, contents, options);
// Override dependencies
dependencies = meta.dependencies;
// Override contents
contents = meta.contents.toString();
// Execute did parse hook
contents = await gutil.pipeline(plugins, lifecycle.moduleDidParsed, path, contents, { root });
// Execute did complete hook
contents = await gutil.pipeline(plugins, lifecycle.moduleDidCompleted, path, contents, { root });
// To buffer
contents = Buffer.from(contents);
}
return { path, dependencies, contents };
}
/**
* @module bundler
* @license MIT
* @version 2018/03/26
*/
/**
* @function oncycle
* @param {string} path
* @param {string} referrer
*/
function oncycle(path, referrer) {
path = JSON.stringify(gutil.path2cwd(path));
referrer = JSON.stringify(gutil.path2cwd(referrer));
gutil.logger.error(gutil.chalk.red(`Found circular dependency ${path} in ${referrer}`), '\x07');
}
/**
* @function bundler
* @param {Vinyl} vinyl
* @param {Object} options
* @returns {Vinyl}
*/
async function bundler(vinyl, options) {
const input = vinyl.path;
const cache = options.cache;
// Is combine
const combine = options.combine(input);
// Bundler
const bundles = await new Bundler({
oncycle,
resolve: path => path,
parse: async path => {
let meta;
// Is entry file
const entry = input === path;
// Hit cache
if (cache.has(path)) {
meta = cache.get(path);
} else {
const file = entry ? vinyl : await gutil.fetchModule(path, options);
// Execute parser
meta = await parser(file, options);
// Set cache
cache.set(path, meta);
}
// Override path
path = meta.path;
// Get meta
const contents = meta.contents;
const dependencies = combine ? Array.from(meta.dependencies) : [];
// If is entry file override file path
if (entry) vinyl.path = path;
// Return meta
return { path, dependencies, contents };
}
}).parse(input);
// Exec onbundle
options.onbundle && options.onbundle(input, bundles);
// Combine files
vinyl.contents = gutil.combine(bundles);
return vinyl;
}
/**
* @module index
* @license MIT
* @version 2018/03/26
*/
/**
* @function main
* @param {Object} options
*/
function main(options) {
options = initOptions(options);
// Stream
return through(
async function (vinyl, encoding, next) {
vinyl = gutil.VinylFile.wrap(vinyl);
// Throw error if stream vinyl
if (vinyl.isStream()) {
return next(new TypeError('Streaming not supported.'));
}
// Return empty vinyl
if (vinyl.isNull()) {
return next(null, vinyl);
}
// Bundler
try {
vinyl = await bundler(vinyl, options);
} catch (error) {
return next(error);
}
// Next
next(null, vinyl);
},
function (next) {
// Clear cache
options.cache.clear();
// Next
next();
}
);
}
// Exports
main.chalk = gutil.chalk;
main.logger = gutil.logger;
module.exports = main;