ember-cli 4.0.0 → 4.2.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 (115) hide show
  1. package/.github/workflows/ci.yml +8 -4
  2. package/CHANGELOG.md +43 -2
  3. package/README.md +1 -1
  4. package/blueprints/addon/additional-dev-dependencies.json +1 -1
  5. package/blueprints/addon/files/CONTRIBUTING.md +1 -1
  6. package/blueprints/app/files/README.md +2 -2
  7. package/blueprints/app/files/package.json +8 -8
  8. package/docs/build/data.json +64 -3
  9. package/lib/debug/assert.js +37 -0
  10. package/lib/debug/deprecate.js +111 -0
  11. package/lib/debug/index.js +6 -0
  12. package/lib/models/host-info-cache.js +3 -5
  13. package/lib/models/per-bundle-addon-cache/index.js +2 -3
  14. package/lib/tasks/npm-task.js +1 -1
  15. package/lib/utilities/get-lang-arg.js +45 -45
  16. package/package.json +31 -31
  17. package/.github/ISSUE_TEMPLATE.md +0 -12
  18. package/.github/dependabot.yml +0 -15
  19. package/.github/workflows/coverage.yml +0 -31
  20. package/docs/analytics.md +0 -44
  21. package/docs/architecture.md +0 -316
  22. package/docs/assets/architecture/Ember-CLI architecture.png +0 -0
  23. package/docs/assets/architecture/Ember-CLI architecture.xml +0 -1
  24. package/docs/assets/architecture/README.md +0 -5
  25. package/docs/brocfile-transition.md +0 -46
  26. package/docs/build/api.js +0 -44
  27. package/docs/build/assets/css/external-small.png +0 -0
  28. package/docs/build/assets/css/logo.png +0 -0
  29. package/docs/build/assets/css/main.css +0 -555
  30. package/docs/build/assets/favicon.ico +0 -0
  31. package/docs/build/assets/img/spinner.gif +0 -0
  32. package/docs/build/assets/index.html +0 -10
  33. package/docs/build/assets/js/api-filter.js +0 -56
  34. package/docs/build/assets/js/api-list.js +0 -255
  35. package/docs/build/assets/js/api-search.js +0 -98
  36. package/docs/build/assets/js/apidocs.js +0 -376
  37. package/docs/build/assets/js/yui-prettify.js +0 -17
  38. package/docs/build/assets/vendor/prettify/CHANGES.html +0 -130
  39. package/docs/build/assets/vendor/prettify/COPYING +0 -202
  40. package/docs/build/assets/vendor/prettify/README.html +0 -203
  41. package/docs/build/assets/vendor/prettify/prettify-min.css +0 -1
  42. package/docs/build/assets/vendor/prettify/prettify-min.js +0 -1
  43. package/docs/build/classes/Addon.html +0 -4318
  44. package/docs/build/classes/AmdTransformAddon.html +0 -202
  45. package/docs/build/classes/Blueprint.html +0 -4796
  46. package/docs/build/classes/Builder.html +0 -611
  47. package/docs/build/classes/CLI.html +0 -810
  48. package/docs/build/classes/Command.html +0 -1655
  49. package/docs/build/classes/DefaultPackager.html +0 -202
  50. package/docs/build/classes/EmberAddon.html +0 -2207
  51. package/docs/build/classes/EmberApp.html +0 -2225
  52. package/docs/build/classes/HardwareInfo.html +0 -620
  53. package/docs/build/classes/HistorySupportAddon.html +0 -203
  54. package/docs/build/classes/Instrumentation.html +0 -695
  55. package/docs/build/classes/NodeModulesList.html +0 -460
  56. package/docs/build/classes/NpmTask.html +0 -333
  57. package/docs/build/classes/PackageInfo.html +0 -1390
  58. package/docs/build/classes/PackageInfoCache.html +0 -963
  59. package/docs/build/classes/PerBundleAddonCache {.html +0 -1010
  60. package/docs/build/classes/Project.html +0 -2083
  61. package/docs/build/classes/ServeFilesAddon.html +0 -260
  62. package/docs/build/classes/TestsServerAddon.html +0 -203
  63. package/docs/build/classes/WatcherAddon.html +0 -204
  64. package/docs/build/classes/WindowsSymlinkChecker.html +0 -1505
  65. package/docs/build/files/lib_broccoli_default-packager.js.html +0 -1426
  66. package/docs/build/files/lib_broccoli_ember-addon.js.html +0 -159
  67. package/docs/build/files/lib_broccoli_ember-app.js.html +0 -1913
  68. package/docs/build/files/lib_cli_cli.js.html +0 -417
  69. package/docs/build/files/lib_models_addon-info.js.html +0 -112
  70. package/docs/build/files/lib_models_addon.js.html +0 -1866
  71. package/docs/build/files/lib_models_blueprint.js.html +0 -1678
  72. package/docs/build/files/lib_models_builder.js.html +0 -417
  73. package/docs/build/files/lib_models_command.js.html +0 -804
  74. package/docs/build/files/lib_models_hardware-info.js.html +0 -479
  75. package/docs/build/files/lib_models_host-info-cache.js.html +0 -428
  76. package/docs/build/files/lib_models_installation-checker.js.html +0 -181
  77. package/docs/build/files/lib_models_instantiate-addons.js.html +0 -191
  78. package/docs/build/files/lib_models_instrumentation.js.html +0 -433
  79. package/docs/build/files/lib_models_package-info-cache_index.js.html +0 -793
  80. package/docs/build/files/lib_models_package-info-cache_node-modules-list.js.html +0 -208
  81. package/docs/build/files/lib_models_package-info-cache_package-info.js.html +0 -661
  82. package/docs/build/files/lib_models_per-bundle-addon-cache_addon-proxy.js.html +0 -252
  83. package/docs/build/files/lib_models_per-bundle-addon-cache_index.js.html +0 -485
  84. package/docs/build/files/lib_models_per-bundle-addon-cache_target-instance.js.html +0 -108
  85. package/docs/build/files/lib_models_project.js.html +0 -913
  86. package/docs/build/files/lib_models_task.js.html +0 -117
  87. package/docs/build/files/lib_tasks_build-watch.js.html +0 -157
  88. package/docs/build/files/lib_tasks_npm-task.js.html +0 -463
  89. package/docs/build/files/lib_tasks_serve.js.html +0 -207
  90. package/docs/build/files/lib_tasks_server_middleware_broccoli-serve-files_index.js.html +0 -127
  91. package/docs/build/files/lib_tasks_server_middleware_broccoli-watcher_index.js.html +0 -158
  92. package/docs/build/files/lib_tasks_server_middleware_history-support_index.js.html +0 -181
  93. package/docs/build/files/lib_tasks_server_middleware_tests-server_index.js.html +0 -171
  94. package/docs/build/files/lib_tasks_test-server.js.html +0 -167
  95. package/docs/build/files/lib_tasks_transforms_amd_index.js.html +0 -143
  96. package/docs/build/files/lib_utilities_ember-app-utils.js.html +0 -292
  97. package/docs/build/files/lib_utilities_insert-into-file.js.html +0 -219
  98. package/docs/build/files/lib_utilities_is-lazy-engine.js.html +0 -125
  99. package/docs/build/files/lib_utilities_is-yarn-project.js.html +0 -120
  100. package/docs/build/files/lib_utilities_valid-project-name.js.html +0 -142
  101. package/docs/build/files/lib_utilities_will-interrupt-process.js.html +0 -290
  102. package/docs/build/files/lib_utilities_windows-admin.js.html +0 -230
  103. package/docs/build/index.html +0 -125
  104. package/docs/build/modules/ember-cli.html +0 -152
  105. package/docs/build/modules/is-lazy-engine.html +0 -106
  106. package/docs/build-concurrency.md +0 -15
  107. package/docs/build-pipeline-debugging.md +0 -33
  108. package/docs/code-coverage.md +0 -14
  109. package/docs/error-propagation.md +0 -136
  110. package/docs/experiments.md +0 -53
  111. package/docs/node-support.md +0 -43
  112. package/docs/perf-guide.md +0 -250
  113. package/docs/project_version_preprocessor.js +0 -8
  114. package/docs/sourcemaps.md +0 -60
  115. package/docs/yuidoc.json +0 -13
@@ -1,1505 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>WindowsSymlinkChecker - 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">WindowsSymlinkChecker</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_calculateBaseTag">calculateBaseTag</a></li>
94
- <li><a href="#method_checkIfSymlinksNeedToBeEnabled">checkIfSymlinksNeedToBeEnabled</a></li>
95
- <li><a href="#method_checkIfSymlinksNeedToBeEnabled">checkIfSymlinksNeedToBeEnabled</a></li>
96
- <li><a href="#method_contentFor">contentFor</a></li>
97
- <li><a href="#method_convertObjectToString">convertObjectToString</a></li>
98
- <li><a href="#method_insertIntoFile">insertIntoFile</a></li>
99
- <li><a href="#method_normalizeUrl">normalizeUrl</a></li>
100
- <li><a href="#method_setupSignalsTrap">setupSignalsTrap</a></li>
101
- <li><a href="#method_startsWithNumber">startsWithNumber</a></li>
102
- <li><a href="#method_teardownSignalsTrap">teardownSignalsTrap</a></li>
103
- <li><a href="#method_trapWindowsSignals">trapWindowsSignals</a></li>
104
- <li><a href="#method_validProjectName">validProjectName</a></li>
105
- </ul>
106
-
107
-
108
- <div><a href="#private-methods">Private Methods</a></div>
109
- <ul>
110
- <li><a href="#method__checkForElevatedRights">_checkForElevatedRights</a></li>
111
- <li><a href="#method__setup">_setup</a></li>
112
- <li><a href="#method_addHandler">addHandler</a></li>
113
- <li><a href="#method_isYarnProject">isYarnProject</a></li>
114
- <li><a href="#method_onInterrupt">onInterrupt</a></li>
115
- <li><a href="#method_onInterrupt">onInterrupt</a></li>
116
- <li><a href="#method_release">release</a></li>
117
- <li><a href="#method_removeHandler">removeHandler</a></li>
118
- </ul>
119
- </div>
120
- </div>
121
-
122
-
123
-
124
- <div class="version-info">
125
- Version: 4.0.0-release-b4cbb1029f
126
- </div>
127
-
128
- </div>
129
-
130
- <div id="main" class="yui3-u">
131
- <div class="content"><div class="title">
132
- <span class="source-link"><a href="../files/lib_utilities_windows-admin.js.html#l6"><code>lib&#x2F;utilities&#x2F;windows-admin.js:6</code></a></span>
133
- <h1 class="class-name">WindowsSymlinkChecker</h1>
134
- </div>
135
-
136
-
137
-
138
-
139
- <div class="class-description"><p>On Windows, users will have a much better experience if symlinks are enabled
140
- and usable. When queried, this object informs Windows users regarding
141
- improving their build performance, and how.</p>
142
- <blockquote>
143
- <p>Windows Vista: nothing we can really do, so we fall back to junctions for folders + copying of files
144
- &lt;= Windows Vista: symlinks are available but using them is somewhat tricky
145
- * if the user is an admin, the process needs to have been started with elevated privileges
146
- * if the user is not an admin, a specific setting needs to be enabled
147
- &lt;= Windows 10
148
- * if developer mode is enabled, symlinks "just work"
149
- * <a href="https://blogs.windows.com/buildingapps/2016/12/02/symlinks-windows-10">https://blogs.windows.com/buildingapps/2016/12/02/symlinks-windows-10</a></p>
150
- </blockquote>
151
- <pre class="code prettyprint"><code class="language-js"> let checker = WindowsSymlinkChecker;
152
- let {
153
- windows,
154
- elevated
155
- } = await = checker.checkIfSymlinksNeedToBeEnabled(); // aslso emits helpful warnings
156
- </code></pre>
157
- </div>
158
-
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
- <h2 id="method-summary">Method Summary</h2>
167
-
168
- <table class="summary">
169
- <thead>
170
- <tr>
171
- <th colspan="2">Public Methods</th>
172
- </tr>
173
- </thead>
174
- <tbody>
175
- <tr>
176
- <td>
177
- public
178
-
179
-
180
- </td>
181
- <td>
182
- <div class="method-name ">
183
- <a href="#method_calculateBaseTag">calculateBaseTag</a>(baseURL, locationType): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a>
184
- </div>
185
- <div class="short-description">
186
- <p>Returns the <base> tag for index.html.</p>
187
- </div>
188
- </td>
189
- </tr>
190
- <tr>
191
- <td>
192
- public
193
-
194
-
195
- </td>
196
- <td>
197
- <div class="method-name ">
198
- <a href="#method_checkIfSymlinksNeedToBeEnabled">checkIfSymlinksNeedToBeEnabled</a>( ): Promise<Object>
199
- </div>
200
- <div class="short-description">
201
- <p>if not windows, will fulfill with: <code>{ windows: false, elevated: null)</code> if windows, and elevated will fulfill with: <code>{ windows: false, elevated: true)</code> if windows, and is NOT elevated will fulfill with: <code>{ windows: false, elevated: false)</code> will include heplful warning, so that users know (if possible) how to achieve better windows build performance</p>
202
- </div>
203
- </td>
204
- </tr>
205
- <tr>
206
- <td>
207
- public
208
-
209
-
210
- </td>
211
- <td>
212
- <div class="method-name ">
213
- <a href="#method_checkIfSymlinksNeedToBeEnabled">checkIfSymlinksNeedToBeEnabled</a>( ): Promise<Object>
214
- </div>
215
- <div class="short-description">
216
-
217
- </div>
218
- </td>
219
- </tr>
220
- <tr>
221
- <td>
222
- public
223
-
224
-
225
- </td>
226
- <td>
227
- <div class="method-name ">
228
- <a href="#method_contentFor">contentFor</a>(config, match, type, options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a>
229
- </div>
230
- <div class="short-description">
231
- <p>Returns the content for a specific type (section) for index.html.</p>
232
- </div>
233
- </td>
234
- </tr>
235
- <tr>
236
- <td>
237
- public
238
-
239
-
240
- </td>
241
- <td>
242
- <div class="method-name ">
243
- <a href="#method_convertObjectToString">convertObjectToString</a>(Any): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a>
244
- </div>
245
- <div class="short-description">
246
- <p>Converts Javascript Object to a string. Returns an empty object string representation if a "falsy" value is passed in.</p>
247
- </div>
248
- </td>
249
- </tr>
250
- <tr>
251
- <td>
252
- public
253
-
254
-
255
- </td>
256
- <td>
257
- <div class="method-name ">
258
- <a href="#method_insertIntoFile">insertIntoFile</a>(pathRelativeToProjectRoot, contentsToInsert, providedOptions): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
259
- </div>
260
- <div class="short-description">
261
- <p>Inserts the given content into a file. If the <code>contentsToInsert</code> string is already present in the current contents, the file will not be changed unless <code>force</code> option is passed.</p>
262
- </div>
263
- </td>
264
- </tr>
265
- <tr>
266
- <td>
267
- public
268
-
269
-
270
- </td>
271
- <td>
272
- <div class="method-name ">
273
- <a href="#method_normalizeUrl">normalizeUrl</a>(Raw): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a>
274
- </div>
275
- <div class="short-description">
276
- <p>Returns a normalized url given a string. Returns an empty string if <code>null</code>, <code>undefined</code> or an empty string are passed in.</p>
277
- </div>
278
- </td>
279
- </tr>
280
- <tr>
281
- <td>
282
- public
283
-
284
-
285
- </td>
286
- <td>
287
- <div class="method-name ">
288
- <a href="#method_setupSignalsTrap">setupSignalsTrap</a>( )
289
- </div>
290
- <div class="short-description">
291
- <p>Sets up listeners for interruption signals</p>
292
- </div>
293
- </td>
294
- </tr>
295
- <tr>
296
- <td>
297
- public
298
-
299
-
300
- </td>
301
- <td>
302
- <div class="method-name ">
303
- <a href="#method_startsWithNumber">startsWithNumber</a>( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a>
304
- </div>
305
- <div class="short-description">
306
- <p>Checks if the string starts with a number.</p>
307
- </div>
308
- </td>
309
- </tr>
310
- <tr>
311
- <td>
312
- public
313
-
314
-
315
- </td>
316
- <td>
317
- <div class="method-name ">
318
- <a href="#method_teardownSignalsTrap">teardownSignalsTrap</a>( )
319
- </div>
320
- <div class="short-description">
321
- <p>Removes interruption signal listeners and tears down capture-exit</p>
322
- </div>
323
- </td>
324
- </tr>
325
- <tr>
326
- <td>
327
- public
328
-
329
-
330
- </td>
331
- <td>
332
- <div class="method-name ">
333
- <a href="#method_trapWindowsSignals">trapWindowsSignals</a>( )
334
- </div>
335
- <div class="short-description">
336
- <p>Suppresses "Terminate batch job (Y/N)" confirmation on Windows</p>
337
- </div>
338
- </td>
339
- </tr>
340
- <tr>
341
- <td>
342
- public
343
-
344
-
345
- </td>
346
- <td>
347
- <div class="method-name ">
348
- <a href="#method_validProjectName">validProjectName</a>(name): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a>
349
- </div>
350
- <div class="short-description">
351
- <p>Checks if project name is valid.</p>
352
- </div>
353
- </td>
354
- </tr>
355
- </tbody>
356
- </table>
357
-
358
-
359
- <table class="summary">
360
- <thead>
361
- <tr>
362
- <th colspan="2">Private Methods</th>
363
- </tr>
364
- </thead>
365
- <tbody>
366
- <tr>
367
- <td>
368
- private
369
-
370
-
371
- </td>
372
- <td>
373
- <div class="method-name ">
374
- <a href="#method__checkForElevatedRights">_checkForElevatedRights</a>(ui): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a>
375
- </div>
376
- <div class="short-description">
377
- <p>Uses the eon-old command NET SESSION to determine whether or not the current user has elevated rights (think sudo, but Windows).</p>
378
- </div>
379
- </td>
380
- </tr>
381
- <tr>
382
- <td>
383
- private
384
-
385
-
386
- </td>
387
- <td>
388
- <div class="method-name ">
389
- <a href="#method__setup">_setup</a>(UI): <a href="../classes/WindowsSymlinkChecker.html" class="crosslink">WindowsSymlinkChecker</a>
390
- </div>
391
- <div class="short-description">
392
- <p>sets up a WindowsSymlinkChecker</p>
393
- </div>
394
- </td>
395
- </tr>
396
- <tr>
397
- <td>
398
- private
399
-
400
-
401
- </td>
402
- <td>
403
- <div class="method-name ">
404
- <a href="#method_addHandler">addHandler</a>(cb)
405
- </div>
406
- <div class="short-description">
407
- <p>Add process interruption handler</p>
408
- </div>
409
- </td>
410
- </tr>
411
- <tr>
412
- <td>
413
- private
414
-
415
-
416
- </td>
417
- <td>
418
- <div class="method-name ">
419
- <a href="#method_isYarnProject">isYarnProject</a>(thePath): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a>
420
- </div>
421
- <div class="short-description">
422
- <p>Returns true if and only if the given directory has a yarn.lock file or is a child of a yarn workspace root.</p>
423
- </div>
424
- </td>
425
- </tr>
426
- <tr>
427
- <td>
428
- private
429
-
430
-
431
- </td>
432
- <td>
433
- <div class="method-name ">
434
- <a href="#method_onInterrupt">onInterrupt</a>( )
435
- </div>
436
- <div class="short-description">
437
- <p>Exit silently</p>
438
- </div>
439
- </td>
440
- </tr>
441
- <tr>
442
- <td>
443
- private
444
-
445
-
446
- </td>
447
- <td>
448
- <div class="method-name ">
449
- <a href="#method_onInterrupt">onInterrupt</a>( )
450
- </div>
451
- <div class="short-description">
452
- <p>Exit silently</p>
453
- </div>
454
- </td>
455
- </tr>
456
- <tr>
457
- <td>
458
- private
459
-
460
-
461
- </td>
462
- <td>
463
- <div class="method-name ">
464
- <a href="#method_release">release</a>( )
465
- </div>
466
- <div class="short-description">
467
- <p>Drops all the interruption handlers and disables an ability to add new one</p>
468
- </div>
469
- </td>
470
- </tr>
471
- <tr>
472
- <td>
473
- private
474
-
475
-
476
- </td>
477
- <td>
478
- <div class="method-name ">
479
- <a href="#method_removeHandler">removeHandler</a>(cb)
480
- </div>
481
- <div class="short-description">
482
- <p>Remove process interruption handler</p>
483
- </div>
484
- </td>
485
- </tr>
486
- </tbody>
487
- </table>
488
-
489
-
490
-
491
-
492
-
493
-
494
-
495
-
496
-
497
-
498
-
499
-
500
-
501
- <div id="methods public">
502
- <h2 id="public-methods">Public Methods</h2>
503
- <div class="method item">
504
- <div id="method_calculateBaseTag" class="title">
505
- <span class="source-link"><a href="../files/lib_utilities_ember-app-utils.js.html#l37"><code>lib&#x2F;utilities&#x2F;ember-app-utils.js:37</code></a></span>
506
- <h3 class="">
507
- public
508
-
509
-
510
- calculateBaseTag(baseURL, locationType): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a>
511
- </h3>
512
- </div>
513
-
514
-
515
-
516
- <div class="method-description"><p>Returns the <base> tag for index.html.</p>
517
- </div>
518
-
519
- <div class="params">
520
- <h4>Parameters:</h4>
521
- <table>
522
- <thead>
523
- <tr>
524
- <th>Name</th>
525
- <th>Type</th>
526
- <th>Attribute</th>
527
- <th>Description</th>
528
- </tr>
529
- </thead>
530
- <tbody>
531
- <tr>
532
- <td>baseURL</td>
533
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
534
- <td>
535
- <ul>
536
-
537
-
538
-
539
- </ul>
540
- </td>
541
- <td> </td>
542
- </tr>
543
-
544
- <tr>
545
- <td>locationType</td>
546
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
547
- <td>
548
- <ul>
549
-
550
-
551
-
552
- </ul>
553
- </td>
554
- <td><p>'history', 'none' or 'hash'.</p>
555
- </td>
556
- </tr>
557
-
558
- </tbody>
559
- </table>
560
- </div>
561
-
562
- <div class="return">
563
- <h4>Return:</h4>
564
- <div>
565
- <span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
566
- <span class="return-description"><p>Base tag or an empty string</p>
567
- </span>
568
- </div>
569
- </div>
570
-
571
-
572
- </div>
573
- <div class="method item public">
574
- <div id="method_checkIfSymlinksNeedToBeEnabled" class="title">
575
- <span class="source-link"><a href="../files/lib_utilities_windows-admin.js.html#l38"><code>lib&#x2F;utilities&#x2F;windows-admin.js:38</code></a></span>
576
- <h3 class="">
577
- public
578
-
579
-
580
- checkIfSymlinksNeedToBeEnabled( ): Promise<Object>
581
- </h3>
582
- </div>
583
-
584
-
585
-
586
- <div class="method-description"><p>if not windows, will fulfill with:
587
- <code>{ windows: false, elevated: null)</code>
588
- if windows, and elevated will fulfill with:
589
- <code>{ windows: false, elevated: true)</code>
590
- if windows, and is NOT elevated will fulfill with:
591
- <code>{ windows: false, elevated: false)</code>
592
- will include heplful warning, so that users know (if possible) how to
593
- achieve better windows build performance</p>
594
- </div>
595
-
596
-
597
- <div class="return">
598
- <h4>Return:</h4>
599
- <div>
600
- <span class="return-type">Promise<Object></span>
601
- <span class="return-description"><p>Object describing whether we're on windows and if admin rights exist</p>
602
- </span>
603
- </div>
604
- </div>
605
-
606
-
607
- </div>
608
- <div class="method item public">
609
- <div id="method_checkIfSymlinksNeedToBeEnabled" class="title">
610
- <span class="source-link"><a href="../files/lib_utilities_windows-admin.js.html#l81"><code>lib&#x2F;utilities&#x2F;windows-admin.js:81</code></a></span>
611
- <h3 class="">
612
- public
613
-
614
-
615
- checkIfSymlinksNeedToBeEnabled( ): Promise<Object>
616
- </h3>
617
- </div>
618
-
619
-
620
-
621
- <div class="method-description"></div>
622
-
623
-
624
- <div class="return">
625
- <h4>Return:</h4>
626
- <div>
627
- <span class="return-type">Promise<Object></span>
628
- <span class="return-description"><p>Object describing whether we're on windows and if admin rights exist</p>
629
- </span>
630
- </div>
631
- </div>
632
-
633
-
634
- </div>
635
- <div class="method item">
636
- <div id="method_contentFor" class="title">
637
- <span class="source-link"><a href="../files/lib_utilities_ember-app-utils.js.html#l55"><code>lib&#x2F;utilities&#x2F;ember-app-utils.js:55</code></a></span>
638
- <h3 class="">
639
- public
640
-
641
-
642
- contentFor(config, match, type, options): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a>
643
- </h3>
644
- </div>
645
-
646
-
647
-
648
- <div class="method-description"><p>Returns the content for a specific type (section) for index.html.</p>
649
- <pre class="code prettyprint"><code>{{content-for "[type]"}}
650
- </code></pre>
651
- <p>Supported types:</p>
652
- <ul>
653
- <li>'head'</li>
654
- <li>'config-module'</li>
655
- <li>'head-footer'</li>
656
- <li>'test-header-footer'</li>
657
- <li>'body-footer'</li>
658
- <li>'test-body-footer'</li>
659
- </ul>
660
- </div>
661
-
662
- <div class="params">
663
- <h4>Parameters:</h4>
664
- <table>
665
- <thead>
666
- <tr>
667
- <th>Name</th>
668
- <th>Type</th>
669
- <th>Attribute</th>
670
- <th>Description</th>
671
- </tr>
672
- </thead>
673
- <tbody>
674
- <tr>
675
- <td>config</td>
676
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
677
- <td>
678
- <ul>
679
-
680
-
681
-
682
- </ul>
683
- </td>
684
- <td><p>Ember.js application configuration</p>
685
- </td>
686
- </tr>
687
-
688
- <tr>
689
- <td>match</td>
690
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></td>
691
- <td>
692
- <ul>
693
-
694
-
695
-
696
- </ul>
697
- </td>
698
- <td><p>Regular expression to match against</p>
699
- </td>
700
- </tr>
701
-
702
- <tr>
703
- <td>type</td>
704
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
705
- <td>
706
- <ul>
707
-
708
-
709
-
710
- </ul>
711
- </td>
712
- <td><p>Type of content</p>
713
- </td>
714
- </tr>
715
-
716
- <tr>
717
- <td>options</td>
718
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
719
- <td>
720
- <ul>
721
-
722
-
723
-
724
- </ul>
725
- </td>
726
- <td><p>Settings that control the default content</p>
727
- </td>
728
- </tr>
729
-
730
- <tr>
731
- <td>options.autoRun</td>
732
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></td>
733
- <td>
734
- <ul>
735
-
736
-
737
-
738
- </ul>
739
- </td>
740
- <td><p>Controls whether to bootstrap the
741
- application or not</p>
742
- </td>
743
- </tr>
744
- <tr>
745
- <td>options.storeConfigInMeta</td>
746
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></td>
747
- <td>
748
- <ul>
749
-
750
-
751
-
752
- </ul>
753
- </td>
754
- <td><p>Controls whether to include the
755
- contents of config</p>
756
- </td>
757
- </tr>
758
- </tbody>
759
- </table>
760
- </div>
761
-
762
- <div class="return">
763
- <h4>Return:</h4>
764
- <div>
765
- <span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
766
- <span class="return-description"><p>The content.</p>
767
- </span>
768
- </div>
769
- </div>
770
-
771
-
772
- </div>
773
- <div class="method item">
774
- <div id="method_convertObjectToString" class="title">
775
- <span class="source-link"><a href="../files/lib_utilities_ember-app-utils.js.html#l24"><code>lib&#x2F;utilities&#x2F;ember-app-utils.js:24</code></a></span>
776
- <h3 class="">
777
- public
778
-
779
-
780
- convertObjectToString(Any): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a>
781
- </h3>
782
- </div>
783
-
784
-
785
-
786
- <div class="method-description"><p>Converts Javascript Object to a string.
787
- Returns an empty object string representation if a "falsy" value is passed
788
- in.</p>
789
- </div>
790
-
791
- <div class="params">
792
- <h4>Parameters:</h4>
793
- <table>
794
- <thead>
795
- <tr>
796
- <th>Name</th>
797
- <th>Type</th>
798
- <th>Attribute</th>
799
- <th>Description</th>
800
- </tr>
801
- </thead>
802
- <tbody>
803
- <tr>
804
- <td>Any</td>
805
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
806
- <td>
807
- <ul>
808
-
809
-
810
-
811
- </ul>
812
- </td>
813
- <td><p>Javascript Object.</p>
814
- </td>
815
- </tr>
816
-
817
- </tbody>
818
- </table>
819
- </div>
820
-
821
- <div class="return">
822
- <h4>Return:</h4>
823
- <div>
824
- <span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
825
- <span class="return-description"><p>A string representation of a Javascript Object.</p>
826
- </span>
827
- </div>
828
- </div>
829
-
830
-
831
- </div>
832
- <div class="method item">
833
- <div id="method_insertIntoFile" class="title">
834
- <span class="source-link"><a href="../files/lib_utilities_insert-into-file.js.html#l6"><code>lib&#x2F;utilities&#x2F;insert-into-file.js:6</code></a></span>
835
- <h3 class="">
836
- public
837
-
838
-
839
- insertIntoFile(pathRelativeToProjectRoot, contentsToInsert, providedOptions): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a>
840
- </h3>
841
- </div>
842
-
843
-
844
-
845
- <div class="method-description"><p>Inserts the given content into a file. If the <code>contentsToInsert</code> string is already
846
- present in the current contents, the file will not be changed unless <code>force</code> option
847
- is passed.</p>
848
- <p>If <code>options.before</code> is specified, <code>contentsToInsert</code> will be inserted before
849
- the first instance of that string. If <code>options.after</code> is specified, the
850
- contents will be inserted after the first instance of that string.
851
- If the string specified by options.before or options.after is not in the file,
852
- no change will be made. Both of these options support regular expressions.</p>
853
- <p>If neither <code>options.before</code> nor <code>options.after</code> are present, <code>contentsToInsert</code>
854
- will be inserted at the end of the file.</p>
855
- <p>It will create a new file if one doesn't exist, unless you set the <code>options.create</code>
856
- option to <code>false</code>.</p>
857
- <p>Example:</p>
858
- <pre class="code prettyprint"><code>// app/router.js
859
- Router.map(function () {
860
- });
861
- </code></pre>
862
- <pre class="code prettyprint"><code>insertIntoFile('app/router.js', ' this.route("admin");', {
863
- after: 'Router.map(function () {' + EOL
864
- });
865
- </code></pre>
866
- <pre class="code prettyprint"><code>// app/router.js
867
- Router.map(function () {
868
- this.route("admin");
869
- });
870
- </code></pre>
871
- </div>
872
-
873
- <div class="params">
874
- <h4>Parameters:</h4>
875
- <table>
876
- <thead>
877
- <tr>
878
- <th>Name</th>
879
- <th>Type</th>
880
- <th>Attribute</th>
881
- <th>Description</th>
882
- </tr>
883
- </thead>
884
- <tbody>
885
- <tr>
886
- <td>pathRelativeToProjectRoot</td>
887
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
888
- <td>
889
- <ul>
890
-
891
-
892
-
893
- </ul>
894
- </td>
895
- <td> </td>
896
- </tr>
897
-
898
- <tr>
899
- <td>contentsToInsert</td>
900
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
901
- <td>
902
- <ul>
903
-
904
-
905
-
906
- </ul>
907
- </td>
908
- <td> </td>
909
- </tr>
910
-
911
- <tr>
912
- <td>providedOptions</td>
913
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
914
- <td>
915
- <ul>
916
-
917
-
918
-
919
- </ul>
920
- </td>
921
- <td> </td>
922
- </tr>
923
-
924
- </tbody>
925
- </table>
926
- </div>
927
-
928
- <div class="return">
929
- <h4>Return:</h4>
930
- <div>
931
- <span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="crosslink external" target="_blank">Promise</a></span>
932
- <span class="return-description"></span>
933
- </div>
934
- </div>
935
-
936
-
937
- </div>
938
- <div class="method item">
939
- <div id="method_normalizeUrl" class="title">
940
- <span class="source-link"><a href="../files/lib_utilities_ember-app-utils.js.html#l7"><code>lib&#x2F;utilities&#x2F;ember-app-utils.js:7</code></a></span>
941
- <h3 class="">
942
- public
943
-
944
-
945
- normalizeUrl(Raw): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a>
946
- </h3>
947
- </div>
948
-
949
-
950
-
951
- <div class="method-description"><p>Returns a normalized url given a string.
952
- Returns an empty string if <code>null</code>, <code>undefined</code> or an empty string are passed
953
- in.</p>
954
- </div>
955
-
956
- <div class="params">
957
- <h4>Parameters:</h4>
958
- <table>
959
- <thead>
960
- <tr>
961
- <th>Name</th>
962
- <th>Type</th>
963
- <th>Attribute</th>
964
- <th>Description</th>
965
- </tr>
966
- </thead>
967
- <tbody>
968
- <tr>
969
- <td>Raw</td>
970
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
971
- <td>
972
- <ul>
973
-
974
-
975
-
976
- </ul>
977
- </td>
978
- <td><p>url.</p>
979
- </td>
980
- </tr>
981
-
982
- </tbody>
983
- </table>
984
- </div>
985
-
986
- <div class="return">
987
- <h4>Return:</h4>
988
- <div>
989
- <span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
990
- <span class="return-description"><p>Normalized url.</p>
991
- </span>
992
- </div>
993
- </div>
994
-
995
-
996
- </div>
997
- <div class="method item">
998
- <div id="method_setupSignalsTrap" class="title">
999
- <span class="source-link"><a href="../files/lib_utilities_will-interrupt-process.js.html#l122"><code>lib&#x2F;utilities&#x2F;will-interrupt-process.js:122</code></a></span>
1000
- <h3 class="">
1001
- public
1002
-
1003
-
1004
- setupSignalsTrap( )
1005
- </h3>
1006
- </div>
1007
-
1008
-
1009
-
1010
- <div class="method-description"><p>Sets up listeners for interruption signals</p>
1011
- <p>When one of these signals is caught than raise process.exit()
1012
- which enforces <code>capture-exit</code> to run registered interruption handlers</p>
1013
- </div>
1014
-
1015
-
1016
-
1017
-
1018
- </div>
1019
- <div class="method item">
1020
- <div id="method_startsWithNumber" class="title">
1021
- <span class="source-link"><a href="../files/lib_utilities_valid-project-name.js.html#l5"><code>lib&#x2F;utilities&#x2F;valid-project-name.js:5</code></a></span>
1022
- <h3 class="">
1023
- public
1024
-
1025
-
1026
- startsWithNumber( ): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a>
1027
- </h3>
1028
- </div>
1029
-
1030
-
1031
-
1032
- <div class="method-description"><p>Checks if the string starts with a number.</p>
1033
- </div>
1034
-
1035
-
1036
- <div class="return">
1037
- <h4>Return:</h4>
1038
- <div>
1039
- <span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
1040
- <span class="return-description"></span>
1041
- </div>
1042
- </div>
1043
-
1044
-
1045
- </div>
1046
- <div class="method item">
1047
- <div id="method_teardownSignalsTrap" class="title">
1048
- <span class="source-link"><a href="../files/lib_utilities_will-interrupt-process.js.html#l140"><code>lib&#x2F;utilities&#x2F;will-interrupt-process.js:140</code></a></span>
1049
- <h3 class="">
1050
- public
1051
-
1052
-
1053
- teardownSignalsTrap( )
1054
- </h3>
1055
- </div>
1056
-
1057
-
1058
-
1059
- <div class="method-description"><p>Removes interruption signal listeners and tears down capture-exit</p>
1060
- </div>
1061
-
1062
-
1063
-
1064
-
1065
- </div>
1066
- <div class="method item">
1067
- <div id="method_trapWindowsSignals" class="title">
1068
- <span class="source-link"><a href="../files/lib_utilities_will-interrupt-process.js.html#l155"><code>lib&#x2F;utilities&#x2F;will-interrupt-process.js:155</code></a></span>
1069
- <h3 class="">
1070
- public
1071
-
1072
-
1073
- trapWindowsSignals( )
1074
- </h3>
1075
- </div>
1076
-
1077
-
1078
-
1079
- <div class="method-description"><p>Suppresses "Terminate batch job (Y/N)" confirmation on Windows</p>
1080
- </div>
1081
-
1082
-
1083
-
1084
-
1085
- </div>
1086
- <div class="method item">
1087
- <div id="method_validProjectName" class="title">
1088
- <span class="source-link"><a href="../files/lib_utilities_valid-project-name.js.html#l24"><code>lib&#x2F;utilities&#x2F;valid-project-name.js:24</code></a></span>
1089
- <h3 class="">
1090
- public
1091
-
1092
-
1093
- validProjectName(name): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a>
1094
- </h3>
1095
- </div>
1096
-
1097
-
1098
-
1099
- <div class="method-description"><p>Checks if project name is valid.</p>
1100
- <p>Invalid names are some of the internal constants that Ember CLI uses, such as
1101
- <code>app</code>, <code>ember</code>, <code>ember-cli</code>, <code>test</code>, and <code>vendor</code>. Names that start with
1102
- numbers are considered invalid as well.</p>
1103
- </div>
1104
-
1105
- <div class="params">
1106
- <h4>Parameters:</h4>
1107
- <table>
1108
- <thead>
1109
- <tr>
1110
- <th>Name</th>
1111
- <th>Type</th>
1112
- <th>Attribute</th>
1113
- <th>Description</th>
1114
- </tr>
1115
- </thead>
1116
- <tbody>
1117
- <tr>
1118
- <td>name</td>
1119
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
1120
- <td>
1121
- <ul>
1122
-
1123
-
1124
-
1125
- </ul>
1126
- </td>
1127
- <td><p>The name of Ember CLI project</p>
1128
- </td>
1129
- </tr>
1130
-
1131
- </tbody>
1132
- </table>
1133
- </div>
1134
-
1135
- <div class="return">
1136
- <h4>Return:</h4>
1137
- <div>
1138
- <span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
1139
- <span class="return-description"></span>
1140
- </div>
1141
- </div>
1142
-
1143
-
1144
- </div>
1145
- </div>
1146
-
1147
-
1148
- <div id="methods private">
1149
- <h2 id="private-methods">Private Methods</h2>
1150
- <div class="method item private">
1151
- <div id="method__checkForElevatedRights" class="title">
1152
- <span class="source-link"><a href="../files/lib_utilities_windows-admin.js.html#l104"><code>lib&#x2F;utilities&#x2F;windows-admin.js:104</code></a></span>
1153
- <h3 class="">
1154
- private
1155
-
1156
-
1157
- _checkForElevatedRights(ui): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a>
1158
- </h3>
1159
- </div>
1160
-
1161
-
1162
-
1163
- <div class="method-description"><p>Uses the eon-old command NET SESSION to determine whether or not the
1164
- current user has elevated rights (think sudo, but Windows).</p>
1165
- </div>
1166
-
1167
- <div class="params">
1168
- <h4>Parameters:</h4>
1169
- <table>
1170
- <thead>
1171
- <tr>
1172
- <th>Name</th>
1173
- <th>Type</th>
1174
- <th>Attribute</th>
1175
- <th>Description</th>
1176
- </tr>
1177
- </thead>
1178
- <tbody>
1179
- <tr>
1180
- <td>ui</td>
1181
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></td>
1182
- <td>
1183
- <ul>
1184
-
1185
-
1186
-
1187
- </ul>
1188
- </td>
1189
- <td><ul>
1190
- <li>ui object used to call writeLine();</li>
1191
- </ul>
1192
- </td>
1193
- </tr>
1194
-
1195
- </tbody>
1196
- </table>
1197
- </div>
1198
-
1199
- <div class="return">
1200
- <h4>Return:</h4>
1201
- <div>
1202
- <span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
1203
- <span class="return-description"><p>Object describing whether we're on windows and if admin rights exist</p>
1204
- </span>
1205
- </div>
1206
- </div>
1207
-
1208
-
1209
- </div>
1210
- <div class="method item private">
1211
- <div id="method__setup" class="title">
1212
- <span class="source-link"><a href="../files/lib_utilities_windows-admin.js.html#l60"><code>lib&#x2F;utilities&#x2F;windows-admin.js:60</code></a></span>
1213
- <h3 class="">
1214
- private
1215
-
1216
-
1217
- _setup(UI): <a href="../classes/WindowsSymlinkChecker.html" class="crosslink">WindowsSymlinkChecker</a>
1218
- </h3>
1219
- </div>
1220
-
1221
-
1222
-
1223
- <div class="method-description"><p>sets up a WindowsSymlinkChecker</p>
1224
- <p>providing it with defaults for:</p>
1225
- <ul>
1226
- <li>if we are on windows</li>
1227
- <li>if we can symlink</li>
1228
- <li>a reference to exec</li>
1229
- </ul>
1230
- </div>
1231
-
1232
- <div class="params">
1233
- <h4>Parameters:</h4>
1234
- <table>
1235
- <thead>
1236
- <tr>
1237
- <th>Name</th>
1238
- <th>Type</th>
1239
- <th>Attribute</th>
1240
- <th>Description</th>
1241
- </tr>
1242
- </thead>
1243
- <tbody>
1244
- <tr>
1245
- <td>UI</td>
1246
- <td>UI</td>
1247
- <td>
1248
- <ul>
1249
-
1250
-
1251
-
1252
- </ul>
1253
- </td>
1254
- <td> </td>
1255
- </tr>
1256
-
1257
- </tbody>
1258
- </table>
1259
- </div>
1260
-
1261
- <div class="return">
1262
- <h4>Return:</h4>
1263
- <div>
1264
- <span class="return-type"><a href="../classes/WindowsSymlinkChecker.html" class="crosslink">WindowsSymlinkChecker</a></span>
1265
- <span class="return-description"></span>
1266
- </div>
1267
- </div>
1268
-
1269
-
1270
- </div>
1271
- <div class="method item private">
1272
- <div id="method_addHandler" class="title">
1273
- <span class="source-link"><a href="../files/lib_utilities_will-interrupt-process.js.html#l69"><code>lib&#x2F;utilities&#x2F;will-interrupt-process.js:69</code></a></span>
1274
- <h3 class="">
1275
- private
1276
-
1277
-
1278
- addHandler(cb)
1279
- </h3>
1280
- </div>
1281
-
1282
-
1283
-
1284
- <div class="method-description"><p>Add process interruption handler</p>
1285
- <p>When the first handler is added then automatically
1286
- sets up process interruption signals listeners</p>
1287
- </div>
1288
-
1289
- <div class="params">
1290
- <h4>Parameters:</h4>
1291
- <table>
1292
- <thead>
1293
- <tr>
1294
- <th>Name</th>
1295
- <th>Type</th>
1296
- <th>Attribute</th>
1297
- <th>Description</th>
1298
- </tr>
1299
- </thead>
1300
- <tbody>
1301
- <tr>
1302
- <td>cb</td>
1303
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></td>
1304
- <td>
1305
- <ul>
1306
-
1307
-
1308
-
1309
- </ul>
1310
- </td>
1311
- <td><p>Callback to be called when process interruption fired</p>
1312
- </td>
1313
- </tr>
1314
-
1315
- </tbody>
1316
- </table>
1317
- </div>
1318
-
1319
-
1320
-
1321
- </div>
1322
- <div class="method item private">
1323
- <div id="method_isYarnProject" class="title">
1324
- <span class="source-link"><a href="../files/lib_utilities_is-yarn-project.js.html#l6"><code>lib&#x2F;utilities&#x2F;is-yarn-project.js:6</code></a></span>
1325
- <h3 class="">
1326
- private
1327
-
1328
-
1329
- isYarnProject(thePath): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a>
1330
- </h3>
1331
- </div>
1332
-
1333
-
1334
-
1335
- <div class="method-description"><p>Returns true if and only if the given directory has a yarn.lock file or is a child of a
1336
- yarn workspace root.</p>
1337
- </div>
1338
-
1339
- <div class="params">
1340
- <h4>Parameters:</h4>
1341
- <table>
1342
- <thead>
1343
- <tr>
1344
- <th>Name</th>
1345
- <th>Type</th>
1346
- <th>Attribute</th>
1347
- <th>Description</th>
1348
- </tr>
1349
- </thead>
1350
- <tbody>
1351
- <tr>
1352
- <td>thePath</td>
1353
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></td>
1354
- <td>
1355
- <ul>
1356
-
1357
-
1358
-
1359
- </ul>
1360
- </td>
1361
- <td> </td>
1362
- </tr>
1363
-
1364
- </tbody>
1365
- </table>
1366
- </div>
1367
-
1368
- <div class="return">
1369
- <h4>Return:</h4>
1370
- <div>
1371
- <span class="return-type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
1372
- <span class="return-description"></span>
1373
- </div>
1374
- </div>
1375
-
1376
-
1377
- </div>
1378
- <div class="method item private">
1379
- <div id="method_onInterrupt" class="title">
1380
- <span class="source-link"><a href="../files/lib_tasks_serve.js.html#l101"><code>lib&#x2F;tasks&#x2F;serve.js:101</code></a></span>
1381
- <h3 class="">
1382
- private
1383
-
1384
-
1385
- onInterrupt( )
1386
- </h3>
1387
- </div>
1388
-
1389
-
1390
-
1391
- <div class="method-description"><p>Exit silently</p>
1392
- </div>
1393
-
1394
-
1395
-
1396
-
1397
- </div>
1398
- <div class="method item private">
1399
- <div id="method_onInterrupt" class="title">
1400
- <span class="source-link"><a href="../files/lib_tasks_test-server.js.html#l61"><code>lib&#x2F;tasks&#x2F;test-server.js:61</code></a></span>
1401
- <h3 class="">
1402
- private
1403
-
1404
-
1405
- onInterrupt( )
1406
- </h3>
1407
- </div>
1408
-
1409
-
1410
-
1411
- <div class="method-description"><p>Exit silently</p>
1412
- </div>
1413
-
1414
-
1415
-
1416
-
1417
- </div>
1418
- <div class="method item private">
1419
- <div id="method_release" class="title">
1420
- <span class="source-link"><a href="../files/lib_utilities_will-interrupt-process.js.html#l47"><code>lib&#x2F;utilities&#x2F;will-interrupt-process.js:47</code></a></span>
1421
- <h3 class="">
1422
- private
1423
-
1424
-
1425
- release( )
1426
- </h3>
1427
- </div>
1428
-
1429
-
1430
-
1431
- <div class="method-description"><p>Drops all the interruption handlers and disables an ability to add new one</p>
1432
- <p>Note: We don't call `captureExit.releaseExit() here.
1433
- In some rare scenarios it can lead to the hard to debug issues.
1434
- see: <a href="https://github.com/ember-cli/ember-cli/issues/6779#issuecomment-280940358">https://github.com/ember-cli/ember-cli/issues/6779#issuecomment-280940358</a></p>
1435
- <p>We can more or less feel comfortable with a captured exit because it behaves very
1436
- similar to the original <code>exit</code> except of cases when we need to do cleanup before exit.</p>
1437
- </div>
1438
-
1439
-
1440
-
1441
-
1442
- </div>
1443
- <div class="method item private">
1444
- <div id="method_removeHandler" class="title">
1445
- <span class="source-link"><a href="../files/lib_utilities_will-interrupt-process.js.html#l97"><code>lib&#x2F;utilities&#x2F;will-interrupt-process.js:97</code></a></span>
1446
- <h3 class="">
1447
- private
1448
-
1449
-
1450
- removeHandler(cb)
1451
- </h3>
1452
- </div>
1453
-
1454
-
1455
-
1456
- <div class="method-description"><p>Remove process interruption handler</p>
1457
- <p>If there are no remaining handlers after removal
1458
- then clean up all the process interruption signal listeners</p>
1459
- </div>
1460
-
1461
- <div class="params">
1462
- <h4>Parameters:</h4>
1463
- <table>
1464
- <thead>
1465
- <tr>
1466
- <th>Name</th>
1467
- <th>Type</th>
1468
- <th>Attribute</th>
1469
- <th>Description</th>
1470
- </tr>
1471
- </thead>
1472
- <tbody>
1473
- <tr>
1474
- <td>cb</td>
1475
- <td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></td>
1476
- <td>
1477
- <ul>
1478
-
1479
-
1480
-
1481
- </ul>
1482
- </td>
1483
- <td><p>Callback to be removed</p>
1484
- </td>
1485
- </tr>
1486
-
1487
- </tbody>
1488
- </table>
1489
- </div>
1490
-
1491
-
1492
-
1493
- </div>
1494
- </div>
1495
-
1496
-
1497
- </div>
1498
- </div>
1499
- </div>
1500
- </div>
1501
- <script src="../assets/vendor/prettify/prettify-min.js"></script>
1502
- <script>prettyPrint();</script>
1503
- <script src="../assets/js/yui-prettify.js"></script>
1504
- </body>
1505
- </html>