EmberApp is the main class Ember CLI uses to manage the Broccoli trees for your application. It is very tightly integrated with Broccoli and has a toTree() method you can use to get the entire tree for your application.

Available init options:

  • storeConfigInMeta, defaults to true
  • autoRun, defaults to true
  • outputPaths, defaults to {}
  • minifyCSS, defaults to `{enabled: !!isProduction,options: { relativeTo: 'assets' }}
  • minifyJS, defaults to `{enabled: !!isProduction}
  • sourcemaps, defaults to {}
  • trees, defaults to {}
  • jshintrc, defaults to {}
  • vendorFiles, defaults to {}
  • addons, defaults to { blacklist: [], whitelist: [] }

Static Method Summary

Static Public Methods
public static
env( ): String

Returns the environment name

Constructor Summary

Public Constructors
public
EmberApp([defaults], [options={}])

EmberApp is the main class Ember CLI uses to manage the Broccoli trees for your application. It is very tightly integrated with Broccoli and has a toTree() method you can use to get the entire tree for your application.

Method Summary

Public Methods
public
public
import(asset, [options])

Imports an asset into the application.

public
toTree([additionalTrees]): Tree

Returns the merged tree for this application

Private Methods
private
private
private

Checks the result of addon.isEnabled() if it exists, defaults to true otherwise.

private
_addonInstalled(addonName): Boolean
private
private
_concatFiles(tree, options):

Delegates to broccoli-concat with the sourceMapConfig option set to options.sourcemaps.

private
_getAssetPath(asset): (String | Undefined)
private
_import(assetPath, options, directory, subdirectory, extension)
private

Calls the importTransforms hook on addons.

private
_initOptions(options)

Initializes the options property from the options parameter and a set of default values from Ember CLI.

private
_initProject(options)

Initializes the project property from options.project or the closest Ember CLI project from the current working directory.

private

Initializes the tests and hinting properties.

private
private

Calls the included hook on addons.

private
private

Resolves a path relative to the project's root

private
addonLintTree(type, tree): Tree

Runs addon lintTree hooks and returns a single tree containing all their output.

private
addonPostprocessTree(type, tree): Tree

Runs addon post-processing on a given tree and returns the processed tree.

private
addonPreprocessTree(type, tree): Tree

Runs addon pre-processing on a given tree and returns the processed tree.

private

Returns a list of trees for a given type, returned by all addons.

private

Runs the app, tests and templates trees through the chain of addons that produces lint trees.

private

Loads and initializes addons for this project. Calls initializeAddons on the Project.

private

Imports legacy imports in this.vendorFiles

private

Returns whether an addon should be added to the project

private
testIndex( ): Tree

Returns the tree for /tests/index.html

private

Returns an array of trees for this application

Static Public Methods

lib/broccoli/ember-app.js:500

public static env( ): String

Returns the environment name

Return:

String

Environment name

Public Constructors

lib/broccoli/ember-app.js:81

public EmberApp([defaults], [options={}])

Parameters:

Name Type Attribute Description
defaults Object
  • optional
options Object
  • optional
  • default: {}

Configuration options

Public Methods

lib/broccoli/ember-app.js:1435

public dependencies( ): Object

Return:

Object

Alias to the project's dependencies function

lib/broccoli/ember-app.js:1444

public import(asset, [options])

Imports an asset into the application.

Parameters:

Name Type Attribute Description
asset Object | String

Either a path to the asset or an object with environment names and paths as key-value pairs.

options Object
  • optional

Options object

options.type String
  • optional
  • default: 'vendor'

Either 'vendor' or 'test'

options.prepend Boolean
  • optional
  • default: false

Whether or not this asset should be prepended

options.destDir String
  • optional

Destination directory, defaults to the name of the directory the asset is in

options.outputFile String
  • optional

Specifies the output file for given import. Defaults to assets/vendor.{js,css}

options.using Array
  • optional

Specifies the array of transformations to be done on the asset. Can do an amd shim and/or custom transformation

lib/broccoli/ember-app.js:1738

public toTree([additionalTrees]): Tree

Returns the merged tree for this application

Parameters:

Name Type Attribute Description
additionalTrees Array
  • optional

Array of additional trees to merge

Return:

Tree

Merged tree for this application

Private Methods

lib/broccoli/ember-app.js:539

private _addonDisabledByBlacklist(addon): Boolean

Parameters:

Name Type Attribute Description
addon Addon

Return:

lib/broccoli/ember-app.js:550

private _addonDisabledByWhitelist(addon): Boolean

Parameters:

Name Type Attribute Description
addon Addon

Return:

lib/broccoli/ember-app.js:527

private _addonEnabled(addon): Boolean

Checks the result of addon.isEnabled() if it exists, defaults to true otherwise.

Parameters:

Name Type Attribute Description
addon Addon

Return:

lib/broccoli/ember-app.js:1425

private _addonInstalled(addonName): Boolean

Parameters:

Name Type Attribute Description
addonName String

The name of the addon we are checking to see if it's installed

Return:

