Skip to content

Commit b952c4c

Browse files
authored
Clarify app/addon/v2 addon and type checking in README
1 parent 1c92d9a commit b952c4c

File tree

1 file changed

+7
-16
lines changed

1 file changed

+7
-16
lines changed

README.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,17 @@ With every release, we output the `--typescript` output of new ember apps to thi
99

1010
## How to use TypeScript without `ember-cli-typescript`?
1111

12-
In the [ember-cli-babel](https://github.com/emberjs/ember-cli-babel#enabling-typescript-transpilation) docs, it mention that in your `ember-cli-build.js`, you can specify:
12+
13+
Apps and v1 addons need to configure Babel to compile TypeScript files via the `ember-cli-babel` config, as described in the [ember-cli-babel](https://github.com/emberjs/ember-cli-babel#enabling-typescript-transpilation).
14+
15+
Additionally, you will need the `tsconfig.json` generated by the Ember TypeScript blueprint (see above), and then can run [`glint`](https://typed-ember.gitbook.io/glint) or `tsc` directly on the CLI. (Again, see the official docs for details!)
16+
17+
### Apps
18+
1319
```js
1420
'ember-cli-babel': {
1521
enableTypeScriptTransform: true,
1622
},
17-
```
18-
19-
For v1 addons, this would be specified in the node-land `index.js`:
20-
```js
21-
module.exports = {
22-
name: require('package').name,
23-
options: {
24-
'ember-cli-babel': {
25-
enableTypeScriptTransform: true
26-
}
27-
}
28-
}
29-
```
30-
31-
## What about for v2 addons?
3223

3324
The [V2 Addon Blueprint](https://github.com/embroider-build/addon-blueprint) does not use nor need ember-cli-typescript, nor any of its features.
3425

0 commit comments

Comments
 (0)