@embroider/compat NPM

Embroider: a modern build system for EmberJS apps

This repo implements a new three-stage build system for Ember apps:

The first stage achieves backward compatibility by building each classic Ember Addon package into a new v2 package format. This makes each package much more static and analyzable. The eventual goal is to do less and less work in this stage, as addons publish to NPM natively in v2 format.
The second stage takes a collection of v2-formatted addons plus an application and "compiles out" all Ember-specific conventions, such that the output can be understood by any tool that can handle standards-compliant Javascript. This stage is setup with good inputs and outputs that make it much easier to benefit from incremental improvements to our dependency analysis. The immediate goal is not to implement every possible optimization, but rather to make a good place for those optimizations to happen.
The third stage ("final packaging") can be handled by existing tools like Webpack, Rollup, or Parcel with only a small amount of configuration. Not because we want to force every Ember developer to choose and configure one of these tools! But because a stable, standards-compliant API between stage 2 and 3 improves our ability to innovate and experiment with taking the best parts of wider JS ecosystem tooling.

You can read more about the motivation and key ideas in the intro to the SPEC.

Status / Should I Use It?

This is beta-quality software. Teams are encouraged to test their apps and addons using Embroider and report bugs. We need more real-world testing before we can hit stable 1.0 and integrate into ember-cli as the default build pipeline.

The main risks to be aware of if you choose to use Embroider in production are:

you're likely to discover some Ember addons don't work or break your build
Embroider's own configuration options are subject to change, so you'll need to read the CHANGELOG.md when updating the Embroider packages.

For Addon Authors

The v2 Addon Format RFC is the official spec for the packages that Embroider natively handles. Addon authors should see ADDON-AUTHOR-GUIDE.md for advice on how to get their addons ready for Embroider.

How to try it

Add dependencies:

yarn add --dev @embroider/core @embroider/compat @embroider/webpack

Edit ember-cli-build.js:

-return app.toTree();
+const { Webpack } = require('@embroider/webpack');
+return require('@embroider/compat').compatBuild(app, Webpack);

Alternatively, if you are passing optional extra broccoli trees into app.toTree(), you can rewrite like:

-return app.toTree(extraTreeHere);
+const { Webpack } = require('@embroider/webpack');
+return require('@embroider/compat').compatBuild(app, Webpack, {
+  extraPublicTrees: [extraTreeHere]
+});

Use ember serve, ember test, and ember build as usual.

Options

You can pass options into Embroider by passing them into the compatBuild function like:

return require('@embroider/compat').compatBuild(app, Webpack, {
  // staticAddonTestSupportTrees: true,
  // staticAddonTrees: true,
  // staticHelpers: true,
  // staticComponents: true,
  // packagerOptions: {
  //    webpackConfig: { }
  // }
});

The options are documented in detail in Core Options and Compat Options.

The recommended steps when introducing Embroider into an existing app are:

First make it work with no options. This is the mode that supports maximum backward compatibility.
Enable staticAddonTestSupportTrees and staticAddonTrees and test your application. This is usually safe, because most code in these trees gets consumed via import statements that we can analyze. But you might find exceptional cases where some code is doing a more dynamic thing.
Enable staticHelpers and test. This is usually safe because addons get invoke declarative in templates and we can see all invocations.
Enable staticComponents, and work to eliminate any resulting build warnings about dynamic component invocation. You may need to add packageRules that declare where invocations like {{component someComponent}} are getting someComponent from.
Once your app is working with all of the above, you can enable splitAtRoutes and add the @embroider/router and code splitting should work.

Analyzing Bundles

see ANALYZING.md

Contributing

see CONTRIBUTING.md

License

This project is licensed under the MIT License.

Acknowledgements

Thanks to Cardstack for sponsoring Embroider's development.

@everything-registry/sub-chunk-288 @zalastax/nolb-_emb

3.4.9-unstable.3d20631

2 days ago

3.4.9-unstable.ccbf41f

3 days ago

3.4.9-unstable.ea895c2

5 days ago

3.4.8

9 days ago

3.4.8-unstable.fad2387

10 days ago

3.4.8-unstable.649e0eb

11 days ago

3.4.8-unstable.c5595f2

11 days ago

3.4.8-unstable.d740ef0

11 days ago

3.4.8-unstable.445e96b

12 days ago

3.4.6-unstable.ea2a455

