Switch to maintenance mode

[NullVoxPopuli]

Blockers:

• Warnings when using ember-cli-babel 8.x #1567
• Add note to README
  • how to use TS without ec-typescript
    in apps:

    // ember-cli-build.js
    // ...
    'ember-cli-babel': {
      enableTypeScriptTransform: true,
    },

    in v1 addons:

    // <v1-addon-name>/index.js
    module.exports = {
      name: require('package').name,
      options: {
        'ember-cli-babel': {
          enableTypeScriptTransform: true
        }
      }
    }

  • add tsconfig.json
  • add types/ folder (with contents)
  • full example: https://stackblitz.com/github/ember-cli/editor-output/tree/stackblitz-app-output-typescript (output of ember new my-app --typescript)
• note / recommendation for folks who like the integrated TS worker / type-checker (use a webpack/vite plugin?)

[basz]

ember-cli-typescript can be removed when using ember-cli-babel v8?

[NullVoxPopuli]

it can be removed when using ember-cli-babel v7, provided you add the config in ember-cli-build.js

[LucasHillDex]

@NullVoxPopuli What version of ember is required to get built in types and TS generators?

[NullVoxPopuli]

starting in 4.9, you can:

import 'ember-source/types';
import 'ember-source/types/preview';

However, ember-data is not compatible with these types, which is why they are currently opt-in.

Starting in 5.1, you can only have:

import 'ember-source/types';

For generators, you want ember-source 5.1+, iirc

[basz]

An in-repo addon does not like that. Does that need something special?

[NullVoxPopuli]

For addons, you'd add to the index.js:

// <v1-addon-name>/index.js
module.exports = {
  name: require('package').name,
  options: {
    'ember-cli-babel': {
      enableTypeScriptTransform: true
    }
  }
}

[abeforgit]

and just to confirm: the prepack and postpack scripts that ran ember ts:precompile and ember ts:clean are just no longer needed at all?

[NullVoxPopuli]

they are aliases to commands that you could run yourself, yea.
the ts:precompile one is involved, and could maybe be simplified.

With v2 addons, the ts:* commands aren't needed at all.
(declarations for v2 addons are built in to a directory (we chose declarations), and then package.json#exports tells the tooling where to look for both modules and types: https://github.com/embroider-build/addon-blueprint/blob/main/files/__addonLocation__/package.json#L98

[abeforgit]

ah but for v1 addons, and for integration with typescript hosts, running the underlying commands would still be required to allow type imports, I gather?

[NullVoxPopuli]

correct -- a similar thing occurs for the v2-addon blueprint, but all the CLI flags are abstracted to the tsconfig.json

[abeforgit]

In that context though, for v1 addons, the two commands have definite value since they're non-trivial to recreate (theres quite some file copying happening that I don't really want to redo for every project)

so this addon could reduce scope to those two commands rather than being archived outright?
or better to move the commands out of here and maintain as a separate project?

[NullVoxPopuli]

I can't speak for the typed-ember team, but I think it totally fine to install and still use an archived project.

v2 addons will be the default in Polaris though, and there are loads of performance benefits to v2 addons - so I would encourage everyone migrate to v2 addons at some point (ie: not yet, still some bugs to work out (unless you have an appetite for combing through non-blueprint v2 addons)).

But, most importantly, I don't foresee anything needing to change aside from the above mentioned list in description of this issue (thus, if archived, no development would be needed, but it doesn't mean its taken down from npm -- folks can still use the package).