Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yeoman/generator-angular
Yeoman generator for AngularJS
https://github.com/yeoman/generator-angular
Last synced: 12 days ago
JSON representation
Yeoman generator for AngularJS
- Host: GitHub
- URL: https://github.com/yeoman/generator-angular
- Owner: yeoman
- Archived: true
- Created: 2012-11-21T22:43:39.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2017-06-08T15:28:19.000Z (over 7 years ago)
- Last Synced: 2024-10-06T04:19:43.621Z (about 1 month ago)
- Language: JavaScript
- Homepage: http://yeoman.io
- Size: 1.45 MB
- Stars: 5,729
- Watchers: 245
- Forks: 1,441
- Open Issues: 90
-
Metadata Files:
- Readme: readme.md
- Contributing: contributing.md
Awesome Lists containing this project
- awesome-projects-boilerplates - Yeoman Angular Generator
README
# AngularJS generator [](http://travis-ci.org/yeoman/generator-angular) [](https://gitter.im/yeoman/yeoman)
> Yeoman generator for AngularJS - lets you quickly set up a project with sensible defaults and best practices.
There are many starting points for building a new Angular single page app, in addition to this one. You can find
other options in this list at
[Yeoman.io](http://yeoman.io/generators).
[Roadmap for upcoming plans/features/fixes](https://github.com/yeoman/generator-angular/issues/553)
## Usage
For step-by-step instructions on using Yeoman and this generator to build a TODO AngularJS application from scratch see [this tutorial.](http://yeoman.io/codelab/)
Install `yo`, `grunt-cli`, `bower`, `generator-angular` and `generator-karma`:
```
npm install -g grunt-cli bower yo generator-karma generator-angular
```
If you are planning on using Sass, you will need to first install Ruby and Compass:
- Install Ruby by downloading from [here](http://rubyinstaller.org/downloads/) or use Homebrew
- Install the compass gem:
```
gem install compass
```
Make a new directory, and `cd` into it:
```
mkdir my-new-project && cd $_
```
Run `yo angular`, optionally passing an app name:
```
yo angular [app-name]
```
Run `grunt` for building and `grunt serve` for preview
## Generators
Available generators:
* [angular](#app) (aka [angular:app](#app))
* [angular:controller](#controller)
* [angular:directive](#directive)
* [angular:filter](#filter)
* [angular:route](#route)
* [angular:service](#service)
* [angular:provider](#service)
* [angular:factory](#service)
* [angular:value](#service)
* [angular:constant](#service)
* [angular:decorator](#decorator)
* [angular:view](#view)
### 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:
```bash
yo angular
```
### Route
Generates a controller and view, and configures a route in `app/scripts/app.js` connecting them.
Example:
```bash
yo angular:route myroute
```
Produces `app/scripts/controllers/myroute.js`:
```javascript
angular.module('myMod').controller('MyrouteCtrl', function ($scope) {
// ...
});
```
Produces `app/views/myroute.html`:
```html
This is the myroute view
```
**Explicitly provide route URI**
Example:
```bash
yo angular:route myRoute --uri=my/route
```
Produces controller and view as above and adds a route to `app/scripts/app.js`
with URI `my/route`
### Controller
Generates a controller in `app/scripts/controllers`.
Example:
```bash
yo angular:controller user
```
Produces `app/scripts/controllers/user.js`:
```javascript
angular.module('myMod').controller('UserCtrl', function ($scope) {
// ...
});
```
### Directive
Generates a directive in `app/scripts/directives`.
Example:
```bash
yo angular:directive myDirective
```
Produces `app/scripts/directives/myDirective.js`:
```javascript
angular.module('myMod').directive('myDirective', function () {
return {
template: '
',
restrict: 'E',
link: function postLink(scope, element, attrs) {
element.text('this is the myDirective directive');
}
};
});
```
### Filter
Generates a filter in `app/scripts/filters`.
Example:
```bash
yo angular:filter myFilter
```
Produces `app/scripts/filters/myFilter.js`:
```javascript
angular.module('myMod').filter('myFilter', function () {
return function (input) {
return 'myFilter filter:' + input;
};
});
```
### View
Generates an HTML view file in `app/views`.
Example:
```bash
yo angular:view user
```
Produces `app/views/user.html`:
```html
This is the user view
```
### Service
Generates an AngularJS service.
Example:
```bash
yo angular:service myService
```
Produces `app/scripts/services/myService.js`:
```javascript
angular.module('myMod').service('myService', function () {
// ...
});
```
You can also do `yo angular:factory`, `yo angular:provider`, `yo angular:value`, and `yo angular:constant` for other types of services.
### Decorator
Generates an AngularJS service decorator.
Example:
```bash
yo angular:decorator serviceName
```
Produces `app/scripts/decorators/serviceNameDecorator.js`:
```javascript
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.
### CoffeeScript and TypeScript
For generators that output scripts, the `--coffee` option will output CoffeeScript instead of JavaScript, and `--typescript` will output TypeScript instead of JavaScript.
For example:
```bash
yo angular:controller user --coffee
```
Produces `app/scripts/controller/user.coffee`:
```coffeescript
angular.module('myMod')
.controller 'UserCtrl', ($scope) ->
```
For example:
```bash
yo angular:controller user --typescript
```
Produces `app/scripts/controller/user.ts`:
```typescript
///
'use strict';
module demoApp {
export interface IUserScope extends ng.IScope {
awesomeThings: any[];
}
export class UserCtrl {
constructor (private $scope:IUserScope) {
$scope.awesomeThings = [
'HTML5 Boilerplate',
'AngularJS',
'Karma'
];
}
}
}
angular.module('demoApp')
.controller('UserCtrl', demoApp.UserCtrl);
```
### Minification Safe
**tl;dr**: You don't need to write annotated code as the build step will
handle it for you.
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 `ng-annotate`, a tool that automatically adds these annotations. However, if you'd rather not use it, you have to add these annotations manually yourself. Why would you do that though? If you find a bug
in the annotated code, please file an issue at [ng-annotate](https://github.com/olov/ng-annotate/issues).
### 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:
```bash
yo angular:service serviceName --skip-add
```
## Bower Components
The following packages are always installed by the [app](#app) generator:
* angular
* angular-mocks
The following additional modules are available as components on bower, and installable via `bower install`:
* angular-animate
* angular-aria
* angular-cookies
* angular-messages
* angular-resource
* angular-sanitize
All of these can be updated with `bower update` as new versions of AngularJS are released.
`json3` and `es5-shim` have been removed as Angular 1.3 has dropped IE8 support and that is the last version that needed these shims. If you still require these, you can include them with: `bower install --save json3 es5-shim`. `wiredep` should add them to your index.html file but if not you can manually add them.
## 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 an `appPath` property to `bower.json`. For instance, if you wanted to easily integrate with Express.js, you could add the following:
```json
{
"name": "yo-test",
"version": "0.0.0",
...
"appPath": "public"
}
```
This will cause Yeoman-generated client-side files to be placed in `public`.
Note that you can also achieve the same results by adding an `--appPath` option when starting generator:
```bash
yo angular [app-name] --appPath=public
```
## Testing
Running `grunt test` will run the unit tests with karma.
## Contribute
See the [contributing docs](https://github.com/yeoman/yeoman/blob/master/contributing.md)
When submitting an issue, please follow the [guidelines](https://github.com/yeoman/yeoman/blob/master/contributing.md#issue-submission). 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](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/).
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.
## Changelog
Recent changes can be viewed on Github on the [Releases Page](https://github.com/yeoman/generator-angular/releases)
## Sponsors
Love Yeoman work and community? Help us keep it alive by donating funds to cover project expenses!
[[Become a sponsor](https://opencollective.com/yeoman#support)]
## License
[BSD license](http://opensource.org/licenses/bsd-license.php)