Ember CLI TypeScript Blueprints

Common errors

• Error: Cannot find module '@types/ember-data'

  cause Missing `ember-data` type definitions or an incorrect type registry setup, especially if using older `ember-cli-typescript` versions with Ember Data.
  fix Ensure `@types/ember-data` (if applicable for your Ember version/setup) is installed. Verify your `types/<your-app>/index.d.ts` file properly extends the `ModelRegistry` for Ember Data models. For modern Ember, ensure you're using official types and correctly extending type definitions.

• error TS2344: Type 'any' does not satisfy the constraint 'never'.

  cause This error often occurs when Ember Data's `ModelRegistry` is not properly populated with your application's models, causing TypeScript to infer `keyof ModelRegistry` as `never`.
  fix For each of your Ember Data models, ensure you add code to extend the `ModelRegistry` in your `types/ember-data/ember-data.d.ts` (or similar) file. Example: `declare module 'ember-data/types/registries/model' { export default interface ModelRegistry { 'my-model': MyModel; } }`

• EACCES: permission denied, unlink '/path/to/node_modules/.bin/ember'

  cause NPM or Yarn cache/permissions issues during addon installation, or conflicts if multiple blueprints attempt to install the same package.
  fix Try clearing your npm/yarn cache (`npm cache clean --force` or `yarn cache clean`). Delete `node_modules` and `package-lock.json` (or `yarn.lock`), then reinstall. If it's a permission error, ensure proper directory permissions or run with `sudo` (use cautiously).

Warnings

• breaking The `ember-cli-typescript-blueprints` package is officially archived and no longer maintained. Modern Ember CLI versions (4.8.0 and above) provide native TypeScript blueprint support, rendering this addon obsolete. Users should transition to the built-in `--typescript` flag for `ember new` and `ember generate` commands.
  Fix: Remove `ember-cli-typescript-blueprints` from your project. For new projects, use `ember new my-app --typescript`. For existing projects, configure `ember-cli-babel` for TypeScript and use `ember generate <entity> --typescript` where available, or manually create `.ts` files and configure `tsconfig.json`.
• breaking Using this addon with Ember versions 4.8.0+ and their official TypeScript types may lead to conflicts. The addon's underlying `ember-cli-typescript` integration (if used) might configure `@types` packages and Array prototype extensions which are incompatible with the stable, built-in types from `ember-source`.
  Fix: Migrate away from `ember-cli-typescript-blueprints` and `ember-cli-typescript` to leverage Ember's native TypeScript support. Ensure your `types/<your-app>/index.d.ts` file correctly imports `ember-source/types` and `ember-source/types/preview` if desired, and remove incompatible `@types` packages.
• gotcha Older versions of `ember-cli-typescript` (the parent ecosystem for these blueprints) shifted to using Babel for TypeScript transpilation in v2. This introduced breaking changes, such as lack of support for `const enum`, which required code modifications.
  Fix: If maintaining an older project using `ember-cli-typescript` v1, review the migration guide to v2, specifically addressing `const enum` usage and Babel configuration changes. Consider upgrading to native Ember CLI TypeScript support if possible.

Install

• npm install ember-cli-typescript-blueprints npm
• yarn add ember-cli-typescript-blueprints yarn
• pnpm add ember-cli-typescript-blueprints pnpm

Imports

• Ember CLI Commands

  ember install ember-cli-typescript-blueprints
  ember generate <entity-type> <name>

  This package is an Ember CLI addon, not a library providing JavaScript symbols for direct import. Its functionality is exposed via command-line interface commands (e.g., `ember generate`).

Quickstart

Demonstrates the historical installation and usage of the addon's CLI commands to generate TypeScript-aware Ember entities.

/*
  This package is largely obsolete. For new Ember projects or migrating existing ones to TypeScript,
  it is recommended to use Ember CLI's native TypeScript support, available in recent Ember versions.
  
  Historically, one would install and use it as follows:
*/

// 1. Install the addon (though deprecated, this shows historical installation):
npm install --save-dev ember-cli-typescript-blueprints
// or
yarn add --dev ember-cli-typescript-blueprints

// 2. The addon's blueprints would then override default JS blueprints.
//    Generating an entity would produce a TypeScript file (.ts) instead of JavaScript (.js).

// Generate a service:
// This would create `app/services/user.ts`
ember generate service user

// Generate a component:
// This would create `app/components/user-profile.ts`, `app/templates/components/user-profile.hbs`,
// and potentially `tests/integration/components/user-profile-test.ts`
ember generate component user-profile

/* Example of a generated TypeScript component file (simplified structure):

// app/components/user-profile.ts
import Component from '@glimmer/component';

interface UserProfileArgs {
  userName: string;
}

export default class UserProfileComponent extends Component<UserProfileArgs> {
  // Access component arguments via this.args
  get greeting(): string {
    return `Hello, ${this.args.userName}!`;
  }
}
*/