17 days ago

3.4.6-unstable.cb8efec

17 days ago

3.4.8-unstable.80f442d

17 days ago

3.4.6-unstable.ef8eacd

18 days ago

3.4.7

17 days ago

3.4.6-unstable.2afc470

23 days ago

3.4.6-unstable.b5fd677

23 days ago

3.4.6-unstable.35f9ecd

25 days ago

3.4.6-unstable.8e692cc

25 days ago

3.4.6-unstable.e1142b1

1 month ago

3.4.6-unstable.bdb7f3d

1 month ago

3.4.6-unstable.11f2c70

1 month ago

3.4.6-unstable.433b22c

1 month ago

3.4.6-unstable.bac2415

1 month ago

3.4.6-unstable.f30e685

2 months ago

3.4.6

2 months ago

3.4.6-unstable.6d64eff

2 months ago

3.4.6-unstable.4c0881e

2 months ago

3.4.6-unstable.c52ad5c

2 months ago

3.4.6-unstable.a90d03d

2 months ago

3.4.6-unstable.8c7b24d

2 months ago

3.4.5

2 months ago

3.4.4-unstable.d6b87d7

2 months ago

3.4.4-unstable.50b6f9e

2 months ago

3.4.4-unstable.f56eaf1

2 months ago

3.4.4-unstable.12a42ca

3 months ago

3.4.4-unstable.43da932

3 months ago

3.4.4-unstable.d8e1f36

3 months ago

3.4.4-unstable.70b1c6f

3 months ago

3.4.4-unstable.c5f8d55

3 months ago

3.4.4-unstable.b10d4db

3 months ago

3.4.4-unstable.f361b71

3 months ago

3.4.4

3 months ago

3.4.4-unstable.2f2d9f8

3 months ago

3.4.2-unstable.7f81070

3 months ago

3.4.2-unstable.6b405bd

3 months ago

3.4.2-unstable.eba0f6a

3 months ago

3.4.2-unstable.69a0e58

3 months ago

3.4.2-unstable.2287af7

3 months ago

3.4.2-unstable.d015c8d

3 months ago

3.4.2-unstable.289f83d

4 months ago

3.4.2-unstable.a74ae69

4 months ago

3.4.3

4 months ago

3.4.2-unstable.7357b5a

4 months ago

3.4.2-unstable.a9f892a

4 months ago

3.4.2-unstable.2edb355

4 months ago

3.4.2-unstable.241f631

4 months ago

3.4.2-unstable.2a6775b

4 months ago

3.4.2-unstable.ecb0185

4 months ago

3.4.2-unstable.b4add32

5 months ago

3.4.1-unstable.5010f91

5 months ago

3.4.1-unstable.8bea275

5 months ago

3.4.2-unstable.7619120

5 months ago

3.4.2

5 months ago

3.4.1

5 months ago

3.4.1-unstable.efd9117

5 months ago

3.4.1-unstable.0dc2c93

5 months ago

3.4.1-unstable.b6c717f

5 months ago

3.4.1-unstable.b33cb4c

5 months ago

3.4.1-unstable.996b2ff

5 months ago

3.4.1-unstable.b446d89

5 months ago

3.4.1-unstable.2cefe80

5 months ago

3.4.1-unstable.3480aa6

5 months ago

3.4.1-unstable.65ea799

5 months ago

3.4.1-unstable.6c8efe8

5 months ago

3.1.5-unstable.ef70747

10 months ago

7 months ago

9 months ago

9 months ago

7 months ago

3.2.4-unstable.157dd62

7 months ago

3.1.5-unstable.d660c6a

10 months ago

3.2.4-unstable.cb4e47b

7 months ago

3.2.3-unstable.f6078b1

7 months ago

3.0.3-unstable.7d1b7f0

10 months ago

3.2.1-unstable.65cfb16

9 months ago

3.1.3-unstable.7bd035f

10 months ago

3.2.4-unstable.38a3aa7

7 months ago

3.1.3

10 months ago

3.0.3-unstable.3030376

10 months ago

3.1.2

10 months ago

3.1.1

10 months ago

3.1.0

10 months ago

3.2.2-unstable.956b96b

7 months ago

3.1.5-unstable.b321a7a

10 months ago

3.3.1-unstable.bb9dfa8

6 months ago

3.1.5

10 months ago

3.1.6-unstable.39842d0

