ember-rfc176-data

JSON data for RFC #176

Related Projects

• babel-plugin-ember-modules-api-polyfill
• ember-modules-codemod

Contents

New Modules to Globals

New Modules to Globals

@ember/application

@ember/array

@ember/canary-features

@ember/component

@ember/controller

@ember/debug

@ember/destroyable

@ember/engine

@ember/enumerable

@ember/error

@ember/helper

@ember/instrumentation

@ember/map

@ember/modifier

@ember/object

@ember/polyfills

@ember/routing

@ember/runloop

@ember/service

@ember/string

@ember/template

@ember/template-compilation

@ember/template-factory

@ember/test

@ember/utils

@ember/version

@glimmer/tracking

jquery

rsvp

Scripts

The tables above can be generated using the scripts in the scripts folder, e.g.:

node scripts/generate-markdown-table.js

Contributing

mappings.json format

The mappings.json file contains an array of entries with the following format:

interface Mapping {
  /**
    The globals based API that this module and export replace.
   */
  global: string;

  /**
    The module to import.
   */
  module: string;

  /**
    The export name from the module.
   */
  export: string;

  /**
    `true` if this module / export combination has been deprecated.
   */
  deprecated: boolean;

  /**
    The recommended `localName` to use for a given module/export. Only present
    when a name other than the value for `export` should be used.

    This is useful for things like ember-modules-codemod or eslint-plugin-ember
    so that they can provide a nice suggested import for a given global path usage.
   */
  localName?: string;

  /**
    When this mapping is deprecated it may include a replacement module/export which
    should be used instead.
  */
  replacement?: {
    module: string;
    export: string;
  }
}

Reserved Words

In some cases, Ember's names may conflict with names built in to the language. In those cases, we should not inadvertently shadow those identifiers.

import Object from "@ember/object";

// ...later
Object.keys(obj);
// oops! TypeError: Object.keys is not a function

A list of reserved identifiers (including Object) is included in reserved.json. Anything that appears in this list should be prefixed with Ember; so, for example, import Object from "@ember/object" should become import EmberObject from "@ember/object".