Addon

Returns the path for addon blueprints.

This hook is called when an error occurs during the preBuild, postBuild or outputReady hooks for addons, or when the build fails

Uses:

• Custom error handling during build process

Calculates a cacheKey for the given treeType. It is expected to return a cache key allowing multiple builds of the same tree to simply return the original tree (preventing duplicate work). If it returns null / undefined the tree in question will opt out of this caching system.

This method is invoked prior to calling treeFor with the same tree name.

You should override this method if you implement custom treeFor or treeFor* methods, which cause addons to opt-out of this caching.

Augments the application's configuration settings.

Object returned from this hook is merged with the application's configuration object.

Application's configuration always take precedence.

Uses:

• Modifying configuration options (see list of defaults here)
  • For example
    • storeConfigInMeta
    • et, al

Allow addons to implement contentFor method to add string output into the associated {{content-for 'foo'}} section in index.html

Uses:

• For instance, to inject analytics code into index.html

Find an addon of the current addon.

Example: ember-data depends on ember-cli-babel and wishes to have additional control over transpilation this method helps.

// ember-data/index.js
treeForAddon(tree) {
  let babel = this.findOwnAddonByName('ember-cli-babel');

  return babel.transpileTree(tree, {
    // customize the babel step (see: ember-cli-addons readme for more details);
  });
}

Check if the current addon intends to be hinted. Typically this is for hinting/linting libraries such as eslint or jshint

Imports an asset into this addon.

Allows addons to define a custom transform function that other addons and app can use when using app.import.

This function is not implemented by default

Uses:

• An app or addons want to transform a dependency that is being imported using app.import.

This method is called when the addon is included in a build. You would typically use this hook to perform additional imports

Uses:

• including vendor files
• setting configuration options

Note: Any options set in the consuming application will override the addon.

Allows the specification of custom addon commands. Expects you to return an object whose key is the name of the command and value is the command instance..

This function is not implemented by default

Uses:

• Include custom commands into consuming application

Initializes the addon. If you override this method make sure and call this._super.init && this._super.init.apply(this, arguments); or your addon will not work.

Allows to mark the addon as developing, triggering live-reload in the project the addon is linked to.

Uses:

• Working on projects with internal addons

Return value is merged into the tests tree. This lets you inject linter output as test results.

Uses:

• JSHint
• any other form of automated test generation that turns code into tests

Returns the module name for this addon.

This hook is called after the build has been processed and the build files have been copied to the output directory

It's passed a result object which contains:

• directory Path to build output

This hook is called after a build is complete.

It's passed a result object which contains:

• directory Path to build output

Uses:

• Slow tree listing
• May be used to manipulate your project after build has happened

Post-process a tree

This hook is called before a build takes place.

Pre-process a tree

Uses:

• removing / adding files from the build.

This hook allows you to make changes to the express server run by ember-cli.

It's passed a startOptions object which contains:

• app Express server instance
• options A hash with:
  • project Current project
  • watcher
  • environment

This function is not implemented by default

Uses:

• Tacking on headers to each request
• Modifying the request object

Note: that this should only be used in development, and if you need the same behavior in production you'll need to configure your server.

Used to add preprocessors to the preprocessor registry. This is often used by addons like ember-cli-htmlbars and ember-cli-coffeescript to add a template or js preprocessor to the registry.

Uses:

• Adding preprocessors to the registry.

Can be used to exclude addons from being added as a child addon.

Uses:

• Abstract away multiple addons while only including one into the built assets

This hook allows you to make changes to the express server run by testem.

This function is not implemented by default

Uses:

• Adding custom test-specific endpoints
• Manipulating HTTP requests in tests

Returns a given type of tree (if present), merged with the application tree. For each of the trees available using this method, you can also use a direct method called treeFor[Type] (eg. treeForApp).

Available tree names:

• app
• styles
• templates
• addon-templates
• addon
• vendor
• test-support
• addon-test-support
• public

Uses:

• manipulating trees at build time

Returns a tree for this addon

Returns the tree for this addon's templates

Returns the tree for all test files namespaced to a given addon.

Returns the tree for all app files

Returns the tree for all public files

Returns the tree for all style files

Returns the tree for all template files

Returns the tree for all test support files

Returns the tree for all vendor files