-
Notifications
You must be signed in to change notification settings - Fork 54
/
build-flow.js
1015 lines (971 loc) · 37.2 KB
/
build-flow.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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
'use strict';
/**
* BuildFlow
* =========
*/
const EOL = require('os').EOL;
const inherit = require('inherit');
const Vow = require('vow');
const vowFs = require('./fs/async-fs');
const BaseTech = require('./tech/base-tech');
/**
* Связь технологии с результатом выполнения другой цели.
*/
const BuildFlowLinkToTargetResult = inherit({
/**
* @param {String} targetOptionName
* @param {String} defaultTargetName
*/
__constructor(targetOptionName, defaultTargetName) {
this._targetOptionName = targetOptionName;
this._defaultTargetName = defaultTargetName;
this._fieldName = `_${targetOptionName}`;
},
/**
* Возвращает имя опции для данной связи.
*
* @returns {String}
*/
getTargetOptionName() {
return this._targetOptionName;
},
/**
* Сохраняет размаскированное имя цели в поле в инстанции технологии.
*
* @param {Tech} tech
* @param {Node} node
*/
configureUsages(tech, node) {
tech[this._fieldName] = node.unmaskTargetName(
tech._preprocessTargetName(tech.getOption(this._targetOptionName, this._defaultTargetName))
);
},
/**
* Проверяет валидность кэша.
*
* @param {Tech} tech
* @param {Node} node
* @param {Cache} cache
* @returns {Boolean}
*/
isCacheValid(tech, node, cache) {
const targetName = tech[this._fieldName];
const targetPath = node.resolvePath(targetName);
return !cache.needRebuildFile(`target:${targetName}`, targetPath);
},
/**
* Сохраняет в кэш информацию об использованных файлах.
*
* @param {Tech} tech
* @param {Node} node
* @param {Cache} cache
*/
saveCache(tech, node, cache) {
const targetName = tech[this._fieldName];
const targetPath = node.resolvePath(targetName);
cache.cacheFileInfo(`target:${targetName}`, targetPath);
},
/**
* Требует у ноды выполнения необходимой цели.
* @param {Tech} tech
* @param {Node} node
* @returns {Promise}
*/
requireTarget(tech, node) {
const processTargetResult = this._processTargetResult;
return node.requireSources([tech[this._fieldName]])
.spread(result => processTargetResult.call(this, tech, node, result));
},
/**
* Возвращает имя поля, в которое связь пишет имя цели.
*
* @returns {String}
*/
getFieldName() {
return this._fieldName;
},
_processTargetResult(tech, node, result) {
return result;
}
});
/**
* Связь технологии с другой целью без получения результата.
*/
const BuildFlowLinkToTargetNoResult = inherit(BuildFlowLinkToTargetResult, {
_processTargetResult() {
return '';
}
});
/**
* Связь технологии с абсолютным путем к другой цели.
*/
const BuildFlowLinkToTargetFilename = inherit(BuildFlowLinkToTargetResult, {
_processTargetResult(tech, node) {
return node.resolvePath(tech[this._fieldName]);
}
});
/**
* Связь технологии с текстовым содержимым файла другой цели.
*/
const BuildFlowLinkToTargetSource = inherit(BuildFlowLinkToTargetResult, {
_processTargetResult(tech, node) {
return vowFs.read(node.resolvePath(tech[this._fieldName]), 'utf8');
}
});
/**
* Связь технологии со списком файлов (префиксами).
*/
const BuildFlowLinkToFileList = inherit(BuildFlowLinkToTargetResult, {
/**
* @param {String} targetOptionName
* @param {String} defaultTargetName
* @param {String|Array} defaultSuffixes
*/
__constructor(targetOptionName, defaultTargetName, defaultSuffixes) {
this._targetOptionName = targetOptionName;
this._defaultTargetName = defaultTargetName;
this._fieldName = `_${targetOptionName}`;
this._listName = `_list${targetOptionName}`;
this._suffixesOptionName = 'sourceSuffixes';
this._defaultSuffixes = defaultSuffixes;
},
/**
* Возвращает имя опции для данной связи.
*
* @returns {String}
*/
getTargetOptionName() {
return this._targetOptionName;
},
/**
* Проверяет валидность кэша.
*
* @param {Tech} tech
* @param {Node} node
* @param {Cache} cache
* @returns {Boolean}
*/
isCacheValid(tech, node, cache) {
const targetName = tech[this._fieldName];
return !cache.needRebuildFileList(`target:${targetName}`, tech[this._listName]);
},
/**
* Сохраняет в кэш информацию об использованных файлах.
*
* @param {Tech} tech
* @param {Node} node
* @param {Cache} cache
* @returns {undefined}
*/
saveCache(tech, node, cache) {
const targetName = tech[this._fieldName];
return cache.cacheFileList(`target:${targetName}`, tech[this._listName]);
},
_processTargetResult(tech, node, result) {
let suffixes = tech.getOption(this._suffixesOptionName) || this._defaultSuffixes;
suffixes = (Array.isArray(suffixes) ? suffixes : [suffixes]);
tech[this._listName] = result.getBySuffix(suffixes);
return tech[this._listName];
}
});
/**
* Связь технологии со списком директорий (префиксами).
*/
const BuildFlowLinkToDirList = inherit(BuildFlowLinkToTargetResult, {
/**
* @param {String} targetOptionName
* @param {String} defaultTargetName
* @param {String|Array} suffixes
*/
__constructor(targetOptionName, defaultTargetName, suffixes) {
this._targetOptionName = targetOptionName;
this._defaultTargetName = defaultTargetName;
this._fieldName = `_${targetOptionName}`;
this._listName = `_list${targetOptionName}`;
this._suffixesOptionName = 'sourceDirSuffixes';
this._suffixes = suffixes;
},
/**
* Возвращает имя опции для данной связи.
*
* @returns {String}
*/
getTargetOptionName() {
return this._targetOptionName;
},
/**
* Проверяет валидность кэша.
*
* @param {Tech} tech
* @param {Node} node
* @param {Cache} cache
* @returns {Boolean}
*/
isCacheValid(tech, node, cache) {
const targetName = tech[this._fieldName];
const files = [].concat.apply([], tech[this._listName].map(dir => dir.files));
return !cache.needRebuildFileList(`target:${targetName}`, files);
},
/**
* Сохраняет в кэш информацию об использованных файлах.
*
* @param {Tech} tech
* @param {Node} node
* @param {Cache} cache
* @returns {undefined}
*/
saveCache(tech, node, cache) {
const targetName = tech[this._fieldName];
const files = [].concat.apply([], tech[this._listName].map(dir => dir.files));
return cache.cacheFileList(`target:${targetName}`, files);
},
_processTargetResult(tech, node, result) {
let suffixes = tech.getOption(this._suffixesOptionName) || this._suffixes;
suffixes = Array.isArray(suffixes) ? suffixes : [suffixes];
tech[this._listName] = result.getBySuffix(suffixes);
return tech[this._listName];
}
});
/**
* Связь технологии со списком целей.
*/
const BuildFlowLinkToTargetList = inherit({
/**
* @param {String} targetOptionName
* @param {String[]} defaultTargetNames
* @param {Function} linkClass
*/
__constructor(targetOptionName, defaultTargetNames, linkClass) {
this._targetOptionName = targetOptionName;
this._defaultTargetNames = defaultTargetNames || [];
this._linkClass = linkClass;
this._fieldName = `_${targetOptionName}`;
this._usagesFieldName = `_usageList_${targetOptionName}`;
},
/**
* Возвращает имя опции для данной связи.
*
* @returns {String}
*/
getTargetOptionName() {
return this._targetOptionName;
},
/**
* Сохраняет размаскированное имя цели в поле в инстанции технологии.
*
* @param {Tech} tech
* @param {Node} node
*/
configureUsages(tech, node) {
const _this = this;
const links = [];
const targetNames = [];
const targetOptionName = this._targetOptionName;
let i = 0;
tech.getOption(this._targetOptionName, this._defaultTargetNames).forEach(targetName => {
const link = new _this._linkClass(`${targetOptionName}[${i}]`, targetName);
link.configureUsages(tech, node);
targetNames.push(tech[link.getFieldName()]);
links.push(link);
i++;
});
tech[this._fieldName] = targetNames;
tech[this._usagesFieldName] = links;
},
/**
* Проверяет валидность кэша.
*
* @param {Tech} tech
* @param {Node} node
* @param {Cache} cache
* @returns {Boolean}
*/
isCacheValid(tech, node, cache) {
const links = tech[this._usagesFieldName];
for (let i = 0, l = links.length; i < l; i++) {
if (!links[i].isCacheValid(tech, node, cache)) {
return false;
}
}
return true;
},
/**
* Сохраняет в кэш информацию об использованных файлах.
*
* @param {Tech} tech
* @param {Node} node
* @param {Cache} cache
*/
saveCache(tech, node, cache) {
tech[this._usagesFieldName].forEach(link => {
link.saveCache(tech, node, cache);
});
},
/**
* Требует у ноды выполнения необходимой цели.
* @param {Tech} tech
* @param {Node} node
* @returns {Promise}
*/
requireTarget(tech, node) {
return Vow.all(tech[this._usagesFieldName].map(link => link.requireTarget(tech, node)));
}
});
/**
* BuildFlow — это хэлпер для упрощения создания полностью настраиваемых технологий.
*
* Например, сборка js:
* ```javascript
* module.exports = require('enb/lib/build-flow').create()
* .name('js')
* .target('target', '?.js')
* .useFileList('js')
* .justJoinFilesWithComments()
* .createTech();
* ```
* @name BuildFlow
*/
const BuildFlow = inherit(/** @lends BuildFlow.prototype */ {
/**
* Конструктор.
*/
__constructor() {
this._name = '';
this._usages = [];
this._dependencies = [];
this._targetOptionName = '';
this._defaultTargetName = '';
this._requiredOptions = [];
this._options = {};
this._methods = {};
this._staticMethods = {};
this._deprecationNotice = null;
this._optionAliases = {};
this._inheritTech = BaseTech;
this._prepareFunc = () => {};
this._buildFunc = () => {
throw new Error('You should declare build function using "build" method of BuildFlow.');
};
this._wrapFunc = data => data;
this._saveFunc = (filename, result) => vowFs.write(filename, result, 'utf8');
this._cacheValidator = () => false;
this._cacheSaver = () => {};
},
/**
* Устанавливает имя технологии.
* @param {String} techName
* @returns {BuildFlow}
*/
name(techName) {
return this._copyAnd(buildFlow => {
buildFlow._name = techName;
});
},
/**
* @param {string} thisPackage
* @param {string} [newPackage]
* @param {string} [newTech]
* @param {string} [desc]
* @returns {BuildFlow}
*/
deprecated(thisPackage, newPackage, newTech, desc) {
return this._copyAnd(buildFlow => {
buildFlow._deprecationNotice = {
thisPackage,
newPackage,
newTech,
desc
};
});
},
/**
* Определяет опцию для технологии.
* @param {String} optionName Имя опции.
* @param {*} [defaultValue] Значение по умолчанию.
* @param {String} [fieldName] Имя поля, в которое необходимо записать значение опции
* (по умолчанию — "_<имя опции>").
* @returns {BuildFlow}
*/
defineOption(optionName, defaultValue, fieldName) {
return this._copyAnd(buildFlow => {
buildFlow._options[optionName] = {
fieldName: fieldName || `_${optionName}`,
defaultValue
};
});
},
/**
* Определяет обязательную опцию для технологии.
* @param {String} optionName Имя опции.
* @param {String} [fieldName] Имя поля, в которое необходимо записать значение опции
* (по умолчанию — "_<имя опции>").
* @returns {BuildFlow}
*/
defineRequiredOption(optionName, fieldName) {
return this._copyAnd(buildFlow => {
buildFlow._options[optionName] = {
fieldName: fieldName || `_${optionName}`
};
buildFlow._requiredOptions.push(optionName);
});
},
/**
* Объявляет алиас для опции.
*
* @param {String} optionName
* @param {String} aliasName
* @returns {BuildFlow}
*/
optionAlias(optionName, aliasName) {
return this._copyAnd(buildFlow => {
buildFlow._optionAliases[aliasName] = optionName;
});
},
/**
* Требует список файлов по суффиксу или суффиксам.
* Например, .useFileList("js") добавит в аргументы билдеру список файлов с расширением js.
* Значение по умолчанию можно переопределить параметром sourceSuffixes
* @param {String|Array} defaultSuffixes Значение по умолчанию.
* @returns {BuildFlow}
*/
useFileList(defaultSuffixes) {
return this._copyAnd(buildFlow => {
buildFlow._addUsage(
new BuildFlowLinkToFileList('filesTarget', '?.files', defaultSuffixes)
);
});
},
/**
* Требует список директорий по суффиксу или суффиксам.
* Например, .useDirList("i18n") добавит в аргументы билдеру список директорий с расширением i18n.
* @param {String|Array} suffixes
* @returns {BuildFlow}
*/
useDirList(suffixes) {
return this._copyAnd(buildFlow => {
buildFlow._addUsage(
new BuildFlowLinkToDirList('dirsTarget', '?.dirs', suffixes)
);
});
},
/**
* Отменяет требование целей другой ноды.
* @param {String} name
* @returns {BuildFlow}
*/
unuseTarget(name) {
return this._copyAnd(buildFlow => {
buildFlow._removeUsage(name);
});
},
/**
* Отменяет требование списка файлов.
* @returns {BuildFlow}
*/
unuseFileList() {
return this._copyAnd(buildFlow => {
buildFlow._removeUsage('filesTarget');
});
},
/**
* Отменяет требование списка директорий.
* @returns {BuildFlow}
*/
unuseDirList() {
return this._copyAnd(buildFlow => {
buildFlow._removeUsage('dirsTarget');
});
},
/**
* Требует имя файла другого таргета ноды, объявляет зависимость от этого таргета.
* В аргументы билдера придет абсолютный путь к файлу.
* @param {String} targetOptionName Имя опции для таргета.
* @param {String} defaultTargetName Значение по умолчанию.
* @returns {BuildFlow}
*/
useSourceFilename(targetOptionName, defaultTargetName) {
return this._copyAnd(buildFlow => {
buildFlow._addUsage(new BuildFlowLinkToTargetFilename(targetOptionName, defaultTargetName));
});
},
/**
* Требует список имен файлов других таргетов ноды, объявляет зависимость от этого таргета.
* В аргументы билдера придет абсолютный путь к файлу.
* @param {String} targetOptionName Имя опции для таргета.
* @param {String[]} [defaultTargetNames] Значение по умолчанию.
* @returns {BuildFlow}
*/
useSourceListFilenames(targetOptionName, defaultTargetNames) {
return this._copyAnd(buildFlow => {
buildFlow._addUsage(
new BuildFlowLinkToTargetList(targetOptionName, defaultTargetNames, BuildFlowLinkToTargetFilename)
);
});
},
/**
* Требует содержимое файла другого таргета ноды, объявляет зависимость от этого таргета.
* В аргументы билдера придет содержимое файла.
* @param {String} targetOptionName Имя опции для таргета.
* @param {String} defaultTargetName Значение по умолчанию.
* @returns {BuildFlow}
*/
useSourceText(targetOptionName, defaultTargetName) {
return this._copyAnd(buildFlow => {
buildFlow._addUsage(new BuildFlowLinkToTargetSource(targetOptionName, defaultTargetName));
});
},
/**
* Требует результат выполнения другого таргета ноды, объявляет зависимость от этого таргета.
* В аргументы билдера придет результат выполнения технологии.
* @param {String} targetOptionName
* @param {String} defaultTargetName
* @returns {BuildFlow}
*/
useSourceResult(targetOptionName, defaultTargetName) {
return this._copyAnd(buildFlow => {
buildFlow._addUsage(new BuildFlowLinkToTargetResult(targetOptionName, defaultTargetName));
});
},
/**
* Объявляет зависимость от таргета ноды, но не добявляет аргументов в билдер.
* @param {String} targetOptionName
* @param {String} defaultTargetName
* @returns {BuildFlow}
*/
dependOn(targetOptionName, defaultTargetName) {
return this._copyAnd(buildFlow => {
buildFlow._addDep(new BuildFlowLinkToTargetNoResult(targetOptionName, defaultTargetName));
});
},
/**
* Настраивает таргет для технологии.
* @param {String} targetOptionName Имя опции, в котором передается таргет.
* @param {String} defaultTargetName Имя таргета по умолчанию.
* @returns {BuildFlow}
*/
target(targetOptionName, defaultTargetName) {
return this._copyAnd(buildFlow => {
buildFlow._targetOptionName = targetOptionName;
buildFlow._defaultTargetName = defaultTargetName;
});
},
/**
* Определяет метод для сборки. Метод должен возвращать строку-результат сборки, либо промис,
* который резолвится строкой.
* Основной метод для технологии. Все источники, которые были определены через методы use* будут переданы в билдер,
* как аргументы.
* @param {Function} func
* @returns {BuildFlow}
*/
builder(func) {
return this._copyAnd(buildFlow => {
buildFlow._buildFunc = func;
});
},
/**
* Определяет метод подготовки к сборке. Метод не принимает никаких аргументов.
*
* @param {Function} func
* @returns {BuildFlow}
*/
prepare(func) {
return this._copyAnd(buildFlow => {
buildFlow._prepareFunc = func;
});
},
/**
* Определяет метод проверки кэша при сборке.
* Метод должен возвращает булевое значение.
* true — необходимо пересобрать таргет.
* false — нет необходимости пересобирать таргет.
* @param {Function} func
* @returns {BuildFlow}
*/
needRebuild(func) {
return this._copyAnd(buildFlow => {
buildFlow._cacheValidator = func;
});
},
/**
* Сохраняет кэш для того, чтобы избежать лишнюю повторную сборку.
* @param {Function} func
* @returns {BuildFlow}
*/
saveCache(func) {
return this._copyAnd(buildFlow => {
buildFlow._cacheSaver = func;
});
},
/**
* Определяет функцию-враппер.
* В функцию передает строка, которую возвращает билдер.
* @param {Function} func
* @returns {BuildFlow}
*/
wrapper(func) {
return this._copyAnd(buildFlow => {
buildFlow._wrapFunc = func;
});
},
/**
* Определяет функцию, сохраняющую результат выполнения билдера.
* Фунция должна возвратить промис.
* @param {Function} func
* @returns {BuildFlow}
*/
saver(func) {
return this._copyAnd(buildFlow => {
buildFlow._saveFunc = func;
});
},
/**
* Определяет набор методов технологии.
* @param {Object} methods Методы в виде хэш-таблицы (объекта).
* @returns {BuildFlow}
*/
methods(methods) {
return this._copyAnd(buildFlow => {
Object.keys(methods).forEach(methodName => {
buildFlow._methods[methodName] = methods[methodName];
});
});
},
/**
* Определяет набор статических методов технологии.
* @param {Object} staticMethods Методы в виде хэш-таблицы (объекта).
* @returns {BuildFlow}
*/
staticMethods(staticMethods) {
return this._copyAnd(buildFlow => {
Object.keys(staticMethods).forEach(methodName => {
buildFlow._staticMethods[methodName] = staticMethods[methodName];
});
});
},
/**
* Создает копию инстанции BuildFlow.
* @returns {BuildFlow}
*/
copy() {
const result = new BuildFlow();
result._targetOptionName = this._targetOptionName;
result._defaultTargetName = this._defaultTargetName;
result._name = this._name;
result._usages = this._usages.slice(0);
result._dependencies = this._dependencies.slice(0);
result._requiredOptions = this._requiredOptions.slice(0);
result._buildFunc = this._buildFunc;
result._saveFunc = this._saveFunc;
result._wrapFunc = this._wrapFunc;
result._cacheValidator = this._cacheValidator;
result._cacheSaver = this._cacheSaver;
result._prepareFunc = this._prepareFunc;
result._deprecationNotice = this._deprecationNotice;
result._inheritTech = this._inheritTech;
const options = this._options;
Object.keys(options).forEach(optName => {
result._options[optName] = options[optName];
});
const methods = this._methods;
Object.keys(methods).forEach(methodName => {
result._methods[methodName] = methods[methodName];
});
const staticMethods = this._staticMethods;
Object.keys(staticMethods).forEach(methodName => {
result._staticMethods[methodName] = staticMethods[methodName];
});
const optionAliases = this._optionAliases;
Object.keys(optionAliases).forEach(optionName => {
result._optionAliases[optionName] = optionAliases[optionName];
});
return result;
},
/**
* Хэлпер для построения билдера, который просто объединяет файлы, переданные в аргументах.
* @param {function} wrapper
* @returns {BuildFlow}
*/
justJoinFiles(wrapper) {
return this._copyAnd(buildFlow => {
buildFlow._buildFunc = function () {
const _this = this;
return Vow.all(Array.prototype.map.call(arguments, arg => {
if (typeof arg === 'string') {
return vowFs.read(arg, 'utf8').then(data => wrapper ? wrapper.call(_this, arg, data) : data);
} else if (Array.isArray(arg)) {
return _this._joinFiles(arg, wrapper);
} else {
return '';
}
})).then(res => res.join(EOL));
};
});
},
/**
* Хэлпер для построения билдера, который объединяет файлы, переданные в аргументах, расставляя комментарии
* о расположении файлов.
* @returns {BuildFlow}
*/
justJoinFilesWithComments() {
return this.justJoinFiles(function (filename, data) {
const fn = this.node.relativePath(filename);
return [
`/* begin: ${fn} */`,
data,
`/* end: ${fn} */`
].join(EOL);
});
},
/**
* Хэлпер для построения билдера, который объединяет текст, переданный в аргументах.
* @returns {BuildFlow}
*/
justJoinSources() {
return this._copyAnd(buildFlow => {
buildFlow._buildFunc = function () {
const _this = this;
return Vow.all(Array.prototype.map.call(arguments, arg => {
if (typeof arg === 'string') {
return arg;
} else if (Array.isArray(arg)) {
return _this._joinFiles(arg);
} else {
return '';
}
})).then(res => res.join(EOL));
};
});
},
_addUsage(usage) {
return this._addToTargetLinks(this._usages, usage);
},
_removeUsage(targetOptionName) {
this._usages = this._usages.filter(link => link.getTargetOptionName() !== targetOptionName);
},
_addDep(dep) {
return this._addToTargetLinks(this._dependencies, dep);
},
_addToTargetLinks(links, link) {
const optionName = link.getTargetOptionName();
for (let i = 0, l = links.length; i < l; i++) {
if (links[i].getTargetOptionName() === optionName) {
links[i] = link;
return this;
}
}
links.push(link);
return this;
},
/**
* Создает копию BuildFlow и выполняет переданную функцию для копии.
* Возвращает копию.
* @param {Function} func
* @returns {BuildFlow}
* @private
*/
_copyAnd(func) {
const result = this.copy();
func(result);
return result;
},
/**
* Создает технологию.
* @returns {Tech}
*/
createTech() {
const name = this._name;
const targetOptionName = this._targetOptionName;
const defaultTargetName = this._defaultTargetName;
const usages = this._usages.concat(this._dependencies);
const requiredOptions = this._requiredOptions;
const options = this._options;
const buildFunc = this._buildFunc;
const saveFunc = this._saveFunc;
const wrapFunc = this._wrapFunc;
const cacheValidator = this._cacheValidator;
const cacheSaver = this._cacheSaver;
const preparer = this._prepareFunc;
const methods = this._methods;
const staticMethods = this._staticMethods;
const deprecationNotice = this._deprecationNotice;
const optionAliases = this._optionAliases;
if (!name) {
throw new Error('You should declare tech name using "name" method of BuildFlow.');
}
if (!targetOptionName) {
throw new Error('You should declare tech target name using "target" method of BuildFlow.');
}
const resultTechMethods = {
__cacheSaver: cacheSaver,
__buildFunc: buildFunc,
__saveFunc: saveFunc,
__wrapFunc: wrapFunc,
__preparer: preparer,
__cacheValidator: cacheValidator,
configure() {
const _this = this;
const node = this.node;
Object.keys(optionAliases).forEach(function (aliasName) {
if (this._options.hasOwnProperty(aliasName)) {
const optionName = optionAliases[aliasName];
this._options[optionName] = this._options[aliasName];
delete this._options[aliasName];
}
}, this);
options.prependText = { fieldName: '_prependText', defaultValue: '' };
options.appendText = { fieldName: '_appendText', defaultValue: '' };
this._optionFieldNames = {};
Object.keys(options).forEach(optName => {
const option = options[optName];
_this[option.fieldName] = _this.getOption(optName, option.defaultValue);
_this._optionFieldNames[optName] = option.fieldName;
});
this._target = node.unmaskTargetName(
this._preprocessTargetName(defaultTargetName ?
_this.getOption(targetOptionName, defaultTargetName) :
_this.getRequiredOption(targetOptionName))
);
requiredOptions.forEach(requiredOption => {
_this.getRequiredOption(requiredOption);
});
usages.forEach(usage => {
usage.configureUsages(_this, node);
});
this._buildResult = undefined;
},
getName() {
return name;
},
getTargets() {
return [this._target];
},
_requireSources() {
const _this = this;
const node = this.node;
return Vow.all(usages.map(usage => usage.requireTarget(_this, node)));
},
_isRebuildRequired() {
const cache = this.node.getNodeCache(this._target);
if (this.__cacheValidator.call(this, cache)) {
return true;
}
if (cache.needRebuildFile('target', this.node.resolvePath(this._target))) {
return true;
}
for (let i = 0, l = usages.length; i < l; i++) {
if (!usages[i].isCacheValid(this, this.node, cache)) {
return true;
}
}
return false;
},
_saveCache() {
const cache = this.node.getNodeCache(this._target);
cache.cacheFileInfo('target', this.node.resolvePath(this._target));
for (let i = 0, l = usages.length; i < l; i++) {
usages[i].saveCache(this, this.node, cache);
}
this.__cacheSaver.call(this, cache);
},
_getBuildResult() {
return this.__buildFunc.apply(this, arguments);
},
_saveBuildResult() {
return this.__saveFunc.apply(this, arguments);
},
_wrapBuildResult() {
return this.__wrapFunc.apply(this, arguments);
},
_joinFiles(files, wrapper) {
const _this = this;
return Vow.all(files.map(fileInfo => {
return vowFs.read(fileInfo.fullname, 'utf8').then(data => {
return wrapper ? wrapper.call(_this, fileInfo.fullname, data) : data;
});
})).then(results => results.join(EOL));
},
_joinFilesWithComments(files) {
const node = this.node;
return this._joinFiles(files, (filename, data) => {
const fn = node.relativePath(filename);
return [
`/* begin: ${fn} */`,
data,
`/* end: ${fn} */`
].join(EOL);
});
},
_preprocessTargetName(targetName) {
const _this = this;
return targetName.replace(/{([^}]+)}/g, (s, optName) => {
if (_this._optionFieldNames[optName]) {
return _this[_this._optionFieldNames[optName]] || '';
} else {
return _this.getOption(optName, '');
}
});
},
setResult(value) {
this._buildResult = value;
},
_prepare() {
return this.__preparer.call(this);
},
build() {
const _this = this;
const node = this.node;
return Vow.when(_this._prepare()).then(() => {
if (deprecationNotice) {
node.getLogger().logTechIsDeprecated(
_this._target,
name,
deprecationNotice.thisPackage,
deprecationNotice.newTech ||
(deprecationNotice.newPackage ? name : ''),
deprecationNotice.newPackage,
deprecationNotice.desc
);
}
return _this._requireSources().then(results => {
if (_this._isRebuildRequired()) {
return Vow.when(_this._getBuildResult.apply(_this, results)).then(data => {
return Vow.when(_this._wrapBuildResult(data)).then(wrappedData => {
wrappedData = _this._prependText + wrappedData + _this._appendText;
return Vow.when(
_this._saveBuildResult(_this.node.resolvePath(_this._target), wrappedData)
).then(() => {
_this._saveCache();
node.resolveTarget(_this._target, _this._buildResult);
});
});
});
} else {
node.isValidTarget(_this._target);
node.resolveTarget(_this._target, _this._buildResult);
return null;
}
});
});
}
};
Object.keys(methods).forEach(methodName => {
resultTechMethods[methodName] = methods[methodName];
});
/**
* Результирующая технология, которая строится на основе инстанции BuildFlow.
*/
const resultTech = inherit(this._inheritTech, resultTechMethods, staticMethods);
const _this = this;