TypeScript: Getting Started

To start a new Ember project with TypeScript, add the --typescript flag when you run ember new:

ember new my-typescript-app --typescript

Using the --typescript flag changes the output of ember new in a few ways:

Project files will be generated with .ts extensions instead of .js.

In addition to the usual packages added with ember new, the following packages will be added at their current "latest" value:

• typescript – tooling to support TypeScript type checking and compilation.
• @tsconfig/ember – a shared TypeScript configuration for Ember apps.
• @typescript-eslint/* – ESLint support for TypeScript.
• @types/qunit - TypeScript type definitions for QUnit.
• @types/rsvp - TypeScript type definitions for RSVP.
• @warp-drive/core-types - shared core types, type utilities and constants for the WarpDrive and EmberData packages.

Zoey says...

Ember and EmberData publish their own native types compiled directly from their source code, so you do not need to install any @types/ember or @types/ember-data packages. These packages should be considered legacy, are only lightly maintained, and will conflict with the native types.

In addition to the usual files added with ember new, we also add:

• tsconfig.json – configuration to set up TypeScript for your project
• types/global.d.ts – the location for any global type declarations you need to write
• app/config/environment.d.ts – a basic set of types defined for the contents of your config/environment.js file

Additionally:

• package.json will have a lint:types script to check types with the command line.
• ember-cli-build.js will be configured to transform TypeScript at build-time.
• .ember-cli has isTypeScriptProject set to true, which will force the blueprint generators to generate TypeScript rather than JavaScript by default.
• .eslintrc.js will be configured for TypeScript.

To convert an existing app to TypeScript, you'll need to make the changes described above manually (for now). To facilitate this, we've included a converting guide.