lib/models/project.js:27

Project

The Project model is tied to your package.json. It is instantiated by giving closestSync the path to your project.

Static Method Summary

Static Public Methods
public static
getProjectRoot( ): String

Returns the project root based on the first package.json that is found
Static Private Methods
private static
closestSync(pathName, _ui): Project

Returns a new project based on the first package.json that is found in pathName.
private static
projectOrnullProject(_ui): Project

Returns a new project based on the first package.json that is found in pathName, or the nullProject.

Constructor Summary

Public Constructors
public
Project(root, pkg, ui, cli)

The Project model is tied to your package.json. It is instantiated by giving closestSync the path to your project.

Property Summary

Public Properties
public
targets: Unknown

Returns the targets of this project, or the default targets if not present.
Private Properties
private
_watchmanInfo: Unknown

Set when the Watcher.detectWatchman helper method finishes running, so that other areas of the system can be aware that watchman is being used.

Method Summary

Public Methods
public
config(env): Object

Loads the configuration for this project and its addons.
public
generateTestFile(moduleName, tests): String

Generate test file contents.
public
isEmberCLIAddon( ): Boolean

Returns whether or not this is an Ember CLI addon.
public
require(file): Object

Calls require on a given module from the context of the project. For instance, an addon may want to require a class from the root project's version of ember-cli.
Private Methods
private
addonBlueprintLookupPaths( ): Array

Returns a list of addon paths where blueprints will be looked up.
private
addonCommands( ): Object

Returns what commands are made available by addons by inspecting includedCommands for every addon.
private
blueprintLookupPaths( ): Array

Returns a list of paths (including addon paths) where blueprints will be looked up.
private
bowerDependencies(bower): Object

Returns the bower dependencies for this project.
private
configPath( ): String

Returns the path to the configuration.
private
configWithoutCache(env): Object
private
dependencies([pkg=this.pkg], [excludeDevDeps=false]): Object

Returns the dependencies from a package.json
private
discoverAddons( )

Discovers all addons for this project and stores their names and package.json contents in this.addonPackages as key-value pairs.
private
eachAddonCommand(callback)

Execute a given callback for every addon command. Example:
private
findAddonByName(name): Addon

Find an addon by its name
private
getAddonsConfig(env, appConfig): Object

Returns the addons configuration.
private
has(file): Boolean

Returns whether or not the given file name is present in this project.
private
initializeAddons( )

Loads and initializes all addons for this project.
private
isEmberCLIProject( ): Boolean

Returns whether or not this is an Ember CLI project. This checks whether ember-cli is listed in devDependencies.
private
isModuleUnification( ): Boolean

Returns whether this is using a module unification format.
private
localBlueprintLookupPath( ): String

Path to the blueprints for this project.
private
name( ): String

Returns the name from package.json.
private
reloadAddons( )

Re-initializes addons.
private
reloadPkg( ): Object

Reloads package.json
private
resolveSync(file): String

Resolves the absolute path to a file synchronously
private
setupBowerDirectory( )

Sets the name of the bower directory for this project
private
supportedInternalAddonPaths( )

Provides the list of paths to consult for addons that may be provided internally to this project. Used for middleware addons with built-in support.

Static Public Methods

lib/models/project.js:713

public static getProjectRoot( ): String

Returns the project root based on the first package.json that is found

Return:

String

The project root directory

Static Private Methods

lib/models/project.js:653

private static closestSync(pathName, _ui): Project

Returns a new project based on the first package.json that is found in pathName.

Parameters:

Name Type Attribute Description
pathName String

Path to your project
_ui UI

The UI instance to provide to the created Project.

Return:

Project

Project instance
lib/models/project.js:689

private static projectOrnullProject(_ui): Project

Returns a new project based on the first package.json that is found in pathName, or the nullProject.

The nullProject signifies no-project, but abides by the null object pattern

Parameters:

Name Type Attribute Description
_ui UI

The UI instance to provide to the created Project.

Return:

Project

Project instance

Public Constructors

lib/models/project.js:27

public Project(root, pkg, ui, cli)

Parameters:

Name Type Attribute Description
root String

Root directory for the project
pkg Object

Contents of package.json
ui UI
cli CLI

Public Properties

lib/models/project.js:280

public targets: Unknown

Returns the targets of this project, or the default targets if not present.

Private Properties

lib/models/project.js:52

private _watchmanInfo: Unknown

Set when the Watcher.detectWatchman helper method finishes running, so that other areas of the system can be aware that watchman is being used.

For example, this information is used in the broccoli build pipeline to know if we can watch additional directories (like bower_components) "cheaply".

Contains enabled and version.

Public Methods

lib/models/project.js:243

public config(env): Object

Loads the configuration for this project and its addons.

Parameters:

Name Type Attribute Description
env String

