-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathember-cli-5.3.0-Addon.json
1236 lines (1236 loc) · 51.2 KB
/
ember-cli-5.3.0-Addon.json
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
{
"data": {
"id": "ember-cli-5.3.0-Addon",
"type": "class",
"attributes": {
"name": "Addon",
"shortname": "Addon",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-cli",
"namespace": "",
"file": "lib/models/addon.js",
"line": 122,
"description": "<html><head></head><body><p>Root class for an Addon. If your addon module exports an Object this\nwill be extended from this base class. If you export a constructor (function),\nit will <strong>not</strong> extend from this class.</p>\n<p>Hooks:</p>\n<ul>\n<li>{{#crossLink \"Addon/config:method\"}}{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/blueprintsPath:method\"}}{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/includedCommands:method\"}}{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/importTransforms:method\"}}{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/serverMiddleware:method\"}}{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/testemMiddleware:method\"}}{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/postBuild:method\"}}{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/preBuild:method\"}}{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/outputReady:method\"}}{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/buildError:method\"}}{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/included:method\"}}{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/shouldIncludeChildAddon:method\"}}{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/setupPreprocessorRegistry:method\"}}{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/preprocessTree:method\"}}{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/postprocessTree:method\"}}{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/lintTree:method\"}}{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/contentFor:method\"}}{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/treeFor:method\"}}{{/crossLink}}</li>\n</ul>\n</body></html>",
"extends": "CoreObject",
"is_constructor": 1,
"params": [
{
"name": "parent",
"description": "The project or addon that directly depends on this addon",
"type": "Project|Addon"
},
{
"name": "project",
"description": "The current project (deprecated)",
"type": "Project"
}
],
"methods": [
{
"file": "lib/models/addon.js",
"line": 239,
"description": "<html><head></head><body><p>Initializes the addon. If you override this method make sure and call <code>this._super.init && this._super.init.apply(this, arguments);</code> or your addon will not work.</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "init",
"params": [
{
"name": "parent",
"description": "The project or addon that directly depends on this addon",
"type": "Project|Addon"
},
{
"name": "project",
"description": "The current project (deprecated)",
"type": "Project"
}
],
"example": [
"\n```js\ninit(parent, project) {\n this._super.init && this._super.init.apply(this, arguments);\n this._someCustomSetup();\n}\n```"
],
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 320,
"description": "<html><head></head><body><p>Find an addon of the current addon.</p>\n<p>Example: ember-data depends on ember-cli-babel and wishes to have\nadditional control over transpilation this method helps.</p>\n<div class=\"highlight javascript\">\n <div class=\"ribbon\"></div>\n <div class=\"scroller\">\n <table class=\"CodeRay\">\n <tbody>\n <tr>\n <td class=\"line-numbers\"><pre>1\n2\n3\n4\n5\n6\n7\n8\n</pre></td>\n <td class=\"code\"><pre><span class=\"comment\">// ember-data/index.js</span>\n<span class=\"title function_\">treeForAddon</span>(<span class=\"params\">tree</span>) {\n <span class=\"keyword\">let</span> babel = <span class=\"variable language_\">this</span>.<span class=\"title function_\">findOwnAddonByName</span>(<span class=\"string\">'ember-cli-babel'</span>);\n\n <span class=\"keyword\">return</span> babel.<span class=\"title function_\">transpileTree</span>(tree, {\n <span class=\"comment\">// customize the babel step (see: ember-cli-addons readme for more details);</span>\n });\n}</pre></td>\n </tr>\n </tbody>\n </table>\n </div>\n </div>\n \n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "findOwnAddonByName",
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 344,
"description": "<html><head></head><body><p>Check if the current addon intends to be hinted. Typically this is for\nhinting/linting libraries such as eslint or jshint</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "hintingEnabled",
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 359,
"description": "<html><head></head><body><p>Shorthand method for <a href=\"https://github.com/ember-cli/broccoli-concat\">broccoli-concat</a></p>\n</body></html>",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "concatFiles",
"params": [
{
"name": "tree",
"description": "Tree of files",
"type": "Tree"
},
{
"name": "options",
"description": "Options for broccoli-concat",
"type": "Object"
}
],
"return": {
"description": "Modified tree",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 373,
"description": "<html><head></head><body><p>Allows to mark the addon as developing, triggering live-reload in the project the addon is linked to.</p>\n<h4 id=\"uses\">Uses:</h4>\n<ul>\n<li>Working on projects with internal addons</li>\n</ul>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "isDevelopingAddon",
"return": {
"description": "",
"type": "Boolean"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 409,
"description": "<html><head></head><body><p>Discovers all child addons of this addon and an AddonInfo about\neach addon in this.addonPackages (keyed on addon name).</p>\n<p>Child addons include those from 'dependencies' (not devDependencies)\nand in-repo addons</p>\n<p>Any packageInfos that we find that are marked as not valid are excluded.</p>\n</body></html>",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "discoverAddons",
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 459,
"description": "<html><head></head><body><p>Invoke the specified method for each enabled addon.</p>\n</body></html>",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "eachAddonInvoke",
"params": [
{
"name": "methodName",
"description": "the method to invoke on each addon",
"type": "String"
},
{
"name": "args",
"description": "the arguments to pass to the invoked method",
"type": "Array"
}
],
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 484,
"description": "<html><head></head><body><p>Invoke the specified method for each of the project's addons.</p>\n</body></html>",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_eachProjectAddonInvoke",
"params": [
{
"name": "methodName",
"description": "the method to invoke on each addon",
"type": "String"
},
{
"name": "args",
"description": "the arguments to pass to the invoked method",
"type": "Array"
}
],
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 517,
"description": "<html><head></head><body><p>Generates a tree for the specified path</p>\n</body></html>",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "treeGenerator",
"return": {
"description": "",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 552,
"description": "<html><head></head><body><p>Returns a given type of tree (if present), merged with the\napplication tree. For each of the trees available using this\nmethod, you can also use a direct method called <code>treeFor[Type]</code> (eg. <code>treeForApp</code>).</p>\n<p>Available tree names:</p>\n<ul>\n<li>{{#crossLink \"Addon/treeForApp:method\"}}app{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/treeForStyles:method\"}}styles{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/treeForTemplates:method\"}}templates{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/treeForAddonTemplates:method\"}}addon-templates{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/treeForAddon:method\"}}addon{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/treeForVendor:method\"}}vendor{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/treeForTestSupport:method\"}}test-support{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/treeForAddonTestSupport:method\"}}addon-test-support{{/crossLink}}</li>\n<li>{{#crossLink \"Addon/treeForPublic:method\"}}public{{/crossLink}}</li>\n</ul>\n<h4 id=\"uses\">Uses:</h4>\n<ul>\n<li>manipulating trees at build time</li>\n</ul>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "treeFor",
"params": [
{
"name": "name",
"description": "",
"type": "String"
}
],
"return": {
"description": "",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 618,
"access": "private",
"tagname": "",
"params": [
{
"name": "name",
"description": "",
"type": "String"
}
],
"itemtype": "method",
"name": "_treeFor",
"return": {
"description": "",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 640,
"description": "<html><head></head><body><p>Calculates a cacheKey for the given treeType. It is expected to return a\ncache key allowing multiple builds of the same tree to simply return the\noriginal tree (preventing duplicate work). If it returns null / undefined\nthe tree in question will opt out of this caching system.</p>\n<p>This method is invoked prior to calling treeFor with the same tree name.</p>\n<p>You should override this method if you implement custom treeFor or treeFor*\nmethods, which cause addons to opt-out of this caching.</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "cacheKeyForTree",
"params": [
{
"name": "treeType",
"description": "",
"type": "String"
}
],
"return": {
"description": "cacheKey",
"type": "String"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 682,
"description": "<html><head></head><body><p>This method climbs up the hierarchy of addons\nup to the host application.</p>\n<p>This prevents previous addons (prior to <code>this.import</code>, ca 2.7.0)\nto break at importing assets when they are used nested in other addons.</p>\n</body></html>",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_findHost",
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 705,
"description": "<html><head></head><body><p>This method is called when the addon is included in a build. You\nwould typically use this hook to perform additional imports</p>\n<h4 id=\"uses\">Uses:</h4>\n<ul>\n<li>including vendor files</li>\n<li>setting configuration options</li>\n</ul>\n<p><em>Note:</em> Any options set in the consuming application will override the addon.</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "included",
"params": [
{
"name": "parent",
"description": "The parent object which included this addon",
"type": "EmberApp|EmberAddon"
}
],
"example": [
"\n```js\nincluded(parent) {\n this._super.included.apply(this, arguments);\n this.import(somePath);\n}\n```"
],
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 738,
"description": "<html><head></head><body><p>Imports an asset into this addon.</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "import",
"params": [
{
"name": "asset",
"description": "Either a path to the asset or an object with environment names and paths as key-value pairs.",
"type": "Object|String"
},
{
"name": "options",
"description": "Options object",
"type": "Object",
"optional": true,
"props": [
{
"name": "type",
"description": "Either 'vendor' or 'test', defaults to 'vendor'",
"type": "String",
"optional": true
},
{
"name": "prepend",
"description": "Whether or not this asset should be prepended, defaults to false",
"type": "Boolean",
"optional": true
},
{
"name": "destDir",
"description": "Destination directory, defaults to the name of the directory the asset is in",
"type": "String",
"optional": true
}
]
}
],
"since": "2.7.0",
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 758,
"description": "<html><head></head><body><p>Returns the tree for all app files</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "treeForApp",
"params": [
{
"name": "tree",
"description": "",
"type": "Tree"
}
],
"return": {
"description": "App file tree",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 770,
"description": "<html><head></head><body><p>Returns the tree for all template files</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "treeForTemplates",
"params": [
{
"name": "tree",
"description": "",
"type": "Tree"
}
],
"return": {
"description": "Template file tree",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 782,
"description": "<html><head></head><body><p>Returns the tree for this addon's templates</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "treeForAddonTemplates",
"params": [
{
"name": "tree",
"description": "",
"type": "Tree"
}
],
"return": {
"description": "Addon Template file tree",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 794,
"description": "<html><head></head><body><p>Returns a tree for this addon</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "treeForAddon",
"params": [
{
"name": "tree",
"description": "",
"type": "Tree"
}
],
"return": {
"description": "Addon file tree",
"type": "Tree"
},
"example": [
"\n```js\ntreeForAddon() {\n let emberVersion = new VersionChecker(this.project).for('ember-source');\n let shouldUsePolyfill = emberVersion.lt('4.5.0-alpha.4');\n\n if (shouldUsePolyfill) {\n return this._super.treeForAddon.apply(this, arguments);\n }\n}\n```"
],
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 825,
"description": "<html><head></head><body><p>Returns the tree for all style files</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "treeForStyles",
"params": [
{
"name": "tree",
"description": "The tree to process, usually `app/styles/` in the addon.",
"type": "Tree"
}
],
"return": {
"description": "The return tree has the same contents as the input tree, but is moved so that the `app/styles/` path is preserved.",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 844,
"description": "<html><head></head><body><p>Returns the tree for all vendor files</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "treeForVendor",
"params": [
{
"name": "tree",
"description": "",
"type": "Tree"
}
],
"return": {
"description": "Vendor file tree",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 856,
"description": "<html><head></head><body><p>Returns the tree for all test support files</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "treeForTestSupport",
"params": [
{
"name": "tree",
"description": "",
"type": "Tree"
}
],
"return": {
"description": "Test Support file tree",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 868,
"description": "<html><head></head><body><p>Returns the tree for all public files</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "treeForPublic",
"params": [
{
"name": "tree",
"description": "",
"type": "Tree"
}
],
"return": {
"description": "Public file tree",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 888,
"description": "<html><head></head><body><p>Returns the tree for all test files namespaced to a given addon.</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "treeForAddonTestSupport",
"params": [
{
"name": "tree",
"description": "",
"type": "Tree"
}
],
"return": {
"description": "",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 922,
"description": "<html><head></head><body><p>Runs the styles tree through preprocessors.</p>\n</body></html>",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "compileStyles",
"params": [
{
"name": "addonStylesTree",
"description": "Styles file tree",
"type": "Tree"
}
],
"return": {
"description": "Compiled styles tree",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 947,
"description": "<html><head></head><body><p>Looks in the addon/ and addon/templates trees to determine if template files\nexist that need to be precompiled.</p>\n<p>This is executed once when building, but not on rebuilds.</p>\n</body></html>",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "shouldCompileTemplates",
"return": {
"description": "indicates if templates need to be compiled for this addon",
"type": "Boolean"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 961,
"description": "<html><head></head><body><p>Looks in the addon/ and addon/templates trees to determine if template files\nexist in the pods format that need to be precompiled.</p>\n<p>This is executed once when building, but not on rebuilds.</p>\n</body></html>",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_shouldCompilePodTemplates",
"return": {
"description": "indicates if pod based templates need to be compiled for this addon",
"type": "Boolean"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1079,
"description": "<html><head></head><body><p>Runs the templates tree through preprocessors.</p>\n</body></html>",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "compileTemplates",
"params": [
{
"name": "tree",
"description": "Templates file tree",
"type": "Tree"
}
],
"return": {
"description": "Compiled templates tree",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1113,
"description": "<html><head></head><body><p>Runs the addon tree through preprocessors.</p>\n</body></html>",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "compileAddon",
"params": [
{
"name": "tree",
"description": "Addon file tree",
"type": "Tree"
}
],
"return": {
"description": "Compiled addon tree",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1157,
"description": "<html><head></head><body><p>Returns a tree with JSHint output for all addon JS.</p>\n</body></html>",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "jshintAddonTree",
"return": {
"description": "Tree with JShint output (tests)",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1223,
"description": "<html><head></head><body><p>Preprocesses a javascript tree.</p>\n</body></html>",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "preprocessJs",
"return": {
"description": "Preprocessed javascript",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1234,
"description": "<html><head></head><body><p>Returns a tree with all javascript for this addon.</p>\n</body></html>",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "processedAddonJsFiles",
"params": [
{
"name": "the",
"description": "tree to preprocess",
"type": "Tree"
}
],
"return": {
"description": "Processed javascript file tree",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1263,
"description": "<html><head></head><body><p>Returns the module name for this addon.</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "moduleName",
"return": {
"description": "module name",
"type": "String"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1278,
"description": "<html><head></head><body><p>Returns the path for addon blueprints.</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "blueprintsPath",
"return": {
"description": "The path for blueprints",
"type": "String"
},
"example": [
"\n- [ember-cli-coffeescript](https://github.com/kimroen/ember-cli-coffeescript/blob/v1.13.2/index.js#L26)"
],
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1296,
"description": "<html><head></head><body><p>Augments the application's configuration settings.</p>\n<p>Object returned from this hook is merged with the application's configuration object.</p>\n<p>Application's configuration always take precedence.</p>\n<h4 id=\"uses\">Uses:</h4>\n<ul>\n<li>Modifying configuration options (see list of defaults <a href=\"https://github.com/ember-cli/ember-cli/blob/v2.4.3/lib/broccoli/ember-app.js#L163\">here</a>)<ul>\n<li>For example<ul>\n<li><code>storeConfigInMeta</code></li>\n<li>et, al</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "config",
"params": [
{
"name": "env",
"description": "Name of current environment (ie \"development\")",
"type": "String"
},
{
"name": "baseConfig",
"description": "Initial application configuration",
"type": "Object"
}
],
"return": {
"description": "Configuration object to be merged with application configuration.",
"type": "Object"
},
"example": [
"\n```js\nconfig(environment, appConfig) {\n return {\n someAddonDefault: \"foo\"\n };\n}\n```"
],
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1335,
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "dependencies",
"return": {
"description": "The addon's dependencies based on the addon's package.json",
"type": "Object"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1345,
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "isEnabled",
"return": {
"description": "Whether or not this addon is enabled",
"type": "Boolean"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1354,
"description": "<html><head></head><body><p>Can be used to exclude addons from being added as a child addon.</p>\n<h4 id=\"uses\">Uses:</h4>\n<ul>\n<li>Abstract away multiple addons while only including one into the built assets</li>\n</ul>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "shouldIncludeChildAddon",
"params": [
{
"name": "childAddon",
"description": "",
"type": "Addon"
}
],
"return": {
"description": "Whether or not a child addon is supposed to be included",
"type": "Boolean"
},
"example": [
"\n```js\nshouldIncludeChildAddon(childAddon) {\n if(childAddon.name === 'ember-cli-some-legacy-select-component') {\n return this.options.legacyMode;\n } else if(childAddon.name === 'ember-cli-awesome-new-select-component') {\n return !this.options.legacyMode;\n } else {\n return this._super.shouldIncludeChildAddon.apply(this, arguments);\n }\n}\n```"
],
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1386,
"description": "<html><head></head><body><p>Allows the specification of custom addon commands.\nExpects you to return an object whose key is the name of the command and value is the command instance..</p>\n<p>This function is not implemented by default</p>\n<h4 id=\"uses\">Uses:</h4>\n<ul>\n<li>Include custom commands into consuming application</li>\n</ul>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "includedCommands",
"return": {
"description": "An object with included commands",
"type": "Object"
},
"example": [
"\n```js\nincludedCommands() {\n return {\n 'do-foo': require('./lib/commands/foo')\n };\n}\n```"
],
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1410,
"description": "<html><head></head><body><p>Allows addons to define a custom transform function that other addons and app can use when using <code>app.import</code>.</p>\n<p>This function is not implemented by default</p>\n<h4 id=\"uses\">Uses:</h4>\n<ul>\n<li>An app or addons want to transform a dependency that is being imported using <code>app.import</code>.</li>\n</ul>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "importTransforms",
"return": {
"description": "An object with custom transforms",
"type": "Object"
},
"example": [
"\n```js\nimportTransforms() {\n return {\n 'my-custom-transform': function(tree, options) {\n // transform the incoming tree and return the updated tree\n }\n };\n}\n```\n\nAlternatively, if you want to process `options` before being passed into the custom transform function, use:",
"\n```js\nimportTransforms() {\n return {\n 'my-custom-transform': {\n transform: function(tree, options) {\n // transform the incoming tree and return the updated tree\n },\n processOptions: function(assetPath, entry, options) {\n // process your options\n\n return options\n }\n };\n}\n```"
],
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1454,
"description": "<html><head></head><body><p>Pre-process a tree</p>\n<h4 id=\"uses\">Uses:</h4>\n<ul>\n<li>removing / adding files from the build.</li>\n</ul>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "preprocessTree",
"params": [
{
"name": "type",
"description": "What kind of tree (eg. 'js', 'css', 'template')",
"type": "String"
},
{
"name": "tree",
"description": "Tree to process",
"type": "Tree"
}
],
"return": {
"description": "Processed tree",
"type": "Tree"
},
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1468,
"description": "<html><head></head><body><p>Post-process a tree</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "postprocessTree",
"params": [
{
"name": "type",
"description": "What kind of tree (eg. 'js', 'css', 'template')",
"type": "String"
},
{
"name": "tree",
"description": "Tree to process",
"type": "Tree"
}
],
"return": {
"description": "Processed tree",
"type": "Tree"
},
"example": [
"\n- [broccoli-asset-rev](https://github.com/rickharrison/broccoli-asset-rev/blob/c82c3580855554a31f7d6600b866aecf69cdaa6d/index.js#L29)"
],
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1481,
"description": "<html><head></head><body><p>This hook allows you to make changes to the express server run by ember-cli.</p>\n<p>It's passed a <code>startOptions</code> object which contains:</p>\n<ul>\n<li><code>app</code> Express server instance</li>\n<li><code>options</code> A hash with:<ul>\n<li><code>project</code> Current {{#crossLink \"Project\"}}project{{/crossLink}}</li>\n<li><code>watcher</code></li>\n<li><code>environment</code></li>\n</ul>\n</li>\n</ul>\n<p>This function is not implemented by default</p>\n<h4 id=\"uses\">Uses:</h4>\n<ul>\n<li>Tacking on headers to each request</li>\n<li>Modifying the request object</li>\n</ul>\n<p><em>Note:</em> that this should only be used in development, and if you need the same behavior in production you'll\nneed to configure your server.</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "serverMiddleware",
"params": [
{
"name": "startOptions",
"description": "Express server start options",
"type": "Object"
}
],
"example": [
"\n```js\nserverMiddleware(startOptions) {\n var app = startOptions.app;\n\n app.use(function(req, res, next) {\n // Some middleware\n });\n}\n```\n\n- [ember-cli-content-security-policy](https://github.com/rwjblue/ember-cli-content-security-policy/blob/v0.5.0/index.js#L84)\n- [history-support-addon](https://github.com/ember-cli/ember-cli/blob/v2.4.3/lib/tasks/server/middleware/history-support/index.js#L25)"
],
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1520,
"description": "<html><head></head><body><p>This hook allows you to make changes to the express server run by testem.</p>\n<p>This function is not implemented by default</p>\n<h4 id=\"uses\">Uses:</h4>\n<ul>\n<li>Adding custom test-specific endpoints</li>\n<li>Manipulating HTTP requests in tests</li>\n</ul>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "testemMiddleware",
"params": [
{
"name": "app",
"description": "the express app instance",
"type": "Object"
}
],
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1535,
"description": "<html><head></head><body><p>This hook is called before a build takes place.</p>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "preBuild",
"params": [
{
"name": "result",
"description": "Build object",
"type": "Object"
}
],
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1543,
"description": "<html><head></head><body><p>This hook is called after a build is complete.</p>\n<p>It's passed a <code>result</code> object which contains:</p>\n<ul>\n<li><code>directory</code> Path to build output</li>\n</ul>\n<h4 id=\"uses\">Uses:</h4>\n<ul>\n<li>Slow tree listing</li>\n<li>May be used to manipulate your project after build has happened</li>\n</ul>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "postBuild",
"params": [
{
"name": "result",
"description": "Build result object",
"type": "Object"
}
],
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1559,
"description": "<html><head></head><body><p>This hook is called after the build has been processed and the build files have been copied to the output directory</p>\n<p>It's passed a <code>result</code> object which contains:</p>\n<ul>\n<li><code>directory</code> Path to build output</li>\n</ul>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "outputReady",
"params": [
{
"name": "result",
"description": "Build result object",
"type": "Object"
}
],
"example": [
"\n- Opportunity to symlink or copy files elsewhere.\n- [ember-cli-rails-addon](https://github.com/rondale-sc/ember-cli-rails-addon/blob/v0.7.0/index.js#L45)\n - In this case we are using this in tandem with a rails middleware to remove a lock file.\n This allows our ruby gem to block incoming requests until after the build happens reliably."
],
"class": "Addon",
"module": "ember-cli"
},
{
"file": "lib/models/addon.js",
"line": 1576,
"description": "<html><head></head><body><p>This hook is called when an error occurs during the preBuild, postBuild or outputReady hooks\nfor addons, or when the build fails</p>\n<h4 id=\"uses\">Uses:</h4>\n<ul>\n<li>Custom error handling during build process</li>\n</ul>\n</body></html>",
"access": "public",
"tagname": "",
"itemtype": "method",
"name": "buildError",
"params": [