Creating v2 addon guide

[ef4]

This is the start of a guide on porting addons to v2 format.

[NullVoxPopuli]

why or why shouldn't we also ship compiled templates?

(for example: https://github.com/NullVoxPopuli/ember-addon-v2-typescript-demo/blob/main/my-addon/babel.config.cjs#L34-L39 )

const { precompile } = require('@glimmer/compiler');

// ...

      resolve('babel-plugin-ember-template-compilation'),
      {
        precompile,
        enableLegacyModules: ['ember-cli-htmlbars'],
      },
    ],

by not compiling away the templates, apps have more work to do, yea?

[ef4]

Because the compiled format is deeply tied to the exact ember version that's going to consume it.

[NullVoxPopuli]

gotchya, so this is probably only useful if you can guarantee that addons have the same ember version as apps 🤔

could be tricky

[ef4]

It would be possible to make the wire format (the thing that you'd have if you use babel-plugin-ember-template-compilation) a stable public API, but somebody with knowhow would need to prioritize a little design work.

[NullVoxPopuli]

Nice! this is very detailed!

[ef4]

Please try it and give more feedback, but I'm merging so we have a starting point for more PRs.

[angelayanpan]

| Optimized Embroider Safe | v1 |

in ADDON-AUTHOR-GUIDE.md
is this the same as Embroider Optimized?

[ef4]

Yes, this is the same thing tested by the embroider-safe scenario provide by @embroider/test-setup.

[angelayanpan]

Once you achieve Optimized Embroider Safe, you should enable the embroider-optimized

Maybe this makes it sound like there is a difference between Optimized Embroider Safe ? and embroider-optimized? I was confused when I read "Optimized Embroider Safe" multiple times before embroider-optimized was mentioned.