lib/broccoli/ember-app.js:561

private _checkEmberCliBabel(addons): Boolean

Parameters:

Name Type Attribute Description
addons Addons

Return:

lib/broccoli/ember-app.js:512

private _concatFiles(tree, options):

Delegates to broccoli-concat with the sourceMapConfig option set to options.sourcemaps.

Parameters:

Name Type Attribute Description
tree Object
options Object

Return:

lib/broccoli/ember-app.js:1573

private _getAssetPath(asset): (String | Undefined)

Parameters:

Name Type Attribute Description
asset (Object | String)

Return:

(String | Undefined)

assetPath

lib/broccoli/ember-app.js:1494

private _import(assetPath, options, directory, subdirectory, extension)

Parameters:

Name Type Attribute Description
assetPath String
options Object
directory String
subdirectory String
extension String
lib/broccoli/ember-app.js:641

private _importAddonTransforms( )

Calls the importTransforms hook on addons.

lib/broccoli/ember-app.js:221

private _initOptions(options)

Initializes the options property from the options parameter and a set of default values from Ember CLI.

Parameters:

Name Type Attribute Description
options Object
lib/broccoli/ember-app.js:203

private _initProject(options)

Initializes the project property from options.project or the closest Ember CLI project from the current working directory.

Parameters:

Name Type Attribute Description
options Object
lib/broccoli/ember-app.js:187

private _initTestsAndHinting(options)

Initializes the tests and hinting properties.

Defaults to false unless ember test was used or this is not a production build.

Parameters:

Name Type Attribute Description
options Object
lib/broccoli/ember-app.js:391

private _initVendorFiles( )

lib/broccoli/ember-app.js:603

private _notifyAddonIncluded( )

Calls the included hook on addons.

lib/broccoli/ember-app.js:1130

private _podTemplatePatterns( ): Array

Return:

Array

An array of regular expressions.

lib/broccoli/ember-app.js:381

private _resolveLocal( )

Resolves a path relative to the project's root

lib/broccoli/ember-app.js:883

private addonLintTree(type, tree): Tree

Runs addon lintTree hooks and returns a single tree containing all their output.

Parameters:

Name Type Attribute Description
type String

Type of tree

tree Tree

Tree to process

Return:

Tree

Processed tree

lib/broccoli/ember-app.js:809

private addonPostprocessTree(type, tree): Tree

Runs addon post-processing on a given tree and returns the processed tree.

This enables addons to do process immediately after the preprocessor for a given type is run, but before concatenation occurs. If an addon wishes to apply a transform before the preprocessors run, they can instead implement the preprocessTree hook.

To utilize this addons implement postprocessTree hook.

An example, would be to apply some broccoli transform on all JS files, but only after the existing pre-processors have run.

module.exports = {
  name: 'my-cool-addon',
  postprocessTree(type, tree) {
    if (type === 'js') {
      return someBroccoliTransform(tree);
    }

    return tree;
  }
}

Parameters:

Name Type Attribute Description
type String

Type of tree

tree Tree

Tree to process

Return:

Tree

Processed tree

lib/broccoli/ember-app.js:847

private addonPreprocessTree(type, tree): Tree

Runs addon pre-processing on a given tree and returns the processed tree.

This enables addons to do process immediately before the preprocessor for a given type is run. If an addon wishes to apply a transform after the preprocessors run, they can instead implement the postprocessTree hook.

To utilize this addons implement preprocessTree hook.

An example, would be to remove some set of files before the preprocessors run.

var stew = require('broccoli-stew');

module.exports = {
  name: 'my-cool-addon',
  preprocessTree(type, tree) {
    if (type === 'js' && type === 'template') {
      return stew.rm(tree, someGlobPattern);
    }

    return tree;
  }
}

Parameters:

Name Type Attribute Description
type String

Type of tree

tree Tree

Tree to process

Return:

Tree

Processed tree

lib/broccoli/ember-app.js:713

private addonTreesFor(type): Array

Returns a list of trees for a given type, returned by all addons.

Parameters:

Name Type Attribute Description
type String

Type of tree

Return:

Array

List of trees

lib/broccoli/ember-app.js:1375

private getLintTests( ): Array

Runs the app, tests and templates trees through the chain of addons that produces lint trees.

Those lint trees are afterwards funneled into the tests folder, babel-ified and returned as an array.

Return:

lib/broccoli/ember-app.js:686

private initializeAddons( )

Loads and initializes addons for this project. Calls initializeAddons on the Project.

lib/broccoli/ember-app.js:902

private populateLegacyFiles( )

Imports legacy imports in this.vendorFiles

lib/broccoli/ember-app.js:587

private shouldIncludeAddon(addon): Boolean

Returns whether an addon should be added to the project

Parameters:

Name Type Attribute Description
addon Addon

Return:

lib/broccoli/ember-app.js:953

private testIndex( ): Tree

Returns the tree for /tests/index.html

Return:

Tree

Tree for /tests/index.html

Returns an array of trees for this application

Return:

Array

An array of trees