Environment name

Return:

Object

Merged configuration object
lib/models/project.js:629

public generateTestFile(moduleName, tests): String

Generate test file contents.

This method is supposed to be overwritten by test framework addons like ember-qunit and ember-mocha.

Parameters:

Name Type Attribute Description
moduleName String

Name of the test module (e.g. JSHint)
tests Object[]

Array of tests with name, passed and errorMessage properties

Return:

String

The test file content
lib/models/project.js:201

public isEmberCLIAddon( ): Boolean

Returns whether or not this is an Ember CLI addon.

Return:

Boolean

Whether or not this is an Ember CLI Addon.
lib/models/project.js:356

public require(file): Object

Calls require on a given module from the context of the project. For instance, an addon may want to require a class from the root project's version of ember-cli.

Parameters:

Name Type Attribute Description
file String

File path or module name

Return:

Object

Imported module

Private Methods

lib/models/project.js:566

private addonBlueprintLookupPaths( ): Array

Returns a list of addon paths where blueprints will be looked up.

Return:

Array

List of paths
lib/models/project.js:475

private addonCommands( ): Object

Returns what commands are made available by addons by inspecting includedCommands for every addon.

Return:

Object

Addon names and command maps as key-value pairs
lib/models/project.js:548

private blueprintLookupPaths( ): Array

Returns a list of paths (including addon paths) where blueprints will be looked up.

Return:

Array

List of paths
lib/models/project.js:391

private bowerDependencies(bower): Object

Returns the bower dependencies for this project.

Parameters:

Name Type Attribute Description
bower String

Path to bower.json

Return:

Object

Bower dependencies
lib/models/project.js:226

private configPath( ): String

Returns the path to the configuration.

Return:

String

Configuration path
lib/models/project.js:261

private configWithoutCache(env): Object

Parameters:

Name Type Attribute Description
env String

Environment name

Return:

Object

Merged confiration object
lib/models/project.js:371

private dependencies([pkg=this.pkg], [excludeDevDeps=false]): Object

Returns the dependencies from a package.json

Parameters:

Name Type Attribute Description
pkg Object
  • optional
  • default: this.pkg

Package object
excludeDevDeps Boolean
  • optional
  • default: false

Whether or not development dependencies should be excluded

Return:

Object

Dependencies
lib/models/project.js:431

private discoverAddons( )

Discovers all addons for this project and stores their names and package.json contents in this.addonPackages as key-value pairs.

Any packageInfos that we find that are marked as not valid are excluded.

lib/models/project.js:514

private eachAddonCommand(callback)

Execute a given callback for every addon command. Example:

project.eachAddonCommand(function(addonName, commands) {
  console.log('Addon ' + addonName + ' exported the following commands:' + commands.keys().join(', '));
});

Parameters:

Name Type Attribute Description
callback Function

[description]
lib/models/project.js:615

private findAddonByName(name): Addon

Find an addon by its name

Parameters:

Name Type Attribute Description
name String

Addon name as specified in package.json

Return:

Addon

Addon instance
lib/models/project.js:307

private getAddonsConfig(env, appConfig): Object

Returns the addons configuration.

Parameters:

Name Type Attribute Description
env String

Environment name
appConfig Object

Application configuration

Return:

Object

Merged configuration of all addons
lib/models/project.js:330

private has(file): Boolean

Returns whether or not the given file name is present in this project.

Parameters:

Name Type Attribute Description
file String

File name

Return:

Boolean

Whether or not the file is present
lib/models/project.js:455

private initializeAddons( )

Loads and initializes all addons for this project.

lib/models/project.js:189

private isEmberCLIProject( ): Boolean

Returns whether or not this is an Ember CLI project. This checks whether ember-cli is listed in devDependencies.

Return:

Boolean

Whether this is an Ember CLI project
lib/models/project.js:211

private isModuleUnification( ): Boolean

Returns whether this is using a module unification format.

Return:

Boolean

Whether this is using a module unification format.
lib/models/project.js:537

private localBlueprintLookupPath( ): String

Path to the blueprints for this project.

Return:

String

Path to blueprints

Returns the name from package.json.

Return:

String

Package name
lib/models/project.js:603

private reloadAddons( )

Re-initializes addons.

lib/models/project.js:585

private reloadPkg( ): Object

Reloads package.json

Return:

Object

Package content
lib/models/project.js:342

private resolveSync(file): String

Resolves the absolute path to a file synchronously

Parameters:

Name Type Attribute Description
file String

File to resolve

Return:

String

Absolute path to file
lib/models/project.js:101

private setupBowerDirectory( )

Sets the name of the bower directory for this project

lib/models/project.js:407

private supportedInternalAddonPaths( )

Provides the list of paths to consult for addons that may be provided internally to this project. Used for middleware addons with built-in support.