ember-cli 4.0.0 → 4.1.0-beta.1

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.
Files changed (107) hide show
  1. package/.github/workflows/ci.yml +4 -4
  2. package/CHANGELOG.md +17 -2
  3. package/blueprints/app/files/package.json +2 -2
  4. package/docs/build/data.json +3 -3
  5. package/lib/models/host-info-cache.js +3 -5
  6. package/lib/models/per-bundle-addon-cache/index.js +2 -3
  7. package/lib/utilities/get-lang-arg.js +45 -45
  8. package/package.json +25 -25
  9. package/.github/ISSUE_TEMPLATE.md +0 -12
  10. package/.github/dependabot.yml +0 -15
  11. package/.github/workflows/coverage.yml +0 -31
  12. package/docs/analytics.md +0 -44
  13. package/docs/architecture.md +0 -316
  14. package/docs/assets/architecture/Ember-CLI architecture.png +0 -0
  15. package/docs/assets/architecture/Ember-CLI architecture.xml +0 -1
  16. package/docs/assets/architecture/README.md +0 -5
  17. package/docs/brocfile-transition.md +0 -46
  18. package/docs/build/api.js +0 -44
  19. package/docs/build/assets/css/external-small.png +0 -0
  20. package/docs/build/assets/css/logo.png +0 -0
  21. package/docs/build/assets/css/main.css +0 -555
  22. package/docs/build/assets/favicon.ico +0 -0
  23. package/docs/build/assets/img/spinner.gif +0 -0
  24. package/docs/build/assets/index.html +0 -10
  25. package/docs/build/assets/js/api-filter.js +0 -56
  26. package/docs/build/assets/js/api-list.js +0 -255
  27. package/docs/build/assets/js/api-search.js +0 -98
  28. package/docs/build/assets/js/apidocs.js +0 -376
  29. package/docs/build/assets/js/yui-prettify.js +0 -17
  30. package/docs/build/assets/vendor/prettify/CHANGES.html +0 -130
  31. package/docs/build/assets/vendor/prettify/COPYING +0 -202
  32. package/docs/build/assets/vendor/prettify/README.html +0 -203
  33. package/docs/build/assets/vendor/prettify/prettify-min.css +0 -1
  34. package/docs/build/assets/vendor/prettify/prettify-min.js +0 -1
  35. package/docs/build/classes/Addon.html +0 -4318
  36. package/docs/build/classes/AmdTransformAddon.html +0 -202
  37. package/docs/build/classes/Blueprint.html +0 -4796
  38. package/docs/build/classes/Builder.html +0 -611
  39. package/docs/build/classes/CLI.html +0 -810
  40. package/docs/build/classes/Command.html +0 -1655
  41. package/docs/build/classes/DefaultPackager.html +0 -202
  42. package/docs/build/classes/EmberAddon.html +0 -2207
  43. package/docs/build/classes/EmberApp.html +0 -2225
  44. package/docs/build/classes/HardwareInfo.html +0 -620
  45. package/docs/build/classes/HistorySupportAddon.html +0 -203
  46. package/docs/build/classes/Instrumentation.html +0 -695
  47. package/docs/build/classes/NodeModulesList.html +0 -460
  48. package/docs/build/classes/NpmTask.html +0 -333
  49. package/docs/build/classes/PackageInfo.html +0 -1390
  50. package/docs/build/classes/PackageInfoCache.html +0 -963
  51. package/docs/build/classes/PerBundleAddonCache {.html +0 -1010
  52. package/docs/build/classes/Project.html +0 -2083
  53. package/docs/build/classes/ServeFilesAddon.html +0 -260
  54. package/docs/build/classes/TestsServerAddon.html +0 -203
  55. package/docs/build/classes/WatcherAddon.html +0 -204
  56. package/docs/build/classes/WindowsSymlinkChecker.html +0 -1505
  57. package/docs/build/files/lib_broccoli_default-packager.js.html +0 -1426
  58. package/docs/build/files/lib_broccoli_ember-addon.js.html +0 -159
  59. package/docs/build/files/lib_broccoli_ember-app.js.html +0 -1913
  60. package/docs/build/files/lib_cli_cli.js.html +0 -417
  61. package/docs/build/files/lib_models_addon-info.js.html +0 -112
  62. package/docs/build/files/lib_models_addon.js.html +0 -1866
  63. package/docs/build/files/lib_models_blueprint.js.html +0 -1678
  64. package/docs/build/files/lib_models_builder.js.html +0 -417
  65. package/docs/build/files/lib_models_command.js.html +0 -804
  66. package/docs/build/files/lib_models_hardware-info.js.html +0 -479
  67. package/docs/build/files/lib_models_host-info-cache.js.html +0 -428
  68. package/docs/build/files/lib_models_installation-checker.js.html +0 -181
  69. package/docs/build/files/lib_models_instantiate-addons.js.html +0 -191
  70. package/docs/build/files/lib_models_instrumentation.js.html +0 -433
  71. package/docs/build/files/lib_models_package-info-cache_index.js.html +0 -793
  72. package/docs/build/files/lib_models_package-info-cache_node-modules-list.js.html +0 -208
  73. package/docs/build/files/lib_models_package-info-cache_package-info.js.html +0 -661
  74. package/docs/build/files/lib_models_per-bundle-addon-cache_addon-proxy.js.html +0 -252
  75. package/docs/build/files/lib_models_per-bundle-addon-cache_index.js.html +0 -485
  76. package/docs/build/files/lib_models_per-bundle-addon-cache_target-instance.js.html +0 -108
  77. package/docs/build/files/lib_models_project.js.html +0 -913
  78. package/docs/build/files/lib_models_task.js.html +0 -117
  79. package/docs/build/files/lib_tasks_build-watch.js.html +0 -157
  80. package/docs/build/files/lib_tasks_npm-task.js.html +0 -463
  81. package/docs/build/files/lib_tasks_serve.js.html +0 -207
  82. package/docs/build/files/lib_tasks_server_middleware_broccoli-serve-files_index.js.html +0 -127
  83. package/docs/build/files/lib_tasks_server_middleware_broccoli-watcher_index.js.html +0 -158
  84. package/docs/build/files/lib_tasks_server_middleware_history-support_index.js.html +0 -181
  85. package/docs/build/files/lib_tasks_server_middleware_tests-server_index.js.html +0 -171
  86. package/docs/build/files/lib_tasks_test-server.js.html +0 -167
  87. package/docs/build/files/lib_tasks_transforms_amd_index.js.html +0 -143
  88. package/docs/build/files/lib_utilities_ember-app-utils.js.html +0 -292
  89. package/docs/build/files/lib_utilities_insert-into-file.js.html +0 -219
  90. package/docs/build/files/lib_utilities_is-lazy-engine.js.html +0 -125
  91. package/docs/build/files/lib_utilities_is-yarn-project.js.html +0 -120
  92. package/docs/build/files/lib_utilities_valid-project-name.js.html +0 -142
  93. package/docs/build/files/lib_utilities_will-interrupt-process.js.html +0 -290
  94. package/docs/build/files/lib_utilities_windows-admin.js.html +0 -230
  95. package/docs/build/index.html +0 -125
  96. package/docs/build/modules/ember-cli.html +0 -152
  97. package/docs/build/modules/is-lazy-engine.html +0 -106
  98. package/docs/build-concurrency.md +0 -15
  99. package/docs/build-pipeline-debugging.md +0 -33
  100. package/docs/code-coverage.md +0 -14
  101. package/docs/error-propagation.md +0 -136
  102. package/docs/experiments.md +0 -53
  103. package/docs/node-support.md +0 -43
  104. package/docs/perf-guide.md +0 -250
  105. package/docs/project_version_preprocessor.js +0 -8
  106. package/docs/sourcemaps.md +0 -60
  107. package/docs/yuidoc.json +0 -13
@@ -1,695 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>Instrumentation - ember-cli</title>
6
- <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
7
- <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
8
- <script src="https://cdnjs.cloudflare.com/ajax/libs/yui/3.18.0/yui/yui-min.js"></script>
9
- </head>
10
- <body class="yui3-skin-sam">
11
-
12
- <div id="doc">
13
- <div class="yui3-g">
14
- <div id="sidebar" class="yui3-u">
15
- <div class="logo">
16
- <a href="../index.html">
17
- <img src="https://ember-cli.com/assets/images/ember-cli-logo-small-dark.png">
18
- </a>
19
- </div>
20
-
21
- <div id="modules" class="sidebox">
22
- <div class="hd">
23
- <h2 class="no-toc">Modules</h2>
24
- </div>
25
- <div class="bd">
26
- <ul>
27
- <li><a href="../modules/ember-cli.html">ember-cli</a>
28
- </li>
29
- <li><a href="../modules/is-lazy-engine.html">is-lazy-engine</a>
30
- </li>
31
- </ul>
32
- </div>
33
- </div>
34
-
35
- <div id="classes" class="sidebox">
36
- <div class="hd">
37
- <h2 class="no-toc">Classes</h2>
38
- </div>
39
- <div class="bd">
40
- <ul>
41
- <li><a href="../classes/Addon.html">Addon</a></li>
42
- <li><a href="../classes/AmdTransformAddon.html">AmdTransformAddon</a></li>
43
- <li><a href="../classes/Blueprint.html">Blueprint</a></li>
44
- <li><a href="../classes/Builder.html">Builder</a></li>
45
- <li><a href="../classes/CLI.html">CLI</a></li>
46
- <li><a href="../classes/Command.html">Command</a></li>
47
- <li><a href="../classes/DefaultPackager.html">DefaultPackager</a></li>
48
- <li><a href="../classes/EmberAddon.html">EmberAddon</a></li>
49
- <li><a href="../classes/EmberApp.html">EmberApp</a></li>
50
- <li><a href="../classes/HardwareInfo.html">HardwareInfo</a></li>
51
- <li><a href="../classes/HistorySupportAddon.html">HistorySupportAddon</a></li>
52
- <li><a href="../classes/Instrumentation.html">Instrumentation</a></li>
53
- <li><a href="../classes/NodeModulesList.html">NodeModulesList</a></li>
54
- <li><a href="../classes/NpmTask.html">NpmTask</a></li>
55
- <li><a href="../classes/PackageInfo.html">PackageInfo</a></li>
56
- <li><a href="../classes/PackageInfoCache.html">PackageInfoCache</a></li>
57
- <li><a href="../classes/PerBundleAddonCache {.html">PerBundleAddonCache {</a></li>
58
- <li><a href="../classes/Project.html">Project</a></li>
59
- <li><a href="../classes/ServeFilesAddon.html">ServeFilesAddon</a></li>
60
- <li><a href="../classes/TestsServerAddon.html">TestsServerAddon</a></li>
61
- <li><a href="../classes/WatcherAddon.html">WatcherAddon</a></li>
62
- <li><a href="../classes/WindowsSymlinkChecker.html">WindowsSymlinkChecker</a></li>
63
- </ul>
64
- </div>
65
- </div>
66
-
67
-
68
- <div id="sections" class="sidebox">
69
- <div class="hd">
70
- <h2 class="no-toc">Instrumentation</h2>
71
- </div>
72
- <div class="bd">
73
-
74
-
75
-
76
-
77
- <div><a href="#method-summary">Method Summary</a></div>
78
-
79
-
80
-
81
-
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
- <div><a href="#public-methods">Public Methods</a></div>
92
- <ul>
93
- <li><a href="#method_checkInstallations">checkInstallations</a></li>
94
- <li><a href="#method_findLCAHost">findLCAHost</a></li>
95
- <li><a href="#method_getHostAddonInfo">getHostAddonInfo</a></li>
96
- <li><a href="#method_instantiateAddons">instantiateAddons</a></li>
97
- </ul>
98
-
99
-
100
- <div><a href="#private-methods">Private Methods</a></div>
101
- <ul>
102
- <li><a href="#method__findNearestBundleHost">_findNearestBundleHost</a></li>
103
- <li><a href="#method__getBundledPackageInfos">_getBundledPackageInfos</a></li>
104
- </ul>
105
- </div>
106
- </div>
107
-
108
-
109
-
110
- <div class="version-info">
111
- Version: 4.0.0-release-b4cbb1029f
112
- </div>
113
-
114
- </div>
115
-
116
- <div id="main" class="yui3-u">
117
- <div class="content"><div class="title">
118
- <span class="source-link"><a href="../files/lib_models_instrumentation.js.html#l38"><code>lib&#x2F;models&#x2F;instrumentation.js:38</code></a></span>
119
- <h1 class="class-name">Instrumentation</h1>
120
- </div>
121
-
122
-
123
-
124
-
125
- <div class="class-description"><p>An instance of this class is used for invoking the instrumentation
126
- hooks on addons.</p>
127
- <p>The instrumentation types currently supported are:</p>
128
- <ul>
129
- <li>init</li>
130
- <li>build</li>
131
- <li>command</li>
132
- <li>shutdown</li>
133
- </ul>
134
- </div>
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
- <h2 id="method-summary">Method Summary</h2>
144
-
145
- <table class="summary">
146
- <thead>
147
- <tr>
148
- <th colspan="2">Public Methods</th>
149
- </tr>
150
- </thead>
151
- <tbody>
152
- <tr>
153
- <td>
154
- public
155
-
156
-
157
- </td>
158
- <td>
159
- <div class="method-name ">
160
- <a href="#method_checkInstallations">checkInstallations</a>( )
161
- </div>
162
- <div class="short-description">
163
- <p>Check if npm and bower installation directories are present, and raise an error message with instructions on how to proceed.</p>
164
- </div>
165
- </td>
166
- </tr>
167
- <tr>
168
- <td>
169
- public
170
-
171
-
172
- </td>
173
- <td>
174
- <div class="method-name ">
175
- <a href="#method_findLCAHost">findLCAHost</a>(engineInstance): EngineAddon | <a href="../classes/EmberApp.html" class="crosslink">EmberApp</a>
176
- </div>
177
- <div class="short-description">
178
- <p>This returns the LCA host for a given engine; we use the associated package info to compute this (see <code>getHostAddonInfo</code> above); this finds the lowest common ancestor that is considered a host amongst <em>all</em> engines by the same name in the project. This function is intended to replace the original behavior in <code>ember-engines</code>.</p>
179
- </div>
180
- </td>
181
- </tr>
182
- <tr>
183
- <td>
184
- public
185
-
186
-
187
- </td>
188
- <td>
189
- <div class="method-name ">
190
- <a href="#method_getHostAddonInfo">getHostAddonInfo</a>(packageInfoForLazyEngine): hostPackageInfo: PackageInfo, hostAndAncestorBundledPackageInfos: Set<PackageInfo>
191
- </div>
192
- <div class="short-description">
193
- <p>This function intends to return a common host for a bundle host (lazy engine). The root package info should be the starting point (i.e., the project's package info). We do this by performing a breadth-first traversal until we find the intended lazy engine (represented as a package-info &amp; the 1st argument passed to this function). As part of the traversal, we keep track of all paths to said engine; then, once we find the intended engine we use this to determine the nearest common host amongst all shortest paths.</p>
194
- </div>
195
- </td>
196
- </tr>
197
- <tr>
198
- <td>
199
- public
200
-
201
-
202
- </td>
203
- <td>
204
- <div class="method-name ">
205
- <a href="#method_instantiateAddons">instantiateAddons</a>(parent, project, a)
206
- </div>
207
- <div class="short-description">
208
- <p>Create instances of a set of "child" addons for a parent addon or project.</p>
209
- </div>
210
- </td>
211
- </tr>
212
- </tbody>
213
- </table>
214
-
215
-
216
- <table class="summary">
217
- <thead>
218
- <tr>
219
- <th colspan="2">Private Methods</th>
220
- </tr>
221
- </thead>
222
- <tbody>
223
- <tr>
224
- <td>
225
- private
226
-
227
-
228
- </td>
229
- <td>
230
- <div class="method-name ">
231
- <a href="#method__findNearestBundleHost">_findNearestBundleHost</a>(paths): PackageInfo, PackageInfo[]
232
- </div>
233
- <div class="short-description">
234
- <p>Given a path (calculated as part of <code>getHostAddonInfo</code>), return the correct "bundle host". A bundle host is considered the project or lazy engine.</p>
235
- </div>
236
- </td>
237
- </tr>
238
- <tr>
239
- <td>
240
- private
241
-
242
-
243
- </td>
244
- <td>
245
- <div class="method-name ">
246
- <a href="#method__getBundledPackageInfos">_getBundledPackageInfos</a>(pkgInfoToStartAt): Set<PackageInfo>
247
- </div>
248
- <div class="short-description">
249
- <p>Returns a <code>Set</code> of package-info objects that a given bundle host is <em>directly</em> responsible for bundling (i.e., it excludes other bundle hosts/lazy engines when it encounters these)</p>
250
- </div>
251
- </td>
252
- </tr>
253
- </tbody>
254
- </table>
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
-
265
-
266
-
267
-
268
- <div id="methods public">
269
- <h2 id="public-methods">Public Methods</h2>
270
- <div class="method item">
271
- <div id="method_checkInstallations" class="title">
272
- <span class="source-link"><a href="../files/lib_models_installation-checker.js.html#l13"><code>lib&#x2F;models&#x2F;installation-checker.js:13</code></a></span>
273
- <h3 class="">
274
- public
275
-
276
-
277
- checkInstallations( )
278
- </h3>
279
- </div>
280
-
281
-
282
-
283
- <div class="method-description"><p>Check if npm and bower installation directories are present,
284
- and raise an error message with instructions on how to proceed.</p>
285
- <p>If some of these package managers aren't being used in the project
286
- we just ignore them. Their usage is considered by checking the
287
- presence of your manifest files: package.json for npm and bower.json for bower.</p>
288
- </div>
289
-
290
-
291
-
292
-
293
- </div>
294
- <div class="method item">
295
- <div id="method_findLCAHost" class="title">
296
- <span class="source-link"><a href="../files/lib_models_host-info-cache.js.html#l272"><code>lib&#x2F;models&#x2F;host-info-cache.js:272</code></a></span>
297
- <h3 class="">
298
- public
299
-
300
-
301
- findLCAHost(engineInstance): EngineAddon | <a href="../classes/EmberApp.html" class="crosslink">EmberApp</a>
302
- </h3>
303
- </div>
304
-
305
-
306
-
307
- <div class="method-description"><p>This returns the LCA host for a given engine; we use the associated package info
308
- to compute this (see <code>getHostAddonInfo</code> above); this finds the lowest common ancestor
309
- that is considered a host amongst <em>all</em> engines by the same name in the project. This
310
- function is intended to replace the original behavior in <code>ember-engines</code>.</p>
311
- <p>For more info, see the original implementation here:</p>
312
- <p><a href="https://github.com/ember-engines/ember-engines/blob/master/packages/ember-engines/lib/utils/find-lca-host.js">https://github.com/ember-engines/ember-engines/blob/master/packages/ember-engines/lib/utils/find-lca-host.js</a></p>
313
- </div>
314
-
315
- <div class="params">
316
- <h4>Parameters:</h4>
317
- <table>
318
- <thead>
319
- <tr>
320
- <th>Name</th>
321
- <th>Type</th>
322
- <th>Attribute</th>
323
- <th>Description</th>
324
- </tr>
325
- </thead>
326
- <tbody>
327
- <tr>
328
- <td>engineInstance</td>
329
- <td>EngineAddon</td>
330
- <td>
331
- <ul>
332
-
333
-
334
-
335
- </ul>
336
- </td>
337
- <td> </td>
338
- </tr>
339
-
340
- </tbody>
341
- </table>
342
- </div>
343
-
344
- <div class="return">
345
- <h4>Return:</h4>
346
- <div>
347
- <span class="return-type">EngineAddon | <a href="../classes/EmberApp.html" class="crosslink">EmberApp</a></span>
348
- <span class="return-description"></span>
349
- </div>
350
- </div>
351
-
352
-
353
- </div>
354
- <div class="method item">
355
- <div id="method_getHostAddonInfo" class="title">
356
- <span class="source-link"><a href="../files/lib_models_host-info-cache.js.html#l147"><code>lib&#x2F;models&#x2F;host-info-cache.js:147</code></a></span>
357
- <h3 class="">
358
- public
359
-
360
-
361
- getHostAddonInfo(packageInfoForLazyEngine): hostPackageInfo: PackageInfo, hostAndAncestorBundledPackageInfos: Set<PackageInfo>
362
- </h3>
363
- </div>
364
-
365
-
366
-
367
- <div class="method-description"><p>This function intends to return a common host for a bundle host (lazy engine). The root
368
- package info should be the starting point (i.e., the project's package info). We do this
369
- by performing a breadth-first traversal until we find the intended lazy engine (represented
370
- as a package-info &amp; the 1st argument passed to this function). As part of the traversal, we keep
371
- track of all paths to said engine; then, once we find the intended engine we use this to determine
372
- the nearest common host amongst all shortest paths.</p>
373
- <p>Some context:</p>
374
- <p>For a given engine/bundle host, this finds the lowest common ancestor that is considered a
375
- host amongst <em>all</em> engines by the same name in the project.</p>
376
- <p>For example, given the following package structure:</p>
377
- <pre class="code prettyprint"><code> --Project--
378
- / \
379
- / \
380
- </code></pre>
381
- <p>Lazy Engine A <br>
382
- Addon A
383
- |
384
- |
385
- Lazy Engine B
386
- / <br>
387
- / <br>
388
- Lazy Engine A Lazy Engine C</p>
389
- <ul>
390
- <li>The LCA host for Lazy Engine A is the project</li>
391
- <li>The LCA host for Lazy Engine B is the project</li>
392
- <li>The LCA host for Lazy Engine C is Lazy Engine B</li>
393
- </ul>
394
- <p>This also returns <code>hostAndAncestorBundledPackageInfos</code>, which are all bundled addons above a given host:</p>
395
- <ul>
396
- <li><code>hostAndAncestorBundledPackageInfos</code> for lazy engine A includes all non-lazy dependencies of its LCA host &amp; above (in this case, just the project)</li>
397
- <li><code>hostAndAncestorBundledPackageInfos</code> for lazy engine B includes all non-lazy dependencies of its LCA host &amp; above (in this case, just the project)</li>
398
- <li><code>hostAndAncestorBundledPackageInfos</code> for lazy engine C includes non-lazy deps of lazy engine B &amp; non-lazy deps of the project (LCA host &amp; above)</li>
399
- </ul>
400
- <p>This is intended to mimic the behavior of <code>ancestorHostAddons</code> in <code>ember-engines</code>:
401
- <a href="https://github.com/ember-engines/ember-engines/blob/master/packages/ember-engines/lib/engine-addon.js#L333">https://github.com/ember-engines/ember-engines/blob/master/packages/ember-engines/lib/engine-addon.js#L333</a></p>
402
- <p>Unfortunately, we can't easily repurpose the logic in <code>ember-engines</code> since the algorithm has to be different;
403
- in <code>ember-engines</code> we need access to the actual addon instance, however, this is intended to be used <em>during</em>
404
- addon instantiation, so we only have access to package-info objects. In having said this, we <em>can</em> repurpose
405
- the <code>hostPackageInfo</code> to determine the LCA host; see below <code>findLCAHost</code>.</p>
406
- </div>
407
-
408
- <div class="params">
409
- <h4>Parameters:</h4>
410
- <table>
411
- <thead>
412
- <tr>
413
- <th>Name</th>
414
- <th>Type</th>
415
- <th>Attribute</th>
416
- <th>Description</th>
417
- </tr>
418
- </thead>
419
- <tbody>
420
- <tr>
421
- <td>packageInfoForLazyEngine</td>
422
- <td><a href="../classes/PackageInfo.html" class="crosslink">PackageInfo</a></td>
423
- <td>
424
- <ul>
425
-
426
-
427
-
428
- </ul>
429
- </td>
430
- <td> </td>
431
- </tr>
432
-
433
- </tbody>
434
- </table>
435
- </div>
436
-
437
- <div class="return">
438
- <h4>Return:</h4>
439
- <div>
440
- <span class="return-type">hostPackageInfo: PackageInfo, hostAndAncestorBundledPackageInfos: Set<PackageInfo></span>
441
- <span class="return-description"><p>}</p>
442
- </span>
443
- </div>
444
- </div>
445
-
446
-
447
- </div>
448
- <div class="method item">
449
- <div id="method_instantiateAddons" class="title">
450
- <span class="source-link"><a href="../files/lib_models_instantiate-addons.js.html#l12"><code>lib&#x2F;models&#x2F;instantiate-addons.js:12</code></a></span>
451
- <h3 class="">
452
- public
453
-
454
-
455
- instantiateAddons(parent, project, a)
456
- </h3>
457
- </div>
458
-
459
-
460
-
461
- <div class="method-description"><p>Create instances of a set of "child" addons for a parent addon or project.</p>
462
- </div>
463
-
464
- <div class="params">
465
- <h4>Parameters:</h4>
466
- <table>
467
- <thead>
468
- <tr>
469
- <th>Name</th>
470
- <th>Type</th>
471
- <th>Attribute</th>
472
- <th>Description</th>
473
- </tr>
474
- </thead>
475
- <tbody>
476
- <tr>
477
- <td>parent</td>
478
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
479
- <td>
480
- <ul>
481
-
482
-
483
-
484
- </ul>
485
- </td>
486
- <td><p>an Addon or Project that is the direct containing object of the list
487
- of children defined in addonPackages.</p>
488
- </td>
489
- </tr>
490
-
491
- <tr>
492
- <td>project</td>
493
- <td><a href="../classes/Project.html" class="crosslink">Project</a></td>
494
- <td>
495
- <ul>
496
-
497
-
498
-
499
- </ul>
500
- </td>
501
- <td><p>the project that contains the parent (so either the addon's project
502
- if parent is an addon, or the project itself if it is a project). It is possible when
503
- constructing custom addon instances that the project will actually be undefined--various
504
- addon tests do this, for example.</p>
505
- </td>
506
- </tr>
507
-
508
- <tr>
509
- <td>a</td>
510
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
511
- <td>
512
- <ul>
513
-
514
-
515
-
516
- </ul>
517
- </td>
518
- <td><p>map of addon name (including scope) to an AddonInfo with the name, path and
519
- 'pkg' object for that addon's package.json). These are what is turned into addons.</p>
520
- </td>
521
- </tr>
522
-
523
- </tbody>
524
- </table>
525
- </div>
526
-
527
-
528
-
529
- </div>
530
- </div>
531
-
532
-
533
- <div id="methods private">
534
- <h2 id="private-methods">Private Methods</h2>
535
- <div class="method item private">
536
- <div id="method__findNearestBundleHost" class="title">
537
- <span class="source-link"><a href="../files/lib_models_host-info-cache.js.html#l16"><code>lib&#x2F;models&#x2F;host-info-cache.js:16</code></a></span>
538
- <h3 class="">
539
- private
540
-
541
-
542
- _findNearestBundleHost(paths): PackageInfo, PackageInfo[]
543
- </h3>
544
- </div>
545
-
546
-
547
-
548
- <div class="method-description"><p>Given a path (calculated as part of <code>getHostAddonInfo</code>), return the correct
549
- "bundle host". A bundle host is considered the project or lazy engine.</p>
550
- <p>For example, given the following package structure:</p>
551
- <pre class="code prettyprint"><code> --Project--
552
- / \
553
- / \
554
- </code></pre>
555
- <p>Lazy Engine A <br>
556
- Addon A
557
- |
558
- |
559
- Lazy Engine B
560
- / <br>
561
- / <br>
562
- Lazy Engine A Lazy Engine C</p>
563
- <p>The provided paths for lazy engine A would look like:</p>
564
- <ul>
565
- <li>[Project]</li>
566
- <li>[Project, Addon A, Lazy Engine B]</li>
567
- </ul>
568
- <p>For this project structure, this function would return [Project, [Project]]</p>
569
- <p>Similarly, given the following project structure:</p>
570
- <pre class="code prettyprint"><code> --Project--
571
- / \
572
- / \
573
- Lazy Engine A \
574
- / Lazy Engine B
575
- / |
576
- / |
577
- </code></pre>
578
- <p>Lazy Engine C Lazy Engine C</p>
579
- <p>The provided paths for lazy engine C would look like:</p>
580
- <ul>
581
- <li>[Project, Lazy Engine A]</li>
582
- <li>[Project, Lazy Engine B]</li>
583
- </ul>
584
- <p>In this case, the host is the project and would also return [Project, [Project]]</p>
585
- </div>
586
-
587
- <div class="params">
588
- <h4>Parameters:</h4>
589
- <table>
590
- <thead>
591
- <tr>
592
- <th>Name</th>
593
- <th>Type</th>
594
- <th>Attribute</th>
595
- <th>Description</th>
596
- </tr>
597
- </thead>
598
- <tbody>
599
- <tr>
600
- <td>paths</td>
601
- <td>Array<PackageInfo></td>
602
- <td>
603
- <ul>
604
-
605
-
606
-
607
- </ul>
608
- </td>
609
- <td><p>The found paths to a given bundle host</p>
610
- </td>
611
- </tr>
612
-
613
- </tbody>
614
- </table>
615
- </div>
616
-
617
- <div class="return">
618
- <h4>Return:</h4>
619
- <div>
620
- <span class="return-type">PackageInfo, PackageInfo[]</span>
621
- <span class="return-description"></span>
622
- </div>
623
- </div>
624
-
625
-
626
- </div>
627
- <div class="method item private">
628
- <div id="method__getBundledPackageInfos" class="title">
629
- <span class="source-link"><a href="../files/lib_models_host-info-cache.js.html#l93"><code>lib&#x2F;models&#x2F;host-info-cache.js:93</code></a></span>
630
- <h3 class="">
631
- private
632
-
633
-
634
- _getBundledPackageInfos(pkgInfoToStartAt): Set<PackageInfo>
635
- </h3>
636
- </div>
637
-
638
-
639
-
640
- <div class="method-description"><p>Returns a <code>Set</code> of package-info objects that a given bundle host is
641
- <em>directly</em> responsible for bundling (i.e., it excludes other bundle
642
- hosts/lazy engines when it encounters these)</p>
643
- </div>
644
-
645
- <div class="params">
646
- <h4>Parameters:</h4>
647
- <table>
648
- <thead>
649
- <tr>
650
- <th>Name</th>
651
- <th>Type</th>
652
- <th>Attribute</th>
653
- <th>Description</th>
654
- </tr>
655
- </thead>
656
- <tbody>
657
- <tr>
658
- <td>pkgInfoToStartAt</td>
659
- <td><a href="../classes/PackageInfo.html" class="crosslink">PackageInfo</a></td>
660
- <td>
661
- <ul>
662
-
663
-
664
-
665
- </ul>
666
- </td>
667
- <td> </td>
668
- </tr>
669
-
670
- </tbody>
671
- </table>
672
- </div>
673
-
674
- <div class="return">
675
- <h4>Return:</h4>
676
- <div>
677
- <span class="return-type">Set<PackageInfo></span>
678
- <span class="return-description"></span>
679
- </div>
680
- </div>
681
-
682
-
683
- </div>
684
- </div>
685
-
686
-
687
- </div>
688
- </div>
689
- </div>
690
- </div>
691
- <script src="../assets/vendor/prettify/prettify-min.js"></script>
692
- <script>prettyPrint();</script>
693
- <script src="../assets/js/yui-prettify.js"></script>
694
- </body>
695
- </html>