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,152 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>ember-cli - 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">ember-cli</h2>
71
- </div>
72
- <div class="bd">
73
-
74
-
75
- <div><a href="#constructor-summary">Constructor Summary</a></div>
76
-
77
-
78
-
79
-
80
-
81
-
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
- </div>
94
- </div>
95
-
96
-
97
-
98
- <div class="version-info">
99
- Version: 4.0.0-release-b4cbb1029f
100
- </div>
101
-
102
- </div>
103
-
104
- <div id="main" class="yui3-u">
105
- <div class="content"><div class="title">
106
- <span class="source-link"><a href="../files/lib_tasks_npm-task.js.html#l17"><code>lib&#x2F;tasks&#x2F;npm-task.js:17</code></a></span>
107
- <h1 class="module-name">ember-cli</h1>
108
- </div>
109
-
110
- <div class="intro"></div>
111
-
112
- <div class="yui3-g">
113
- <div class="yui3-u-1-2">
114
- <p>This module has the following classes:</p>
115
- <ul>
116
- <li><a href="../classes/Addon.html">Addon</a></li>
117
- <li><a href="../classes/AmdTransformAddon.html">AmdTransformAddon</a></li>
118
- <li><a href="../classes/Blueprint.html">Blueprint</a></li>
119
- <li><a href="../classes/Builder.html">Builder</a></li>
120
- <li><a href="../classes/CLI.html">CLI</a></li>
121
- <li><a href="../classes/Command.html">Command</a></li>
122
- <li><a href="../classes/DefaultPackager.html">DefaultPackager</a></li>
123
- <li><a href="../classes/EmberAddon.html">EmberAddon</a></li>
124
- <li><a href="../classes/EmberApp.html">EmberApp</a></li>
125
- <li><a href="../classes/HardwareInfo.html">HardwareInfo</a></li>
126
- <li><a href="../classes/HistorySupportAddon.html">HistorySupportAddon</a></li>
127
- <li><a href="../classes/Instrumentation.html">Instrumentation</a></li>
128
- <li><a href="../classes/NodeModulesList.html">NodeModulesList</a></li>
129
- <li><a href="../classes/NpmTask.html">NpmTask</a></li>
130
- <li><a href="../classes/PackageInfo.html">PackageInfo</a></li>
131
- <li><a href="../classes/PackageInfoCache.html">PackageInfoCache</a></li>
132
- <li><a href="../classes/PerBundleAddonCache {.html">PerBundleAddonCache {</a></li>
133
- <li><a href="../classes/Project.html">Project</a></li>
134
- <li><a href="../classes/ServeFilesAddon.html">ServeFilesAddon</a></li>
135
- <li><a href="../classes/TestsServerAddon.html">TestsServerAddon</a></li>
136
- <li><a href="../classes/WatcherAddon.html">WatcherAddon</a></li>
137
- </ul>
138
- </div>
139
- <div class="yui3-u-1-2">
140
- </div>
141
- <div class="yui3-u-1-2">
142
- </div>
143
- </div>
144
- </div>
145
- </div>
146
- </div>
147
- </div>
148
- <script src="../assets/vendor/prettify/prettify-min.js"></script>
149
- <script>prettyPrint();</script>
150
- <script src="../assets/js/yui-prettify.js"></script>
151
- </body>
152
- </html>
@@ -1,106 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>is-lazy-engine - 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
-
69
-
70
-
71
- <div class="version-info">
72
- Version: 4.0.0-release-b4cbb1029f
73
- </div>
74
-
75
- </div>
76
-
77
- <div id="main" class="yui3-u">
78
- <div class="content"><div class="title">
79
- <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>
80
- <h1 class="module-name">is-lazy-engine</h1>
81
- </div>
82
-
83
- <div class="intro"><p>Indicate if a given object is a constructor function or class or an instance of an Addon.</p>
84
- </div>
85
-
86
- <div class="yui3-g">
87
- <div class="yui3-u-1-2">
88
- <p>This module has the following classes:</p>
89
- <ul>
90
- <li><a href="../classes/WindowsSymlinkChecker.html">WindowsSymlinkChecker</a></li>
91
- </ul>
92
- </div>
93
- <div class="yui3-u-1-2">
94
- </div>
95
- <div class="yui3-u-1-2">
96
- </div>
97
- </div>
98
- </div>
99
- </div>
100
- </div>
101
- </div>
102
- <script src="../assets/vendor/prettify/prettify-min.js"></script>
103
- <script>prettyPrint();</script>
104
- <script src="../assets/js/yui-prettify.js"></script>
105
- </body>
106
- </html>
@@ -1,15 +0,0 @@
1
- # Build Concurrency
2
-
3
- In order to speed up your project's build time, Ember CLI has added a bit of
4
- concurrency throughout the build system. The exact number of parallel
5
- transpilation jobs that will be used can be customized via the `JOBS` process
6
- environment variable.
7
-
8
- The default value for `process.env.JOBS` is (max concurrency) - 1 (via
9
- `require('os').cpus().length - 1`), however there may be times when you need to
10
- customize this value to avoid issues.
11
-
12
- The most common case for this is in CI systems like GitHub Actions, TravisCI,
13
- and CircleCI where the total number of CPU's available on the system is very
14
- large (> 32) but the individual CI jobs are limited to only 1.5 or 2 concurrent
15
- processes.
@@ -1,33 +0,0 @@
1
- # Build Pipeline Debugging
2
-
3
- **Note**: This is _only_ for debugging purposes and should not be relied upon.
4
-
5
- To gain more visibility into what broccoli trees Ember CLI operates on, you can run the following command:
6
-
7
- ```sh
8
- BROCCOLI_DEBUG="bundler:*" ember build
9
- ```
10
-
11
- Fish equivalent is:
12
-
13
- ```sh
14
- env BROCCOLI_DEBUG="bundler:*" ember build
15
- ```
16
-
17
- For a brand new ember application (`ember new your-app-name`), `DEBUG/` folder is going to be created with the following contents:
18
-
19
- ```sh
20
- DEBUG/
21
- └── bundler:application-and-dependencies
22
- ├── addon-tree-output
23
- ├── tree-shake-test
24
- └── vendor
25
- ```
26
-
27
- `addon-tree-output` is the folder that contains all trees from Ember CLI add-ons;
28
- `your-app-name` is an application tree and `vendor` contains imported external assets.
29
-
30
- Ember CLI uses [`broccoli-debug`](https://github.com/broccolijs/broccoli-debug/) to generate debug output mentioned above.
31
-
32
- More tips can be found in our [PERF_GUIDE](./perf-guide.md)
33
- under [DEBUG logging section](./perf-guide.md#debug-logging).
@@ -1,14 +0,0 @@
1
- # Ember CLI Code Coverage & Analysis
2
-
3
- We are using [Coveralls](https://coveralls.io/) to track our code coverage
4
- and [Code Climate](https://codeclimate.com/) to analyze the complexity our code base.
5
-
6
- Code coverage information is generated using [istanbuljs](https://github.com/istanbuljs/nyc)
7
- and then later uploaded to both
8
- [Coveralls](https://coveralls.io/github/ember-cli/ember-cli) and
9
- [Code Climate](https://codeclimate.com/github/ember-cli/ember-cli) via
10
- [`.github/workflows/coverage.yml`](../.github/workflows/coverage.yml) after each Pull Request.
11
-
12
- `CC_TEST_REPORTER_ID` is set via [GitHub encrypted
13
- secrets](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets)
14
- and not exposed to the public as they are private tokens.
@@ -1,136 +0,0 @@
1
- # Error Propagation in Broccoli & Ember CLI
2
-
3
- ## Quick Summary
4
-
5
- This is a short summary of how errors during build time are surfaced to the browser. Let's look at a particular example.
6
-
7
- Let's say you have the following template:
8
-
9
- ```handlebars
10
- <p>Sup you guise<p>
11
- ```
12
-
13
- There's an unclosd `p` tag. Seems bad.
14
-
15
- Here's what is going to happen:
16
-
17
- + `ember-template-compiler` throws an exception
18
- + `location`
19
- + `message`
20
- + `stack`
21
-
22
- Error contains information of where in the file error occurred and what kind of error it was.
23
-
24
- + `ember-cli-htmlbars` will catch the error from `ember-template-compiler`.
25
-
26
- Because `ember-cli-htmlbars` is based on `broccoli-persistent-filter`, technically `broccoli-persistent-filter`
27
- will catch the exception first. For example, we attach `file` and `treeDir` information to errors [here](https://github.com/stefanpenner/broccoli-persistent-filter/blob/v1.3.1/index.js#L267-L272).
28
-
29
- + `broccoli-builder` catches the error
30
-
31
- Ember CLI uses `broccoli-builder` to build its trees so if `broccoli-builder` throws an error,
32
- Ember CLI is aware and can act accordingly.
33
-
34
- At this level, we can attach more information to the error, like `broccoli` node/annotation.
35
-
36
- + `broccoli-middleware` catches the error
37
-
38
- This is where we return an error page for the browser. Given all the information, we get from `ember-cli-htmlbars`
39
- and `broccoli-builder`, we show an error page.
40
-
41
- ## Error object
42
-
43
- As long as add-ons respect the following error contract, Ember CLI should be able to show useful error messages.
44
- Note, that is just an interface, not an actual class.
45
-
46
- ```typescript
47
- /**
48
- * Represents a location of the error.
49
- * @param {string} line - The line number in the file.
50
- * @param {string} column - The column number in the file.
51
- */
52
- interface Position {
53
- line: number;
54
- column: number;
55
- }
56
-
57
- /**
58
- * Represents an error that might occur during Ember CLI
59
- * build process.
60
- * @param {string} stack - The stack frame of the error.
61
- * @param {string} message - The error message.
62
- * @param {string} codeFrame - The nicely formatted code block with line and column number highlighter (babel style).
63
- * @param {string} type - The class of the error (`Parse Error`, `Compiler Error`, `Syntax Error`).
64
- * @param {string} location - The position of the error in the file.
65
- */
66
- interface BuildError {
67
- stack: string;
68
- message: string;
69
- codeFrame: string;
70
- type: string,
71
- location: Position;
72
- }
73
- ```
74
-
75
- On the add-on level, error handling might look something like:
76
-
77
- ```javascript
78
- 'use strict';
79
-
80
- const Filter = require('broccoli-persistent-filter');
81
- const stripBom = require('strip-bom');
82
- const nyanCompiler = require('nyan-compiler');
83
-
84
- /*
85
- * Compile semicolons to nyan cats because why not.
86
- */
87
- class NyanCompiler extends Filter {
88
- processString(string, relativePath) {
89
- try {
90
- return nyanCompiler(stripBom(string), relativePath);
91
- } catch(e) {
92
- e.type = 'Nyan Compilation Error';
93
- // assuming error location is nested
94
- e.location = e.location.start;
95
-
96
- throw e;
97
- }
98
- }
99
- }
100
- ```
101
-
102
- To give a real world example, let's modify `broccoli-sass-source-map`:
103
-
104
- ```javascript
105
- function rethrowBuildError(e) {
106
- if (typeof e === 'string') {
107
- throw new Error('[string exception] ' + e);
108
- } else {
109
- e.type = 'Sass Syntax Error';
110
- e.message = e.formatted;
111
- e.location = {
112
- line: e.line,
113
- column: e.column
114
- };
115
-
116
- throw e;
117
- }
118
- }
119
-
120
- SassCompiler.prototype.build = function() {
121
- // ... code
122
- return this.renderSass(sassOptions).then(function(result) {
123
- var files = [
124
- writeFile(destFile, result.css)
125
- ];
126
-
127
- if (this.sassOptions.sourceMap && !this.sassOptions.sourceMapEmbed) {
128
- files.push(writeFile(sourceMapFile, result.map));
129
- }
130
-
131
- return Promise.all(files);
132
- }.bind(this)).catch(function(e) {
133
- rethrowBuildError(e);
134
- });
135
- };
136
- ```
@@ -1,53 +0,0 @@
1
- # Experiments
2
-
3
- "Experiments" are what Ember CLI calls [Feature Toggle](https://en.wikipedia.org/wiki/Feature_toggle).
4
-
5
- They are defined in `lib/experiments/index.js`. For example:
6
-
7
- ```javascript
8
- const availableExperiments = [
9
- 'CONFIG_CACHING',
10
- ];
11
- ```
12
-
13
- When a new feature is added, all supporting code and tests **must** be guarded
14
- to ensure all tests pass when the feature is enabled _or_ disabled:
15
-
16
- ```javascript
17
- const { isExperimentEnabled } = require('../experiments');
18
-
19
- // ...snip...
20
- if (isExperimentEnabled('SOME_EXPERIMENT')) {
21
- ...
22
- } else {
23
- ...
24
- }
25
- ```
26
-
27
- An experiment can be summarized into three different states.
28
-
29
- ## Development
30
-
31
- During active development of a feature, it can be enabled by setting the experiments
32
- related environment variable (`'EMBER_CLI_' + EXPERIMENT_NAME`).
33
-
34
- For example, to enable the `CONFIG_CACHING` experiment mentioned in the example
35
- above while running tests you would run the following command:
36
-
37
- ```
38
- EMBER_CLI_CONFIG_CACHING=true yarn test
39
- ```
40
-
41
-
42
- ## Unsupported
43
-
44
- The Ember CLI core team will evaluate each experiment before betas get released.
45
- If the experiment is not ready, the entry for the experiment is deleted from
46
- `lib/experiments/index.js` (and therefore disabled).
47
-
48
- ## Supported
49
-
50
- Once an experiment has gone through the different stages of beta, and we can
51
- confidently say a specific feature from an experiment will be supported, we
52
- delete the entry in `lib/experiments/index.js` and remove the experiment guards
53
- (e.g. if (experiments.FOO_BAR) {) from the codebase.
@@ -1,43 +0,0 @@
1
- # Node Support
2
-
3
- ## Supported Version Matrix
4
-
5
- | Node LTS Version | Supported Ember CLI Versions |
6
- |------------------|------------------------------|
7
- | 0.10.x | 0.0.0 - 2.8.x |
8
- | 0.12.x | 0.0.0 - 2.11.x |
9
- | 4.x | 1.13.9 - 3.1.x |
10
- | 5.x | 1.13.9 - 2.6.3 |
11
- | 6.x | 2.9.0 - 3.9.x |
12
- | 7.x | 2.10.0 - 2.16.x |
13
- | 8.x | 2.13.3 - 3.16.x |
14
- | 9.x | 2.16.2 - 3.2.x |
15
- | 10.x | 3.1.3 - 3.28.0 |
16
- | 11.x | 3.9.0 - 3.13.0 |
17
- | 12.x | 3.10.0 - Current |
18
- | 13.x | 3.15.0 - 3.20.0 |
19
- | 14.x | 3.19.0 - Current |
20
-
21
-
22
- ## Design
23
-
24
- Commits to the `HEAD` of the master branch will provide support for any Active
25
- Node.js LTS and the current stable Node.js version(s).
26
- This will be enforced via CI, preventing us from landing code which won't work
27
- with versions which we support. This means that our schedule for support is
28
- tied to the [LTS release schedule for
29
- Node.js](https://github.com/nodejs/LTS#lts_schedule).
30
-
31
- ## Current support:
32
-
33
- * v12: Released as stable version then converted to LTS.
34
- * Supported by ember-cli/ember-cli#master until: 2022-04-30.
35
- * v14: Released as stable version then converted to LTS.
36
- * Supported by ember-cli/ember-cli#master until: 2023-04-30.
37
-
38
- ## Release Process and Support Policy
39
-
40
- Ember and Ember CLI have committed to supporting the [Node.js LTS schedule](https://github.com/nodejs/LTS#lts-schedule)
41
- for the `HEAD` of our `master` branch(es). This means that we will drop support
42
- per the [Node.js Release Working Group](https://github.com/nodejs/Release)'s schedule without a major version
43
- bump/change of ember-cli itself.