9 months ago

3.1.4

10 months ago

3.2.2-unstable.f89a1c7

7 months ago

3.1.6-unstable.3fbc5ec

9 months ago

3.1.6-unstable.ad658ea

10 months ago

3.2.2-unstable.e209cc9

9 months ago

3.1.3-unstable.53de9f9

10 months ago

3.1.6-unstable.4f3826d

10 months ago

3.2.2-unstable.fe69a74

7 months ago

3.2.2-unstable.4fc4f94

9 months ago

3.1.6-unstable.1cdd50c

10 months ago

3.1.6-unstable.4a44b92

10 months ago

3.1.4-unstable.229045b

10 months ago

3.2.2-unstable.45736c1

7 months ago

3.1.6-unstable.e3a00a0

10 months ago

3.1.6-unstable.9834d5b

10 months ago

3.2.1-unstable.5da719c

9 months ago

3.2.4-unstable.33ad547

7 months ago

3.4.1-unstable.ebf92d6

5 months ago

3.1.5-unstable.96f87d1

10 months ago

3.2.4-unstable.77ed393

7 months ago

3.2.2-unstable.b49b5e2

9 months ago

3.2.1-unstable.9048919

9 months ago

3.2.2-unstable.cacd923

8 months ago

3.1.6-unstable.2c0e2bd

9 months ago

3.1.5-unstable.326562b

10 months ago

3.2.2-unstable.4665d9d

7 months ago

3.1.3-unstable.128902

10 months ago

3.2.4-unstable.3934dea

6 months ago

3.3.1-unstable.2914652

5 months ago

3.2.3-unstable.1e88426

7 months ago

3.1.5-unstable.a1b2971

10 months ago

3.2.4-unstable.80e325d

6 months ago

3.2.1-unstable.7a45975

9 months ago

3.1.1-unstable.9f97d6e

10 months ago

3.3.2-unstable.d8895a2

5 months ago

3.3.2-unstable.2d59287

5 months ago

3.2.1-unstable.b8ac17b

9 months ago

3.1.3-unstable.8e0a473

10 months ago

3.1.6-unstable.ed6910d

10 months ago

3.2.2-unstable.349e7fe

9 months ago

3.1.6-unstable.f032c58

10 months ago

3.1.5-unstable.1cfdcec

10 months ago

3.3.1-unstable.075b94d

5 months ago

3.2.4-unstable.20d0348

6 months ago

3.1.4-unstable.db25d62

10 months ago

3.3.2-unstable.04bf3a7

5 months ago

3.1.5-unstable.67f82f3

10 months ago

3.2.2-unstable.a449708

7 months ago

3.3.2-unstable.9a64955

5 months ago

3.4.1-unstable.ba9fd29

5 months ago

3.2.4-unstable.0a697b4

7 months ago

3.2.4-unstable.786fccf

7 months ago

3.3.1-unstable.138272d

6 months ago

3.2.2-unstable.51c1794

8 months ago

3.1.4-unstable.47fc75d

10 months ago

3.3.2-unstable.d68fbec

5 months ago

3.1.6-unstable.5fd7c48

10 months ago

3.1.5-unstable.63f6836

10 months ago

3.1.2-unstable.02a1fbc

10 months ago

3.1.6-unstable.ed7b6fe

9 months ago

3.3.2-unstable.5daf70e

5 months ago

3.1.3-unstable.f4b7a14

10 months ago

3.2.2-unstable.a3ff5ed

9 months ago

3.2.2-unstable.ace1564

7 months ago

3.2.2-unstable.c4f8973

7 months ago

3.2.1-unstable.17b7b60

9 months ago

3.2.1-unstable.147128e

9 months ago

3.2.2-unstable.2cbaf7c

9 months ago

3.1.6-unstable.3fc3a4d

9 months ago

3.4.1-unstable.05badd2

5 months ago

3.2.1-unstable.b6dee02

9 months ago

3.1.6-unstable.812df54

9 months ago

3.3.2-unstable.0ebfb9d

5 months ago

3.2.4-unstable.6d4a757

6 months ago

3.2.3-unstable.268ef82

7 months ago

3.2.2-unstable.17cf74c

8 months ago

3.2.4-unstable.518ea37

6 months ago

3.2.4-unstable.cd8d1be

6 months ago

3.1.6-unstable.7407f3a

9 months ago

