DEPRECATED - ES6 import shims for Ember.js
JavaScript HTML
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Ember CLI Shims

Greenkeeper badge

Note: this project is deprecated. If you are using these shims in your project you should migrate to the new modules api outlined in RFC 176 as soon as you can. More information on this topic in the Ember 2.16 release blog post.

Note that you won't be able to drop this dependency from your app's package.json file until all your addons have upgraded to ember-cli-babel >= 6.6.0.

About

Ember CLI Shims (ECS) contain all the shims used in Ember CLI.

Note: The ember-data shim has been removed as of v0.1.0. The latest Ember-Data no longer has a bower dependency; ember-cli-shims >= v0.1.0 is only intended for use with Ember-Data v2.3.0 and up.

Usage

Simply import any of the shims as an ES6 module:

import Component from 'ember-component';
import run from 'ember-runloop';
import injectService from 'ember-service/inject';

Some of the shims have named exports (instead of/in addition to a default export):

import { assert, copy } from 'ember-metal/utils';
import { debounce } from 'ember-runloop';
import { isEmpty } from 'ember-utils';

Shims

The app-shims file provides a complete reference of all modules currently supported by this library.

Why?

Historically, Ember has recommended that developers reference core classes & utilities (ie Component, Route, isEmpty) via the root Ember namespace. This leads to the entire Ember module being imported into nearly every file:

import Ember from 'ember';

export default Ember.Component.extend({
  foo: Ember.inject.service(),
  bar: Ember.computed.readOnly('foo.bar')
});

It would be preferable to have different parts of Ember available as separate modules, allowing developers to only import what they need. This is the direction the framework is moving in, but the modules are not yet available. This has led to a common pattern of ES6 destructuring assignment to enable writing future-proof code:

import Ember from 'ember';

const { Component, computed, inject } = Ember;

export default Component.extend({
  foo: inject.service(),
  bar: computed.readOnly('foo.bar');
});

However, this library provides shims to mimic the future modules that Ember may provide, enabling developers to avoid destructuring and instead import the namespaces as modules today.

import Component from 'ember-component';
import computed from 'ember-computed';
import injectService from 'ember-service/inject';

export default Component.extend({
  foo: injectService(),
  bar: computed.readOnly('foo.bar');
});

That way, as true modules become available in the Ember ecosystem, we can merely remove the shims from ECS upstream, requiring little to no refactoring on the part of developers who have opted-in to this pattern early. Ultimately, the goal of this library is to be replaced completely once Ember itself is an npm package/addon and exports its own modules.

License

Ember CLI Shims is MIT Licensed.