Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    generator-express-angularpublic

    generator-express-angular

    yeoman angular generator with express

    Usage

    Install generator-express-angular:

    npm install -g generator-express-angular

    Make a new directory, and cd into it:

    mkdir my-new-project && cd $_

    Run yo express-angular, optionally passing an app name:

    yo express-angular [app-name]

    Generators

    Available generators:

    Note: Generators are to be run from the root directory of your app.

    App

    Sets up a new AngularJS app, generating all the boilerplate you need to get started. The app generator also optionally installs Twitter Bootstrap and additional AngularJS modules, such as angular-resource.

    Example:

    yo express-angular

    Route

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

    Example:

    yo express-angular:route myroute

    Produces app/scripts/controllers/myroute.js:

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

    Produces app/views/myroute.html:

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

    Controller

    Generates a controller in app/scripts/controllers.

    Example:

    yo express-angular:controller user

    Produces app/scripts/controllers/user.js:

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

    Directive

    Generates a directive in app/scripts/directives.

    Example:

    yo express-angular:directive myDirective

    Produces app/scripts/directives/myDirective.js:

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

    Filter

    Generates a filter in app/scripts/filters.

    Example:

    yo express-angular:filter myFilter

    Produces app/scripts/filters/myFilter.js:

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

    View

    Generates an HTML view file in app/views.

    Example:

    yo express-angular:view user

    Produces app/views/user.html:

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

    Service

    Generates an AngularJS service.

    Example:

    yo express-angular:service myService

    Produces app/scripts/services/myService.js:

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

    Options

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

    Factory

    Invoked with --factory

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

    Service

    Invoked with --service

    Value

    Invoked with --value

    Constant

    Invoked with --constant

    Options

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

    CoffeeScript

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

    For example:

    yo express-angular:controller user --coffee

    Produces app/scripts/controller/user.coffee:

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

    A project can mix CoffeScript and JavaScript files.

    Minification Safe

    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.

    Example

    yo express-angular:controller user --minsafe

    Produces app/controller/user.js:

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

    Background

    Unannotated:

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

    Annotated:

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

    install

    npm i generator-express-angular

    Downloadsweekly downloads

    12

    version

    0.2.9

    license

    none

    repository

    github.com

    last publish

    collaborators

    • avatar