lib/broccoli/ember-app.js:72
EmberApp
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 |
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 |
Method Summary
Public Methods | |
---|---|
public |
dependencies( ): Object
|
public |
import(asset, [options])
Imports an asset into the application. |
public |
toTree([additionalTrees]): Tree
Returns the merged tree for this application |
Private Methods | |
---|---|
private |
_addonDisabledByBlacklist(addon): Boolean
|
private |
_addonDisabledByWhitelist(addon): Boolean
|
private |
_addonEnabled(addon): Boolean
Checks the result of |
private |
_addonInstalled(addonName): Boolean
|
private |
_checkEmberCliBabel(addons): Boolean
|
private |
_concatFiles(tree, options):
Delegates to |
private |
_getAssetPath(asset): (String | Undefined)
|
private |
_import(assetPath, options, directory, subdirectory, extension)
|
private |
Calls the importTransforms hook on addons. |
private |
_initOptions(options)
Initializes the |
private |
_initProject(options)
Initializes the |
private |
_initTestsAndHinting(options)
Initializes the |
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 |
addonTreesFor(type): Array
Returns a list of trees for a given type, returned by all addons. |
private |
getLintTests( ): Array
Runs the |
private |
Loads and initializes addons for this project. Calls initializeAddons on the Project. |
private |
Imports legacy imports in this.vendorFiles |
private |
shouldIncludeAddon(addon): Boolean
Returns whether an addon should be added to the project |
private |
Returns an array of trees for this application |
Static Public Methods
lib/broccoli/ember-app.js:493
public static env( ): String
Returns the environment name
Return:
Environment name
Public Constructors
lib/broccoli/ember-app.js:72
public EmberApp([defaults], [options={}])
Public Methods
lib/broccoli/ember-app.js:1346
public dependencies( ): Object
Return:
Alias to the project's dependencies function
lib/broccoli/ember-app.js:1355
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 |
|
Options object |
options.type | String |
|
Either 'vendor' or 'test' |
options.prepend | Boolean |
|
Whether or not this asset should be prepended |
options.destDir | String |
|
Destination directory, defaults to the name of the directory the asset is in |
options.outputFile | String |
|
Specifies the output file for given import. Defaults to assets/vendor.{js,css} |
options.using | Array |
|
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:1631
public toTree([additionalTrees]): Tree
Returns the merged tree for this application
Parameters:
Name | Type | Attribute | Description |
---|---|---|---|
additionalTrees | Array |
|
Array of additional trees to merge |
Return:
Merged tree for this application
Private Methods
lib/broccoli/ember-app.js:532
private _addonDisabledByBlacklist(addon): Boolean
Parameters:
Name | Type | Attribute | Description |
---|---|---|---|
addon | Addon |
|
Return:
lib/broccoli/ember-app.js:543
private _addonDisabledByWhitelist(addon): Boolean
Parameters:
Name | Type | Attribute | Description |
---|---|---|---|
addon | Addon |
|
Return:
lib/broccoli/ember-app.js:520
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:1336
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:554
private _checkEmberCliBabel(addons): Boolean
Parameters:
Name | Type | Attribute | Description |
---|---|---|---|
addons | Addons |
|
Return:
lib/broccoli/ember-app.js:505
private _concatFiles(tree, options):
Delegates to broccoli-concat
with the sourceMapConfig
option set to options.sourcemaps
.
Return:
lib/broccoli/ember-app.js:1486
private _getAssetPath(asset): (String | Undefined)
Parameters:
Name | Type | Attribute | Description |
---|---|---|---|
asset | (Object | String) |
|
Return:
assetPath
lib/broccoli/ember-app.js:1401
private _import(assetPath, options, directory, subdirectory, extension)
lib/broccoli/ember-app.js:634
private _importAddonTransforms( )
Calls the importTransforms hook on addons.
lib/broccoli/ember-app.js:210
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:189
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:173
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:374
private _initVendorFiles( )
lib/broccoli/ember-app.js:598
private _notifyAddonIncluded( )
Calls the included hook on addons.
lib/broccoli/ember-app.js:1081
private _podTemplatePatterns( ): Array
Return:
An array of regular expressions.
lib/broccoli/ember-app.js:364
private _resolveLocal( )
Resolves a path relative to the project's root
lib/broccoli/ember-app.js:881
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:
Processed tree
lib/broccoli/ember-app.js:808
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:
Processed tree
lib/broccoli/ember-app.js:845
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:
Processed tree
lib/broccoli/ember-app.js:710
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:
List of trees
lib/broccoli/ember-app.js:1296
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:683
private initializeAddons( )
Loads and initializes addons for this project. Calls initializeAddons on the Project.
lib/broccoli/ember-app.js:900
private populateLegacyFiles( )
Imports legacy imports in this.vendorFiles
lib/broccoli/ember-app.js:582
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:1527
private toArray( ): Array
Returns an array of trees for this application
Return:
An array of trees