Skip to content

Commit 14a3ee1

Browse files
committed
Set readme with information folks need to know about
1 parent 044144f commit 14a3ee1

File tree

2 files changed

+28
-1
lines changed

2 files changed

+28
-1
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,29 @@ If you have an existing app that you would like to upgrade to use Vite consider
99
```
1010
pnpm dlx ember-cli@latest new my-app-name -b @ember/app-blueprint --pnpm
1111
```
12+
13+
## Options
14+
15+
### `--no-compat`
16+
17+
```
18+
pnpm dlx ember-cli@latest new my-app-name \
19+
--blueprint @ember/app-blueprint@alpha \
20+
--pnpm \
21+
--no-compat
22+
```
23+
24+
Does the following:
25+
- enables `type=module` in package.json (required for vite-ssr, and many ESM tools)
26+
- makes the build and boot _MUCH FASTER_
27+
(in large apps, this can have your app's boot be up to 1 minute faster)
28+
- removes `@embroider/compat`
29+
- removes support for:
30+
- hbs (both for component files, and testing)
31+
- content-for (in the HTML files)
32+
- v1 addons
33+
- node-land config/environment.js
34+
- removes `ember-cli`
35+
- ember-cli brings in a ton of old dependencies, so removing it makes installs much faster
36+
- downside though is that you no longer have scaffolding (`ember g`) -- however, you could use `pnpm dlx ember-cli g ...` (or `npx ember-cli g`)
37+

files/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
22
"name": "<%= name %>",
33
"version": "0.0.0",
4-
"private": true,
4+
"<% if (noCompat) { %>type": "module",
5+
"<% } %>private": true,
56
"description": "Small description for <%= name %> goes here",
67
"repository": "",
78
"license": "MIT",

0 commit comments

Comments
 (0)