Yeoman generator for AngularJS with TypeScript templates
Maintainer: Brian Ford
Based on angular-seed
npm install -g generator-angular
Make a new directory, and
cd into it:
mkdir my-new-project && cd $_
yo angular, optionally passing an app name:
yo angular [app-name]
- angular (aka angular:app)
Note: Generators are to be run from the root directory of your 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.
Generates a controller and view, and configures a route in
app/scripts/app.js connecting them.
yo angular:route myroute
This is the myroute view
Generates a controller in
yo angular:controller user
Generates a directive in
yo angular:directive myDirective
angularmodule'myMod'directive'myDirective'returntemplate: '<div></div>'restrict: 'E'link:elementtext'this is the myDirective directive';;;
Generates a filter in
yo angular:filter myFilter
angularmodule'myMod'filter'myFilter'returnreturn 'myFilter filter:' + input;;;
Generates an HTML view file in
yo angular:view user
This is the user view
Generates an AngularJS service.
yo angular:service myService
You can also do
yo angular:value, and
yo angular:constant for other types of services.
In general, these options can be applied to any generator, though they only affect generators that produce scripts.
For generators that output scripts, the
yo angular:controller user --coffee
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.
yo angular:controller user --minsafe
angularmodule'myMod'controller'UserCtrl' '$scope'// ...;
angularmodule'myMod'controller'MyCtrl''$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.
The following packages are always installed by the app generator:
The following additional modules are available as components on bower, and installable via
All of these can be updated with
bower update as new versions of AngularJS are released.
Yeoman generated projects can be further tweaked according to your needs by modifying project files appropriately.
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:
This will cause Yeoman-generated client-side files to be placed in
For tests to work properly, karma needs the
angular-mocks bower package.
This script is included in the bower.json in the
devDependencies section, which will
be available very soon, probably with the next minor release of bower.
devDependencies are not yet implemented, you can fix it by running:
bower install angular-mocks
grunt test you should now be able to run your unit tests with karma.
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.