Maintainer: Brian Ford

Based on angular-seed

Usage: yeoman init angular

Available generators:

• angular:controller
• angular:directive
• angular:filter
• angular:route
• angular:service
• angular:view
• angular:all

Sets up a new AngularJS project, generating all the boilerplate you need to get started.

Example:

yeoman init angular

Generates a controller and view, and configures a route in app/scripts/app.js connecting them.

Generates a controller in app/scripts/controllers.

Example:

yeoman init angular:controller user

Produces app/scripts/controllers/user.js:

angular.module('myMod').controller('UserCtrl', function ($scope) {
  // ...
});

Generates a directive in app/scripts/directives.

Example:

yeoman init angular:filter myDirective

Produces app/scripts/filters/myDirective.js:

angular.module('myMod').filter('myDirective', function () {
  return {
    template: '<div></div>',
    restrict: 'E',
    link: function postLink(scope, element, attrs) {
      element.text('this is the myDirective directive');
    }
  };
});

Generates a filter in app/scripts/filters.

Example:

yeoman init angular:filter myFilter

Produces app/scripts/filters/myFilter.js:

angular.module('myMod').filter('myFilter', function () {
  return function (input) {
    return 'myFilter filter:' + input;
  };
});

Generates an HTML view file in app/views.

Example:

yeoman init angular:view user

Produces app/views/user.html:

<p>This is the user view</p>

Generates an AngularJS service.

Example:

yeoman init angular:service myService

Produces app/scripts/services/myService.js:

angular.module('myMod').factory('myService', function () {
  // ...
});

There are options for each of the methods for registering services. For more on using these services, see the module API AngularJS documentation.

Invoked with --factory

This is the default method when creating a service. Running yeoman init angular:service myService --factory is the same as running yeoman init angular:service myService

Invoked with --service

Invoked with --value

Invoked with --constant

In general, these options can be applied to any generator, though they only affect generators that produce scripts.

For generators that output scripts, the --coffee option will output CoffeeScript instead of JavaScript.

For example:

yeoman init angular:controller user --coffee

Produces app/scripts/controller/user.coffee:

angular.module('myMod')
  .controller 'UserCtrl', ($scope) ->

A project can mix CoffeScript and JavaScript files.

By default, generators produce unannotated code. Without annotations, AngularJS's DI system will break when minified. Typically, these annotations the make minification safe are added automatically at build-time, after application files are concatenated, but before they are minified. By providing the --minsafe option, the code generated will out-of-the-box be ready for minification. The trade-off is between amount of boilerplate, and build process complexity.

yeoman init angular:controller user --minsafe

Produces app/controller/user.coffee:

angular.module('myMod').controller('UserCtrl', ['$scope', function ($scope) {
  // ...
}]);

Unannotated:

angular.module('myMod').controller('MyCtrl', function ($scope, $http, myService) {
  // ...
});

Annotated:

angular.module('myMod').controller('MyCtrl',
  ['$scope', '$http', 'myService', function ($scope, $http, myService) {

    // ...
  }]);

The annotations are important because minified code will rename variables, making it impossible for AngularJS to infer module names based solely on function parameters.

The recommended build process uses ngmin, a tool that automatically adds these annotations. However, if you'd rather not use ngmin, you have to add these annotations manually yourself.

See the contributing docs

When submitting an issue, please follow the guidelines. Especially important is to make sure Yeoman is up-to-date, and providing the command or commands that cause the issue.

When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.

When submitting a new feature, add tests that cover the feature.

BSD license