From b952c4c0f90876b513e8c35a98d6b8795c62873b Mon Sep 17 00:00:00 2001 From: Chris Krycho Date: Thu, 7 Dec 2023 09:35:08 -0700 Subject: [PATCH] Clarify app/addon/v2 addon and type checking in README --- README.md | 23 +++++++---------------- 1 file changed, 7 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 3de3d029b..46da2cf45 100644 --- a/README.md +++ b/README.md @@ -9,26 +9,17 @@ With every release, we output the `--typescript` output of new ember apps to thi ## How to use TypeScript without `ember-cli-typescript`? -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: + +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). + +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!) + +### Apps + ```js 'ember-cli-babel': { enableTypeScriptTransform: true, }, -``` - -For v1 addons, this would be specified in the node-land `index.js`: -```js -module.exports = { - name: require('package').name, - options: { - 'ember-cli-babel': { - enableTypeScriptTransform: true - } - } -} -``` - -## What about for v2 addons? The [V2 Addon Blueprint](https://github.com/embroider-build/addon-blueprint) does not use nor need ember-cli-typescript, nor any of its features.