3.2.2-unstable.eba2166

7 months ago

3.2.4-unstable.65d9067

6 months ago

3.3.2-unstable.9606cac

5 months ago

3.1.4-unstable.5120323

10 months ago

3.4.0

5 months ago

3.0.3-unstable.dff78b0

10 months ago

3.1.1-unstable.7532326

10 months ago

3.3.1-unstable.6c2f482

5 months ago

3.3.1-unstable.361e2f7

6 months ago

3.2.2-unstable.d660963

9 months ago

3.3.1-unstable.239b522

6 months ago

3.1.6-unstable.0c7aa66

9 months ago

3.2.4-unstable.f84b5cd

6 months ago

3.1.5-unstable.be02b4a

10 months ago

3.3.2-unstable.2d06aa0

5 months ago

3.3.1

5 months ago

3.3.0

6 months ago

3.3.1-unstable.ded6329

5 months ago

3.1.6-unstable.0e00f2b

9 months ago

3.2.4-unstable.dfe4bc3

7 months ago

3.0.3-unstable.f7c5518

10 months ago

3.0.3-unstable.8a8ddf6

10 months ago

3.0.3-unstable.448d29f

10 months ago

3.0.1-unstable.64bbe47

11 months ago

2.1.2-unstable.e26de29

12 months ago

3.0.3-unstable.9b83c11

10 months ago

3.0.1-unstable.806723a

12 months ago

2.1.2-unstable.137fcab

1 year ago

3.0.1-unstable.8f4cd85

12 months ago

2.1.2-unstable.514566f

1 year ago

2.1.2-unstable.a037764

12 months ago

2.1.2-unstable.40cebb2

12 months ago

2.1.2-unstable.3a232cc

1 year ago

3.0.2-unstable.def53ab

11 months ago

2.1.2-unstable.16dc72c

12 months ago

2.1.2-unstable.e35628d

12 months ago

3.0.1-unstable.d950e6a

11 months ago

2.1.2-unstable.58c9ed2

12 months ago

3.0.1-unstable.abc3e4d

12 months ago

2.1.1-unstable.73213f2a

1 year ago

3.0.2-unstable.3936fdb

11 months ago

3.0.1-unstable.18fd6a9

12 months ago

2.1.1-unstable.21eae41

1 year ago

2.1.2-unstable.c58f146

12 months ago

3.0.1-unstable.8dfe2b3

11 months ago

2.1.2-unstable.df7f441

1 year ago

3.0.2-unstable.5a5f4d5

11 months ago

2.1.2-unstable.1ecd57e

12 months ago

2.1.2-unstable.c386613

12 months ago

3.0.1-unstable.e3a95b9

11 months ago

3.0.3-unstable.a4d18ab

11 months ago

2.1.2-unstable.3a9d8ad

1 year ago

3.0.2

11 months ago

3.0.1

11 months ago

2.1.2-unstable.9aaea50

12 months ago

3.0.0

12 months ago

2.1.2-unstable.e891bf1

12 months ago

3.0.1-unstable.739b8b5

11 months ago

2.1.2-unstable.3878f42

12 months ago

2.1.2-unstable.a5135e2

12 months ago

3.0.2-unstable.95eef86

11 months ago

3.0.1-unstable.22e656d

11 months ago

3.0.1-unstable.3f71493

11 months ago

2.1.1-unstable.00ec2e7

1 year ago

2.1.2-unstable.a6cd4aa

1 year ago

2.1.2-unstable.6e54dd1

1 year ago

3.0.2-unstable.47e7548

11 months ago

2.1.2-unstable.5d60507

1 year ago

3.0.2-unstable.791c2c3

11 months ago

2.1.1-unstable.72d5a8e

1 year ago

3.0.1-unstable.da01d2b

11 months ago

2.1.2-unstable.5877484

12 months ago

2.1.1-unstable.936fd63

1 year ago

2.1.2-unstable.f004d11

12 months ago

2.1.2-unstable.a993025

1 year ago

3.0.3-unstable.65632a7

11 months ago

3.0.1-unstable.ea4b13f

11 months ago

2.1.2-unstable.77c945c

1 year ago

2.1.2-unstable.e2cd385

12 months ago

3.0.1-unstable.d120477

11 months ago

3.0.1-unstable.9f46f5e

11 months ago

3.0.1-unstable.77dd32c

11 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago