js-build-tools 4.1.1 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +274 -267
- package/dist/build.js +58 -56
- package/dist/build.min.js +1 -1
- package/dist/bundle.js +16 -16
- package/dist/bundleLint.js +16 -20
- package/dist/bundleLint.min.js +1 -1
- package/dist/bundleMinify.js +13 -13
- package/dist/compileReadme.js +10 -10
- package/dist/copyFonts.js +13 -13
- package/dist/default.js +15 -15
- package/dist/dist.js +10 -10
- package/dist/distLint.js +16 -20
- package/dist/distLint.min.js +1 -1
- package/dist/distMinify.js +13 -13
- package/dist/images.js +10 -10
- package/dist/partials/copyFor.js +12 -9
- package/dist/partials/imagesFor.js +56 -21
- package/dist/partials/removeDirectory.js +37 -13
- package/dist/partials/sassFor.js +8 -2
- package/dist/partials/standardLint.js +96 -0
- package/dist/partials/tsFor.js +67 -67
- package/dist/partials.js +110 -103
- package/dist/partials.min.js +1 -1
- package/dist/sass.js +10 -10
- package/dist/test-helpers/standardLintWithRealStandard.js +28 -0
- package/dist/testFull.js +3 -3
- package/dist/testHelpers.js +10 -10
- package/dist/testQuick.js +3 -3
- package/dist/typeScript.js +9 -9
- package/dist/watchFull.js +10 -10
- package/dist/watchTest.js +16 -16
- package/functions/build.mjs +6 -3
- package/functions/build.test.mjs +31 -0
- package/functions/bundleLint.mjs +2 -6
- package/functions/bundleLint.test.mjs +3 -0
- package/functions/distLint.mjs +2 -6
- package/functions/distLint.test.mjs +3 -0
- package/functions/partials/copyFor.mjs +2 -1
- package/functions/partials/copyFor.test.mjs +18 -0
- package/functions/partials/imagesFor.mjs +35 -3
- package/functions/partials/imagesFor.test.mjs +83 -1
- package/functions/partials/removeDirectory.mjs +28 -14
- package/functions/partials/removeDirectory.test.mjs +44 -0
- package/functions/partials/sassFor.mjs +5 -2
- package/functions/partials/sassFor.test.mjs +22 -4
- package/functions/partials/standardLint.mjs +80 -0
- package/functions/partials/standardLint.test.mjs +99 -0
- package/functions/partials.mjs +1 -0
- package/functions/partials.test.mjs +1 -1
- package/functions/test-helpers/standardLintWithRealStandard.mjs +21 -0
- package/package.json +15 -4
package/README.md
CHANGED
|
@@ -408,270 +408,277 @@ Run any of the above commands with `gulp` or `npm run`.
|
|
|
408
408
|
|
|
409
409
|
# Available functions documentation
|
|
410
410
|
|
|
411
|
-
## Modules
|
|
412
|
-
|
|
413
|
-
<dl>
|
|
414
|
-
<dt><a href="#module_js-build-tools">js-build-tools</a></dt>
|
|
415
|
-
<dd><p>Export these functions to your own project to customize your build pipeline.</p>
|
|
416
|
-
</dd>
|
|
417
|
-
<dt><a href="#module_gulpConfig">gulpConfig</a></dt>
|
|
418
|
-
<dd><p>Modify these configurations to match your project specifications.</p>
|
|
419
|
-
</dd>
|
|
420
|
-
</dl>
|
|
421
|
-
|
|
422
|
-
<a name="module_js-build-tools"></a>
|
|
423
|
-
|
|
424
|
-
## js-build-tools
|
|
425
|
-
Export these functions to your own project to customize your build pipeline.
|
|
426
|
-
|
|
427
|
-
**Version**: 3.0.0
|
|
428
|
-
**Author**: Joshua Heagle <joshuaheagle@gmail.com>
|
|
429
|
-
<a name="
|
|
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
|
-
|
|
411
|
+
## Modules
|
|
412
|
+
|
|
413
|
+
<dl>
|
|
414
|
+
<dt><a href="#module_js-build-tools">js-build-tools</a></dt>
|
|
415
|
+
<dd><p>Export these functions to your own project to customize your build pipeline.</p>
|
|
416
|
+
</dd>
|
|
417
|
+
<dt><a href="#module_gulpConfig">gulpConfig</a></dt>
|
|
418
|
+
<dd><p>Modify these configurations to match your project specifications.</p>
|
|
419
|
+
</dd>
|
|
420
|
+
</dl>
|
|
421
|
+
|
|
422
|
+
<a name="module_js-build-tools"></a>
|
|
423
|
+
|
|
424
|
+
## js-build-tools
|
|
425
|
+
Export these functions to your own project to customize your build pipeline.
|
|
426
|
+
|
|
427
|
+
**Version**: 3.0.0
|
|
428
|
+
**Author**: Joshua Heagle <joshuaheagle@gmail.com>
|
|
429
|
+
<a name="module_js-build-tools.build"></a>
|
|
430
|
+
|
|
431
|
+
### js-build-tools.build() ⇒ <code>stream.Stream</code>
|
|
432
|
+
Runs several processes to build and validate the project.
|
|
433
|
+
Cleans, distributes (lint and minify), bundles (lint and minify), creates the readme, then runs the tests.
|
|
434
|
+
|
|
435
|
+
**Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)
|
|
436
|
+
<a name="module_gulpConfig"></a>
|
|
437
|
+
|
|
438
|
+
## gulpConfig
|
|
439
|
+
Modify these configurations to match your project specifications.
|
|
440
|
+
|
|
441
|
+
**Version**: 3.0.0
|
|
442
|
+
**Author**: Joshua Heagle <joshuaheagle@gmail.com>
|
|
443
|
+
|
|
444
|
+
* [gulpConfig](#module_gulpConfig)
|
|
445
|
+
* _static_
|
|
446
|
+
* [.get(path, defaultValue)](#module_gulpConfig.get) ⇒ <code>\*</code> \| <code>null</code>
|
|
447
|
+
* [.set(path, value)](#module_gulpConfig.set) ⇒ <code>\*</code>
|
|
448
|
+
* _inner_
|
|
449
|
+
* [~ArrayableSetting](#module_gulpConfig..ArrayableSetting) : <code>Array.<string></code> \| <code>string</code>
|
|
450
|
+
* [~BooleanSetting](#module_gulpConfig..BooleanSetting) : <code>boolean</code>
|
|
451
|
+
* [~FlagStringSetting](#module_gulpConfig..FlagStringSetting) : <code>false</code> \| <code>StringSetting</code>
|
|
452
|
+
* [~FlagsSetting](#module_gulpConfig..FlagsSetting) : <code>Object.<string, BooleanSetting></code>
|
|
453
|
+
* [~JestTestFlags](#module_gulpConfig..JestTestFlags) : <code>FlagsSetting</code>
|
|
454
|
+
* [~StringSetting](#module_gulpConfig..StringSetting) : <code>string</code>
|
|
455
|
+
* [~Setting](#module_gulpConfig..Setting) : <code>ArrayableSetting</code> \| <code>BooleanSetting</code> \| <code>FlagsSetting</code> \| <code>StringSetting</code>
|
|
456
|
+
* [~BrowserConfig](#module_gulpConfig..BrowserConfig) : <code>Object.<string, Setting></code>
|
|
457
|
+
* [~DistConfig](#module_gulpConfig..DistConfig) : <code>Object.<string, Setting></code>
|
|
458
|
+
* [~FontConfig](#module_gulpConfig..FontConfig) : <code>Object.<string, Setting></code>
|
|
459
|
+
* [~ImageConfig](#module_gulpConfig..ImageConfig) : <code>Object.<string, Setting></code>
|
|
460
|
+
* [~ReadmeConfig](#module_gulpConfig..ReadmeConfig) : <code>Object.<string, Setting></code>
|
|
461
|
+
* [~SassConfig](#module_gulpConfig..SassConfig) : <code>Object.<string, Setting></code>
|
|
462
|
+
* [~TestConfig](#module_gulpConfig..TestConfig) : <code>Object.<string, Setting></code>
|
|
463
|
+
* [~TsConfig](#module_gulpConfig..TsConfig) : <code>Object.<string, Setting></code>
|
|
464
|
+
* [~Configurations](#module_gulpConfig..Configurations) : <code>Object.<string, Setting></code>
|
|
465
|
+
|
|
466
|
+
<a name="module_gulpConfig.get"></a>
|
|
467
|
+
|
|
468
|
+
### gulpConfig.get(path, defaultValue) ⇒ <code>\*</code> \| <code>null</code>
|
|
469
|
+
Retrieve a value from the configurations, default may be returned.
|
|
470
|
+
|
|
471
|
+
**Kind**: static method of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
472
|
+
|
|
473
|
+
| Param | Type | Default |
|
|
474
|
+
| --- | --- | --- |
|
|
475
|
+
| path | <code>string</code> \| <code>null</code> | <code>null</code> |
|
|
476
|
+
| defaultValue | <code>\*</code> | <code></code> |
|
|
477
|
+
|
|
478
|
+
<a name="module_gulpConfig.set"></a>
|
|
479
|
+
|
|
480
|
+
### gulpConfig.set(path, value) ⇒ <code>\*</code>
|
|
481
|
+
Specify a value for the configurations to use.
|
|
482
|
+
|
|
483
|
+
**Kind**: static method of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
484
|
+
|
|
485
|
+
| Param |
|
|
486
|
+
| --- |
|
|
487
|
+
| path |
|
|
488
|
+
| value |
|
|
489
|
+
|
|
490
|
+
<a name="module_gulpConfig..ArrayableSetting"></a>
|
|
491
|
+
|
|
492
|
+
### gulpConfig~ArrayableSetting : <code>Array.<string></code> \| <code>string</code>
|
|
493
|
+
A setting that may be an array of strings or a string only.
|
|
494
|
+
|
|
495
|
+
**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
496
|
+
<a name="module_gulpConfig..BooleanSetting"></a>
|
|
497
|
+
|
|
498
|
+
### gulpConfig~BooleanSetting : <code>boolean</code>
|
|
499
|
+
A setting that may be true or false.
|
|
500
|
+
|
|
501
|
+
**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
502
|
+
<a name="module_gulpConfig..FlagStringSetting"></a>
|
|
503
|
+
|
|
504
|
+
### gulpConfig~FlagStringSetting : <code>false</code> \| <code>StringSetting</code>
|
|
505
|
+
A setting that may be flag 'false' or provide a StringSetting
|
|
506
|
+
|
|
507
|
+
**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
508
|
+
<a name="module_gulpConfig..FlagsSetting"></a>
|
|
509
|
+
|
|
510
|
+
### gulpConfig~FlagsSetting : <code>Object.<string, BooleanSetting></code>
|
|
511
|
+
An object of boolean settings used as flags.
|
|
512
|
+
|
|
513
|
+
**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
514
|
+
<a name="module_gulpConfig..JestTestFlags"></a>
|
|
515
|
+
|
|
516
|
+
### gulpConfig~JestTestFlags : <code>FlagsSetting</code>
|
|
517
|
+
Configure cli options for running Jest.
|
|
518
|
+
|
|
519
|
+
**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
520
|
+
**Properties**
|
|
521
|
+
|
|
522
|
+
| Name | Type |
|
|
523
|
+
| --- | --- |
|
|
524
|
+
| clearCache | <code>BooleanSetting</code> |
|
|
525
|
+
| debug | <code>BooleanSetting</code> |
|
|
526
|
+
| ignoreProjects: | <code>BooleanSetting</code> |
|
|
527
|
+
| json | <code>BooleanSetting</code> |
|
|
528
|
+
| selectProjects | <code>BooleanSetting</code> |
|
|
529
|
+
| showConfig | <code>BooleanSetting</code> |
|
|
530
|
+
| useStderr | <code>BooleanSetting</code> |
|
|
531
|
+
| watch | <code>BooleanSetting</code> |
|
|
532
|
+
| watchAll | <code>BooleanSetting</code> |
|
|
533
|
+
|
|
534
|
+
<a name="module_gulpConfig..StringSetting"></a>
|
|
535
|
+
|
|
536
|
+
### gulpConfig~StringSetting : <code>string</code>
|
|
537
|
+
A setting that may only be a string.
|
|
538
|
+
|
|
539
|
+
**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
540
|
+
<a name="module_gulpConfig..Setting"></a>
|
|
541
|
+
|
|
542
|
+
### gulpConfig~Setting : <code>ArrayableSetting</code> \| <code>BooleanSetting</code> \| <code>FlagsSetting</code> \| <code>StringSetting</code>
|
|
543
|
+
Any single configuration option is a Setting.
|
|
544
|
+
|
|
545
|
+
**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
546
|
+
<a name="module_gulpConfig..BrowserConfig"></a>
|
|
547
|
+
|
|
548
|
+
### gulpConfig~BrowserConfig : <code>Object.<string, Setting></code>
|
|
549
|
+
Configurations for building the browser files.
|
|
550
|
+
|
|
551
|
+
**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
552
|
+
**Properties**
|
|
553
|
+
|
|
554
|
+
| Name | Type | Description |
|
|
555
|
+
| --- | --- | --- |
|
|
556
|
+
| enabled | <code>BooleanSetting</code> | 'true' to generate browser bundled files; 'false' for node environment only |
|
|
557
|
+
| from | <code>StringSetting</code> | The name to use for the browser-bundled output file (.js will be appended). |
|
|
558
|
+
| name | <code>StringSetting</code> | The search pattern used for retrieving compiled distribution files. |
|
|
559
|
+
| to | <code>StringSetting</code> | The output directory for browser-bundled files. |
|
|
560
|
+
|
|
561
|
+
<a name="module_gulpConfig..DistConfig"></a>
|
|
562
|
+
|
|
563
|
+
### gulpConfig~DistConfig : <code>Object.<string, Setting></code>
|
|
564
|
+
Configurations for building the node distribution files.
|
|
565
|
+
|
|
566
|
+
**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
567
|
+
**Properties**
|
|
568
|
+
|
|
569
|
+
| Name | Type | Description |
|
|
570
|
+
| --- | --- | --- |
|
|
571
|
+
| from | <code>StringSetting</code> | The search pattern used for gathering source files for distribution. |
|
|
572
|
+
| main | <code>StringSetting</code> | Name of the entry the distribution file. |
|
|
573
|
+
| to | <code>StringSetting</code> | The output directory for the distribution files. |
|
|
574
|
+
|
|
575
|
+
<a name="module_gulpConfig..FontConfig"></a>
|
|
576
|
+
|
|
577
|
+
### gulpConfig~FontConfig : <code>Object.<string, Setting></code>
|
|
578
|
+
Configurations for copying the font files.
|
|
579
|
+
|
|
580
|
+
**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
581
|
+
**Properties**
|
|
582
|
+
|
|
583
|
+
| Name | Type | Description |
|
|
584
|
+
| --- | --- | --- |
|
|
585
|
+
| enabled | <code>BooleanSetting</code> | Toggle copy directory of fonts on. |
|
|
586
|
+
| from | <code>StringSetting</code> | Path to search for fonts. |
|
|
587
|
+
| to | <code>StringSetting</code> | Path to output fonts. |
|
|
588
|
+
|
|
589
|
+
<a name="module_gulpConfig..ImageConfig"></a>
|
|
590
|
+
|
|
591
|
+
### gulpConfig~ImageConfig : <code>Object.<string, Setting></code>
|
|
592
|
+
Configurations to minify and copy the images.
|
|
593
|
+
|
|
594
|
+
**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
595
|
+
**Properties**
|
|
596
|
+
|
|
597
|
+
| Name | Type | Description |
|
|
598
|
+
| --- | --- | --- |
|
|
599
|
+
| enabled | <code>BooleanSetting</code> | Toggle image minify and copy process. |
|
|
600
|
+
| from | <code>StringSetting</code> | Path to search for images. |
|
|
601
|
+
| to | <code>StringSetting</code> | Path to output images. |
|
|
602
|
+
|
|
603
|
+
<a name="module_gulpConfig..ReadmeConfig"></a>
|
|
604
|
+
|
|
605
|
+
### gulpConfig~ReadmeConfig : <code>Object.<string, Setting></code>
|
|
606
|
+
Configurations to compile and generate the Readme file.
|
|
607
|
+
|
|
608
|
+
**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
609
|
+
**Properties**
|
|
610
|
+
|
|
611
|
+
| Name | Type | Description |
|
|
612
|
+
| --- | --- | --- |
|
|
613
|
+
| file | <code>StringSetting</code> | The name of the output documentation markdown file. |
|
|
614
|
+
| from | <code>StringSetting</code> | Location of files to use for compiling documentation into the readme. |
|
|
615
|
+
| options | <code>ArrayableSetting</code> | Options for formatting the output readme. |
|
|
616
|
+
| template | <code>StringSetting</code> | The file which will be pre-fixed to your README.md output. |
|
|
617
|
+
| to | <code>StringSetting</code> | The directory to output the readme file in. |
|
|
618
|
+
|
|
619
|
+
<a name="module_gulpConfig..SassConfig"></a>
|
|
620
|
+
|
|
621
|
+
### gulpConfig~SassConfig : <code>Object.<string, Setting></code>
|
|
622
|
+
Configurations to compile and copy the sass files into css.
|
|
623
|
+
|
|
624
|
+
**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
625
|
+
**Properties**
|
|
626
|
+
|
|
627
|
+
| Name | Type | Description |
|
|
628
|
+
| --- | --- | --- |
|
|
629
|
+
| enabled | <code>BooleanSetting</code> | Toggle SASS to CSS process on. |
|
|
630
|
+
| from | <code>StringSetting</code> | The pattern for finding all sass files. |
|
|
631
|
+
| path | <code>StringSetting</code> | The directory were sass files will be stored. |
|
|
632
|
+
| to | <code>StringSetting</code> | The destination path for where generated CSS (from SASS files) should go. |
|
|
633
|
+
|
|
634
|
+
<a name="module_gulpConfig..TestConfig"></a>
|
|
635
|
+
|
|
636
|
+
### gulpConfig~TestConfig : <code>Object.<string, Setting></code>
|
|
637
|
+
Configurations for running the test suite.
|
|
638
|
+
|
|
639
|
+
**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
640
|
+
**Properties**
|
|
641
|
+
|
|
642
|
+
| Name | Type | Description |
|
|
643
|
+
| --- | --- | --- |
|
|
644
|
+
| options | <code>JestTestFlags</code> | Additional flags for programmatically running Jest Cli. |
|
|
645
|
+
| path | <code>ArrayableSetting</code> | The directory where Jest test files are stored. By default, stored as *.test.js adjacent to the files they are testing. |
|
|
646
|
+
| watch | <code>ArrayableSetting</code> | The search pattern for watching files for changes. |
|
|
647
|
+
|
|
648
|
+
<a name="module_gulpConfig..TsConfig"></a>
|
|
649
|
+
|
|
650
|
+
### gulpConfig~TsConfig : <code>Object.<string, Setting></code>
|
|
651
|
+
Configurations for compiling typescript into JS files.
|
|
652
|
+
|
|
653
|
+
**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
654
|
+
**Properties**
|
|
655
|
+
|
|
656
|
+
| Name | Type | Description |
|
|
657
|
+
| --- | --- | --- |
|
|
658
|
+
| config | <code>FlagStringSetting</code> | The path the tsconfig file for running typescript or false if no ts file given. |
|
|
659
|
+
| enabled | <code>BooleanSetting</code> | Toggle usage of typescript parsing. |
|
|
660
|
+
| from | <code>StringSetting</code> | Pattern for finding the TypeScript files. |
|
|
661
|
+
| to | <code>StringSetting</code> | Directory where parsed typescript files go. |
|
|
662
|
+
|
|
663
|
+
<a name="module_gulpConfig..Configurations"></a>
|
|
664
|
+
|
|
665
|
+
### gulpConfig~Configurations : <code>Object.<string, Setting></code>
|
|
666
|
+
A set of Configurations options defined by Settings.
|
|
667
|
+
|
|
668
|
+
**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)
|
|
669
|
+
**Properties**
|
|
670
|
+
|
|
671
|
+
| Name | Type | Description |
|
|
672
|
+
| --- | --- | --- |
|
|
673
|
+
| browser | <code>BrowserConfig</code> | Browser bundling configuration group. |
|
|
674
|
+
| cleanPaths | <code>ArrayableSetting</code> | The paths for directories to delete before build. |
|
|
675
|
+
| dist | <code>DistConfig</code> | Distribution file generation configuration group. |
|
|
676
|
+
| fonts | <code>FontConfig</code> | Fonts copy configuration group. |
|
|
677
|
+
| images | <code>ImageConfig</code> | Minify and copy the images configuration. |
|
|
678
|
+
| readme | <code>ReadmeConfig</code> | Build readme files configuration. |
|
|
679
|
+
| rootPath | <code>StringSetting</code> | Base directory of the project. |
|
|
680
|
+
| sass | <code>SassConfig</code> | Compile CSS from SASS configuration. |
|
|
681
|
+
| srcPath | <code>StringSetting</code> | The directory where your source files are stored (the files you manually created). |
|
|
682
|
+
| test | <code>TestConfig</code> | Run test suite configuration. |
|
|
683
|
+
| typescript | <code>TsConfig</code> | Compile from typescript configuration. |
|
|
684
|
+
|