Yeoman generator with AngularJS and Jade and Stylus (force)

Yeoman generator for AngularJS website - lets you quickly set up a project with sensible defaults and best practises.

this version will force use Jade and Stylus , and not support coffeeScript .

this project will not publish to npm center please use github install or npm link .

it's use angular 1.3.8 , so this project not support IE 8 (under) .

IE 9 you should not use crossdomain api server , if crossdomin you need install XDomain .

Usage

Install generator-ajs:

npm install -g git+https://github.com/finpo/generator-ajs.git

or download this project and unzip :

git clone https://github.com/finpo/generator-ajs.git
cd generator-ajs
npm link

if you want remove this generator

for npm install
npm uninstall -g generator-ajs

for npm link
sudo npm rm --global generator-ajs

Make a new directory, and cd into it:

mkdir my-new-project && cd $_

Run yo ajs, optionally passing an app name:

yo ajs

Run grunt serve for preview

if you want run 2 project you can set port

Run grunt serve --port=9002 for use custom port ( port >= 9000 is better )

Run grunt build for build production code

you will find production code in dist folder

note : we will minify vendor js , if have any error , you can modify grunt file to disable .

Generators

Available generators:

• ajs (aka ajs:app)
• ajs:controller
• ajs:directive
• ajs:filter
• ajs:route
• ajs:service
• ajs:provider
• ajs:factory
• ajs:value
• ajs:constant
• ajs:decorator
• ajs:view

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 Bootstrap and additional AngularJS modules, such as angular-resource (installed by default).

Example:

yo ajs

Route

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

Example:

yo ajs: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 ajs: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 ajs: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 ajs: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 ajs:view user

Produces app/views/user.html:

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

Service

Generates an AngularJS service.

Example:

yo ajs:service myService

Produces app/scripts/services/myService.js:

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

You can also do yo ajs:factory, yo ajs:provider, yo ajs:value, and yo ajs:constant for other types of services.

Decorator

Generates an AngularJS service decorator.

Example:

yo ajs:decorator serviceName

Produces app/scripts/decorators/serviceNameDecorator.js:

angular.module('myMod').config(function ($provide) {
    $provide.decorator('serviceName', function ($delegate) {
      // ...
      return $delegate;
    });
  });

Options

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

Minification Safe

Removed

Related Issue #452: This option has been removed from the generator. Initially it was needed as ngMin was not entirely stable. As it has matured, the need to keep separate versions of the script templates has led to extra complexity and maintenance of the generator. By removing these extra burdens, new features and bug fixes should be easier to implement. If you are dependent on this option, please take a look at ngMin and seriously consider implementing it in your own code. It will help reduce the amount of typing you have to do (and look through) as well as make your code cleaner to look at.

By default, generators produce unannotated code. Without annotations, AngularJS's DI system will break when minified. Typically, these annotations that make minification safe are added automatically at build-time, after application files are concatenated, but before they are minified. 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. **One thing to note is that ngmin does not produce minsafe code for things that are not main level elements like controller, services, providers, etc.:

resolve: {
  User: function(myService) {
    return MyService();
  }
}

will need to be manually done like so:

resolve: {
  User: ['myService', function(myService) {
    return MyService();
  }]
}

Add to Index

By default, new scripts are added to the index.html file. However, this may not always be suitable. Some use cases:

• Manually added to the file
• Auto-added by a 3rd party plugin
• Using this generator as a subgenerator

To skip adding them to the index, pass in the skip-add argument:

yo ajs:service serviceName --skip-add

Bower Components

The following packages are always installed by the app generator:

• angular
• angular-mocks
• angular-scenario

The following additional modules are available as components on bower, and installable via bower install:

• angular-cookies
• angular-loader
• angular-resource
• angular-sanitize

All of these can be updated with bower update as new versions of AngularJS are released.

Configuration

Yeoman generated projects can be further tweaked according to your needs by modifying project files appropriately.

Output

You can change the app directory by adding a appPath property to bower.json. For instance, if you wanted to easily integrate with Express.js, you could add the following:

{
  "name": "yo-test",
  "version": "0.0.0",
  ...
  "appPath": "public"
}

This will cause Yeoman-generated client-side files to be placed in public.

Testing

Running grunt test will run the unit tests with karma.

Contribute

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 PR, make sure that the commit messages match the AngularJS conventions.

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.

License

BSD license

Patches license on MIT