-
Notifications
You must be signed in to change notification settings - Fork 33
/
gulpfile.ts
2567 lines (2343 loc) · 73.8 KB
/
gulpfile.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
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
import { extractGlobTypes } from 'html-typings';
import { joinPages } from './tools/joinPages';
import { polymerBuild } from './tools/build';
import processhtml from 'gulp-processhtml';
import childProcess from 'child_process';
import StreamZip from 'node-stream-zip';
import beautify from 'gulp-beautify';
import Undertaker from 'undertaker';
import replace from 'gulp-replace';
import gulpBabel from 'gulp-babel';
import ts from 'gulp-typescript';
import rename from 'gulp-rename';
import banner from 'gulp-banner';
import * as rollup from 'rollup';
import xpi from 'firefox-xpi';
import crisper from 'crisper';
import mkdirp from 'mkdirp';
import zip from 'gulp-zip';
import "reflect-metadata";
import chalk from 'chalk';
import which from 'which';
import gulp from 'gulp';
import glob from 'glob';
import path from 'path';
import del from 'del';
import fs from 'fs';
// Only show subtasks when they are actually being run, otherwise
// the -T screen is just being spammed
const REGISTER_SUBTASKS = process.argv.indexOf('-T') === -1 &&
process.argv.indexOf('--tasks') === -1;
const BANNERS = {
html: '<!--Original can be found at https://www.github.com/SanderRonde' +
'/CustomRightClickMenu\nThis code may only be used under the MIT' +
' style license found in the LICENSE.txt file-->\n',
js: '/*!\n * Original can be found at https://github.com/SanderRonde' +
'/CustomRightClickMenu \n * This code may only be used under the MIT' +
' style license found in the LICENSE.txt file \n**/\n'
}
type DescribedFunction<T extends ReturnFunction = ReturnFunction> = T & {
description: string;
}
type ReturnFunction = (() => void)|(() => Promise<any>)|
(() => NodeJS.ReadWriteStream)|Undertaker.TaskFunction;
const descriptions: Map<string, string> = new Map();
/**
* Generates a root task with given description
* root tasks are meant to be called, contrary to
* child tasks which are just there to preserve
* structure and to be called for specific reasons.
*/
function genRootTask<T extends ReturnFunction>(name: string, description: string,
toRun: T): T {
if (!toRun && typeof description !== 'string') {
console.log(`Missing root task name for task with description ${description}`);
process.exit(1);
}
(toRun as DescribedFunction).description = description;
descriptions.set(name, description);
return toRun;
}
/**
* Creates a directory
*/
function assertDir(dirPath: string): Promise<void> {
return new Promise((resolve, reject) => {
mkdirp(dirPath, (err) => {
if (err) {
reject(err);
} else {
resolve();
}
})
});
}
/**
* Write a file
*/
function writeFile(filePath: string, data: string, options?: { encoding?: 'utf8'; }): Promise<void> {
return new Promise(async (resolve, reject) => {
await assertDir(path.dirname(filePath)).catch((err) => {
resolve(err);
});
if (!options) {
fs.writeFile(filePath, data, {
encoding: 'utf8'
}, (err) => {
if (err) {
reject(err);
} else {
resolve();
}
});
} else {
fs.writeFile(filePath, data, options, (err) => {
if (err) {
reject(err);
} else {
resolve();
}
});
}
});
}
/**
* Caches the stream piped into this. If glob is provided,
* uses the glob to source a stream from given glob
* using cwd if provided, default is ./ (aka project root)
*/
function cacheStream(name: string, glob?: string | string[], cwd?: string): NodeJS.ReadWriteStream {
const stream = gulp.dest(`./.buildcache/${name}/`);
if (glob) {
return gulp.src(glob, {
cwd: cwd || __dirname
}).pipe(stream);
}
return stream;
}
/**
* Checks if cache with given name exists
*/
function cacheExists(name: string): boolean {
return fs.existsSync(`./.buildcache/${name}`);
}
/**
* Reads the cache and tries to find given cache name.
* If it fails, calls fallback and uses it instead
*/
function cache(name: string, fallback: () => NodeJS.ReadWriteStream): NodeJS.ReadWriteStream {
if (!(cacheExists(name))) {
return fallback().pipe(cacheStream(name));
}
return gulp.src(`./.buildcache/${name}/**/*`);
}
/**
* Read a file
*/
function readFile(filePath: string, options?: { encoding?: 'utf8'; }): Promise<string> {
return new Promise<string>((resolve, reject) => {
if (!options) {
fs.readFile(filePath, {
encoding: 'utf8'
}, (err, data) => {
if (err) {
reject(err);
} else {
resolve(data);
}
});
} else {
fs.readFile(filePath, options, (err, data) => {
if (err) {
reject(err);
} else {
resolve(data.toString());
}
});
}
});
}
/* Decorators */
interface TaskStructure {
type: 'parallel'|'series';
children: (TaskStructure|ReturnFunction)[];
}
function parallel(...tasks: (ReturnFunction|TaskStructure)[]): TaskStructure {
return {
type: 'parallel',
children: tasks
}
}
function series(...tasks: (ReturnFunction|TaskStructure)[]): TaskStructure {
return {
type: 'series',
children: tasks
}
}
function describe(description: string): MethodDecorator {
return (_target, _propertyName, descriptor) => {
(descriptor.value as unknown as DescribedFunction).description = description;
}
}
const taskClassMetaKey = Symbol('task-class');
function taskClass(name: string): ClassDecorator {
return (target) => {
Reflect.defineMetadata(taskClassMetaKey, name, target);
}
}
const groupMetaKey = Symbol('group');
// Not used for anything as of now except for documentation purposes
function group(name: string): PropertyDecorator {
return (target, propertyKey) => {
Reflect.defineMetadata(groupMetaKey, name, target, propertyKey);
}
}
const rootTaskMetaKey = Symbol('root-task');
function rootTask(nameOrDescription: string, description?: string): PropertyDecorator {
let name: string = null;
if (!description) {
description = nameOrDescription;
} else {
name = nameOrDescription;
}
return ((target: any, propertyKey: string, descr: any) => {
descr && ((descr.value as DescribedFunction).description = description);
descriptions.set(name || propertyKey, description);
Reflect.defineMetadata(rootTaskMetaKey, [name || propertyKey, description],
target, propertyKey);
}) as any;
}
const subtaskMetaKey = Symbol('root-task');
function subTask(nameOrDescription: string, description?: string): PropertyDecorator {
let name: string = '';
if (!description) {
description = nameOrDescription;
} else {
name = nameOrDescription;
}
return (target, propertyKey) => {
Reflect.defineMetadata(subtaskMetaKey, [name, description],
target, propertyKey);
}
}
@taskClass('')
class Tasks {
@group('convenience')
static Convenience = (() => {
class Convenience {
static Clean = (() => {
@taskClass('clean')
class Clean {
@describe('Cleans the build cache dir')
static async cache() {
await del('./.buildcache');
}
@describe('Cleans the /build directory')
static async build() {
await del('./build');
}
@describe('Cleans the /dist directory')
static async dist() {
await del('./dist');
}
@rootTask('cleanDist', 'Cleans the /dist directory')
static cleanDist = series(
Clean.dist
);
@rootTask('clean', 'Cleans the building and caching directories')
static clean = parallel(
Clean.cache,
Clean.build,
Clean.dist
);
}
return Clean;
})();
static PrepareForHotReload = (() => {
@taskClass('prepareForHotReload')
class PrepareForHotReload {
@describe('Crisps the bower components')
static crispComponents() {
return new Promise((resolve, reject) => {
glob('./app/bower_components/**/*.html', async (err, matches) => {
if (err) {
reject(err);
return;
}
await Promise.all([matches.map((file) => {
return new Promise(async (resolve) => {
const content = await readFile(file);
const { name, dir } = path.parse(file);
const { html, js } = crisper({
jsFileName: `${name}.js`,
source: content,
scriptInHead: false,
cleanup: false
});
await Promise.all([
writeFile(file, html),
writeFile(path.join(dir, `${name}.js`), js),
]);
resolve();
});
})]).catch(reject);
resolve();
});
});
};
@describe('Copies monaco files and beautifies them')
static copyMonacoBeautiful() {
return gulp
.src([
'**/**',
], {
base: 'node_modules/monaco-editor/min',
cwd: 'node_modules/monaco-editor/min'
})
.pipe(replace(/node = node\.parentNode/g,
'node = node.parentNode || node.host'))
.pipe(replace(/document\.body/g,
'MonacoEditorHookManager.getLocalBodyShadowRoot'))
.pipe(replace(/document\.caretRangeFromPoint/g,
'MonacoEditorHookManager.caretRangeFromPoint(arguments[0])'))
.pipe(replace(/this.target(\s)?=(\s)?e.target/g,
'this.target = e.path ? e.path[0] : e.target'))
.pipe(beautify())
.pipe(gulp.dest('app/elements/options/editpages/monaco-editor/src/min/'));
};
@describe('Embed the typescript compiler')
static tsEmbedDev() {
return gulp
.src('typescript.js', {
cwd: './node_modules/typescript/lib',
base: './node_modules/typescript/lib'
})
.pipe(gulp.dest('./app/js/libraries/'))
};
@describe('Embed the less compiler')
static async lessEmbedDev() {
const less = await readFile('./resources/buildresources/less.min.js');
await writeFile('./app/js/libraries/less.js', less);
};
@describe('Embed the stylus compiler)')
static async stylusEmbedDev() {
const stylus = await readFile('./resources/buildresources/stylus.min.js');
await writeFile('./app/js/libraries/stylus.js', stylus);
};
@describe('Embed the CRM API definitions)')
static async crmapiLib() {
await writeFile('./app/js/libraries/crmapi.d.ts', await Tasks.Definitions._joinDefs());
};
@rootTask('prepareForHotReload',
'Prepares the extension for hot reloading, developing through ' +
'the app/ directory instead and not having to build make sure to run ' +
'`yarn install --force --ignore-engines` before this')
static prepareForHotReload = parallel(
PrepareForHotReload.crispComponents,
PrepareForHotReload.copyMonacoBeautiful,
PrepareForHotReload.tsEmbedDev,
PrepareForHotReload.lessEmbedDev,
PrepareForHotReload.stylusEmbedDev,
PrepareForHotReload.crmapiLib
)
}
return PrepareForHotReload;
})();
@rootTask('disableHotReload',
'Disables hot reloading, required for proper build')
static disableHotReload() {
return new Promise((resolve, reject) => {
which('yarn', (err, cmdPath) => {
if (err) {
reject(err);
} else {
const cmd = childProcess.spawn(cmdPath, ['--force', '--ignore-engines']);
cmd.on('close', (code) => {
if (code !== 0) {
reject(`Yarn failed with exit code ${code}`)
} else {
resolve();
}
});
}
});
});
}
}
return Convenience;
})();
@group('i18n')
static I18N = (() => {
interface I18NMessage {
message: string;
description?: string;
placeholders?: {
[key: string]: {
content: string;
example?: string;
}
}
}
type I18NRoot = {
[key: string]: I18NRoot|I18NMessage;
};
@taskClass('i18n')
class I18N {
private static _isMessage(descriptor: I18NMessage|I18NRoot): descriptor is I18NMessage {
if (!('message' in descriptor)) return false;
return typeof descriptor.message === 'string';
}
private static _isIgnored(key: string) {
return key === '$schema' || key === 'comments';
}
private static _walkMessages(root: I18NRoot,
fn: (message: I18NMessage, currentPath: string[], key: string) => void,
currentPath: string[] = []) {
for (const key in root) {
const message = root[key];
if (this._isIgnored(key)) continue;
if (this._isMessage(message)) {
fn(message, currentPath, key);
} else {
this._walkMessages(message, fn, [...currentPath, key]);
}
}
}
private static _getFreshFileExport(file: string) {
const resolved = require.resolve(`./${file}`);
if (resolved in require.cache) {
delete require.cache[resolved];
}
const { Messages } = require(`./${file}`);
return Messages;
}
private static getMessageFiles(): Promise<[any, string][]> {
return new Promise<[any, string][]>((resolve, reject) => {
glob('./app/_locales/*/messages.js', async (err, matches) => {
if (err) {
reject();
return;
}
resolve(matches.map((file) => {
return [require(file).Messages, file] as [any, string];
}));
});
});
}
private static _genPath(currentPath: string[], key: string) {
if (currentPath.length === 0) {
// First item, return key by itself
return key;
}
// Requires an @ and dots for the rest
return [
currentPath.slice(0, 2).join('_'),
...currentPath.slice(2),
key
].join('_');
}
@describe('Compiles the .ts files into .js files')
static compileTS() {
return new Promise(async (resolve, reject) => {
const files = await new Promise<string[]>((resolve, reject) => {
glob('app/_locales/**/*.ts', (err, matches) => {
if (err) {
reject(err);
} else {
resolve(matches.filter(
f => !f.endsWith('.d.ts')
));
}
});
});
const dest = (() => {
if (files.length > 1) {
return './app/_locales';
}
return files[0].split('messages.ts')[0];
})();
const project = ts.createProject('app/_locales/tsconfig.json');
const proj = project.src().pipe(project());
proj.once('error', () => {
reject('Error(s) thrown during compilation');
});
proj.js.pipe(gulp.dest(dest)).once('end', () => {
resolve(null);
});
});
}
static Compile = (() => {
@taskClass('compile')
class Compile {
private static _removeMetadata(message: I18NMessage) {
const cleanedMessage: Partial<I18NMessage> = {};
cleanedMessage.message = message.message;
if (message.placeholders) {
cleanedMessage.placeholders = {};
}
for (const placeholder in message.placeholders || {}) {
cleanedMessage.placeholders[placeholder] = {
content: message.placeholders[placeholder].content
}
}
return cleanedMessage as I18NMessage;
}
private static _normalizeMessages(root: I18NRoot) {
const normalized: {
[key: string]: I18NMessage;
} = {};
I18N._walkMessages(root, (message, currentPath, key) => {
normalized[I18N._genPath(currentPath, key)] =
this._removeMetadata(message);
});
return normalized;
}
static async _compileI18NFile(file: string, data?: any) {
const normalized = this._normalizeMessages(
data || I18N._getFreshFileExport(file));
await writeFile(path.join(path.dirname(file), 'messages.json'),
JSON.stringify(normalized, null, '\t'));
}
@describe('Turns I18N TS files into messages.json files')
static async compile() {
const files = await I18N.getMessageFiles();
await files.map(([ data, fileName ]) => {
Compile._compileI18NFile(fileName, data);
});
}
private static _activeTask: Promise<any>;
@describe('Runs when watched file changes')
static async watchFileChange() {
let currentTask = Compile._activeTask;
await Compile._activeTask.then(() => {
if (Compile._activeTask !== currentTask) {
return Compile._activeTask;
} else {
Compile._activeTask = null;
return true;
}
});
}
@describe('Watches for file changes and compiles on change')
static async watcher() {
const watcher = gulp.watch('./app/_locales/*/messages.js',
Compile.watchFileChange);
watcher.on('change', (fileName) => {
Compile._activeTask = (async () => {
const fileData = I18N._getFreshFileExport(fileName);
await I18N.Compile._compileI18NFile(fileName, fileData);
})();
});
watcher.on('add', (fileName) => {
Compile._activeTask = (async () => {
const fileData = I18N._getFreshFileExport(fileName);
await I18N.Compile._compileI18NFile(fileName, fileData);
})();
});
return watcher;
}
@subTask('watch', 'Compiles, then watches for file changes and compiles on change')
static watch = series(
Compile.compile,
Compile.watcher
);
}
return Compile;
})();
static Defs = (() => {
type NestedObject = {
[key: string]: string|NestedObject;
};
const I18NMessage = [
'interface I18NMessage {',
' message: string;',
' description?: string;',
' placeholders?: {',
' [key: string]: {',
' example?: string;',
' content: string;',
' }',
' }',
'}'
].join('\n');
const marker = 'x'.repeat(50);
const readonlyExpr = new RegExp(`"${marker}"`, 'g');
type Change = {
direction: 'forwards'|'backwards';
name: string;
};
@taskClass('defs')
class Defs {
private static async _typeMessages(root: I18NRoot, typed: NestedObject = {}) {
I18N._walkMessages(root, (_message, currentPath, finalKey) => {
let currentObj = typed;
for (const key of currentPath) {
if (!(key in currentObj)) {
currentObj[key] = {};
}
currentObj = currentObj[key] as NestedObject;
}
currentObj[finalKey] = marker;
});
return typed;
}
@describe('Generates the lang spec from input files, making sure all ' +
'fields are represented in all languages')
static async genSpec() {
const files = await I18N.getMessageFiles();
const typed: NestedObject = {};
await files.map(([data]) => {
return Defs._typeMessages(data, typed);
});
const spec = JSON.stringify(typed, null, '\t').replace(
readonlyExpr, 'I18NMessage');
const specFile = `${I18NMessage}\nexport type LocaleSpec = ${spec}`;
await writeFile(path.join(__dirname, 'app/_locales/i18n.d.ts'),
specFile);
}
private static _getMatches(a: string[], b: string[]): number {
let matches: number = 0;
for (let i = 0; i < Math.max(a.length, b.length); i++) {
if (a[i] === b[i]) {
matches++;
} else {
return matches;
}
}
return matches;
}
private static _getDiffPath(a: string[], b: string[]): Change[] {
let matches = Defs._getMatches(a, b);
if (a.length === b.length && matches === a.length) return [];
return [
...a.slice(matches).reverse().map((item) => {
return {
direction: 'backwards',
name: item
} as Change;
}),
...b.slice(matches).map((item) => {
return {
direction: 'forwards',
name: item
} as Change;
})
]
}
private static _indent(length: number) {
return '\t'.repeat(length);
}
static genEnumMessages(root: I18NRoot) {
let str: string[] = [];
let tree: string[] = [];
I18N._walkMessages(root, (_message, currentPath, finalKey) => {
const diff = Defs._getDiffPath(tree, currentPath);
if (diff.length) {
for (let i = 0; i < diff.length; i++) {
const change = diff[i];
if (change.direction === 'backwards') {
str.push(Defs._indent(tree.length - 1) + '}');
tree.pop();
} else if (i === diff.length - 1) {
// Last one, this is an enum instead
str.push(Defs._indent(tree.length) + `export const enum ${change.name} {`);
tree.push(change.name);
} else {
str.push(Defs._indent(tree.length) + `export namespace ${change.name} {`);
tree.push(change.name);
}
}
}
str.push(`${Defs._indent(tree.length)}"${finalKey}" = '${
I18N._genPath(currentPath, finalKey)}',`);
});
for (let i = 0; i < tree.length; i++) {
str.push(Defs._indent(tree.length - 1) + '}');
}
return `export namespace I18NKeys {\n${
str.map(i => Defs._indent(1) + i).join('\n')
}\n}`;
}
@describe('Generates enums that can be used to reference some ' +
'property in typescript, preventing typos and allowing for ' +
'the finding of references')
static async genEnums() {
const files = await I18N.getMessageFiles();
if (files.length === 0) {
console.log('No source files to generate enums from');
return;
}
const enums = await Defs.genEnumMessages(files[0][0]);
await writeFile(path.join(__dirname, 'app/_locales/i18n-keys.ts'),
enums);
}
@rootTask('i18nDefs', 'Generates definitions files based on i18n files')
static defs = series(
I18N.compileTS,
Defs.genEnums
)
@rootTask('i18nSpec', 'Generates language spec')
static spec = series(
Defs.genSpec
)
private static _activeTask: Promise<any>;
@describe('Runs when watched file changes')
static async watchFileChange() {
let currentTask = Defs._activeTask;
await Defs._activeTask.then(() => {
if (Defs._activeTask !== currentTask) {
return Defs._activeTask;
} else {
Defs._activeTask = null;
return true;
}
});
}
@describe('Watches for file changes and updates enums on change')
static async watcher() {
const watcher = gulp.watch('./app/_locales/*/messages.js', Defs.watchFileChange);
watcher.on('change', (fileName) => {
Defs._activeTask = (async () => {
const fileData = I18N._getFreshFileExport(fileName);
const enums = await I18N.Defs.genEnumMessages(fileData)
await writeFile(path.join(__dirname, 'app/_locales/i18n-keys.ts'),
enums);
})();
});
watcher.on('add', (fileName) => {
Defs._activeTask = (async () => {
const fileData = I18N._getFreshFileExport(fileName);
const enums = await I18N.Defs.genEnumMessages(fileData)
await writeFile(path.join(__dirname, 'app/_locales/i18n-keys.ts'),
enums);
})();
});
return watcher;
}
@subTask('watch',
'Gens enums, then watches for file changes and updates enums on change')
static watch = series(
Defs.genEnums,
Defs.watcher
)
}
return Defs;
})();
private static _activeTask: Promise<any>;
@describe('Runs when watched file changes')
static async watchFileChange() {
let currentTask = I18N._activeTask;
await I18N._activeTask.then(() => {
if (I18N._activeTask !== currentTask) {
return I18N._activeTask;
} else {
I18N._activeTask = null;
return true;
}
});
}
@describe('Turns I18N TS files into messages.json files whenever they change')
static watcher() {
const watcher = gulp.watch('./app/_locales/*/messages.js', I18N.watchFileChange);
watcher.on('change', (fileName) => {
I18N._activeTask = (async () => {
const fileData = I18N._getFreshFileExport(fileName);
const [ , enums] = await Promise.all([
I18N.Compile._compileI18NFile(fileName, fileData),
I18N.Defs.genEnumMessages(fileData)
]);
await writeFile(path.join(__dirname, 'app/_locales/i18n-keys.ts'),
enums);
})();
});
watcher.on('add', (fileName) => {
I18N._activeTask = (async () => {
const fileData = I18N._getFreshFileExport(fileName);
const [ , enums] = await Promise.all([
I18N.Compile._compileI18NFile(fileName, fileData),
I18N.Defs.genEnumMessages(fileData)
]);
await writeFile(path.join(__dirname, 'app/_locales/i18n-keys.ts'),
enums);
})();
});
return watcher;
}
@subTask('watch',
'Turns I18N TS files into messages.json files and repeats it whenever they change')
static watch = series(
I18N.Compile.compile,
I18N.watcher
)
@rootTask('i18n',
'Compiles I18N files and generates spec and enum files')
static i18n = series(
I18N.Defs.genEnums,
I18N.Compile.compile
)
}
return I18N;
})();
@group('compilation')
static Compilation = (() => {
class Compilation {
@rootTask('fileIdMaps',
'Updates the HTML to Typescript maps')
static async fileIdMaps() {
const pattern = '{app/elements/**/*.html,!app/elements/elements.html}';
const typings = await extractGlobTypes(pattern);
await writeFile('./app/elements/fileIdMaps.d.ts', typings);
}
@rootTask('defs',
'Generates definitions for various TS files. Required for compilation')
static defs = parallel(
Compilation.fileIdMaps,
Tasks.I18N.Defs.defs
)
static Compile = (() => {
@taskClass('compile')
class Compile {
@describe('Compiles the app/ directory\'s typescript')
static app() {
return new Promise((resolve, reject) => {
const project = ts.createProject('app/tsconfig.json');
const proj = project.src().pipe(project());
proj.once('error', () => {
reject('Error(s) thrown during compilation');
});
proj.js.pipe(gulp.dest('./app')).once('end', () => {
resolve(null);
});
});
}
@describe('Compiles the test/ directory\'s typescript')
static test() {
return new Promise((resolve, reject) => {
const project = ts.createProject('test/tsconfig.json');
const proj = project.src().pipe(project());
proj.once('error', () => {
reject('Error(s) thrown during compilation');
});
proj.js.pipe(gulp.dest('./test')).once('end', () => {
resolve(null);
});
});
}
@rootTask('compile', 'Compiles the typescript')
static compile = series(
Compilation.defs,
parallel(
Compile.app,
Compile.test
)
)
}
return Compile;
})();
}
return Compilation;
})();
@group('documentation-website')
static DocumentationWebsite = (() => {
function typedocCloned() {
return new Promise((resolve) => {
fs.stat(path.join(__dirname, 'typedoc', 'package.json'), (err) => {
if (err) {
//Doesn't exist yet
resolve(false);
} else {
resolve(true);
}
});
});
}
async function runCmd(cmd: string, cwd: string = __dirname,
allowFailure: boolean = false) {
return new Promise((resolve, reject) => {
childProcess.exec(cmd, {
cwd: cwd
}, (err, stdout, stderr) => {
if (err !== null && !allowFailure) {
console.log(stdout, stderr);
reject(err);
} else {
resolve();
}
});
});
}
async function cloneTypedoc() {
let cwd = __dirname;
console.log('Cloning typedoc locally');
console.log('Cloning into ./typedoc/');
await runCmd('git clone https://github.com/TypeStrong/typedoc typedoc')
cwd = path.join(cwd, 'typedoc/');
console.log('Getting this extension\'s version of typescript');
const CRMPackage = JSON.parse(await readFile(path.join(__dirname, 'package.json')));
const tsVersion = CRMPackage.devDependencies.typescript;
console.log('Removing post install hook');
const file = await readFile(path.join(__dirname, 'typedoc', 'package.json'));
await writeFile(path.join(__dirname, 'typedoc', 'package.json'),
file.replace(/"prepare":/g, "\"ignored\":"));
console.log('Installing typedoc dependencies (this may take a few minutes)');
await runCmd('npm install', cwd);
console.log('Running post install hook');
await runCmd('tsc --project .', cwd, true);
console.log('Installing this extension\'s typescript version in cloned typedoc');
await runCmd(`npm install --save typescript@${tsVersion}`, cwd);
console.log('Done!');
}
class DocumentationWebsite {
@rootTask('documentationWebsite',
'Extracts the files needed for the documentationWebsite' +
' and places them in build/website')
static async documentationWebsite() {
console.log('Checking if typedoc has been cloned...');
const exists = await typedocCloned();
if (!exists) {
await cloneTypedoc();
}
const typedoc = require('./typedoc');
const app = new typedoc.Application({
mode: 'file',
out: 'documentation/',
includeDeclarations: true,
entryPoint: 'CRM',
theme: 'docs/theme',
name: 'CRM API',
readme: 'none',