https://github.com/fantasywind/generator-angular-jade-stylus

Change repo to https://github.com/fantasywind/generator-angular-jscg
https://github.com/fantasywind/generator-angular-jade-stylus

Last synced: 9 months ago
JSON representation

Change repo to https://github.com/fantasywind/generator-angular-jscg

• Host: GitHub
• URL: https://github.com/fantasywind/generator-angular-jade-stylus
• Owner: fantasywind
• Fork: true (yeoman/generator-angular)
• Created: 2014-04-08T10:12:28.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2015-11-01T15:08:04.000Z (over 10 years ago)
• Last Synced: 2025-01-16T14:46:18.952Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 1.32 MB
• Stars: 25
• Watchers: 3
• Forks: 9
• Open Issues: 4
• Metadata Files:
  • Readme: readme.md
  • Changelog: CHANGELOG.md
  • Contributing: contributing.md

Awesome Lists containing this project

README

          
# AngularJS generator with Jade and Stylus 

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

## Usage

Install `generator-angular`:

```

npm install -g generator-angular-jade-stylus

```

Make a new directory, and `cd` into it:

```

mkdir my-new-project && cd $_

```

Run `yo angular`, optionally passing an app name:

```

yo angular-jade-stylus --coffee --jade --stylus [app-name]

```

> You should add --jade and --stylus to enable jade / stylus template

Run `grunt` for building and `grunt serve` for preview

## Generators

Available generators:

* [angular-jade-stylus](#app) (aka [angular-jade-stylus:app](#app))

* [angular-jade-stylus:controller](#controller)

* [angular-jade-stylus:directive](#directive)

* [angular-jade-stylus:filter](#filter)

* [angular-jade-stylus:route](#route)

* [angular-jade-stylus:service](#service)

* [angular-jade-stylus:provider](#service)

* [angular-jade-stylus:factory](#service)

* [angular-jade-stylus:value](#service)

* [angular-jade-stylus:constant](#service)

* [angular-jade-stylus:decorator](#decorator)

* [angular-jade-stylus:view](#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:

```bash

yo angular-jade-stylus

```

### Route

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

Example:

```bash

yo angular-jade-stylus: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

```


### Controller

Generates a controller in `app/scripts/controllers`.

Example:

```bash

yo angular-jade-stylus: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-jade-stylus: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-jade-stylus: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-jade-stylus:view user

```

Produces `app/views/user.html`:

```html

This is the user view

```


### Service

Generates an AngularJS service.

Example:

```bash

yo angular-jade-stylus:service myService

```

Produces `app/scripts/services/myService.js`:

```javascript

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

  // ...

});

```

You can also do `yo angular-jade-stylus:factory`, `yo angular-jade-stylus:provider`, `yo angular-jade-stylus:value`, and `yo angular-jade-stylus:constant` for other types of services.

### Decorator

Generates an AngularJS service decorator.

Example:

```bash

yo angular-jade-stylus: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

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

For example:

```bash

yo angular-jade-stylus:controller user --coffee

```

Produces `app/scripts/controller/user.coffee`:

```coffeescript

angular.module('myMod')

  .controller 'UserCtrl', ($scope) ->

```

A project can mix CoffeScript and JavaScript files.

To output JavaScript files, even if CoffeeScript files exist (the default is to output CoffeeScript files if the generator finds any in the project), use `--coffee=false`.

### Minification Safe

**Removed**

[Related Issue #452](https://github.com/yeoman/generator-angular/issues/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.:

```javascript

resolve: {

  User: function(myService) {

    return MyService();

  }

}

```

will need to be manually done like so:

```javascript

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:

```bash

yo angular-jade-stylus:service serviceName --skip-add

```

## Bower Components

The following packages are always installed by the [app](#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:

```json

{

  "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](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.

## License

[BSD license](http://opensource.org/licenses/bsd-license.php)

Patches license on [MIT](http://chaiyu.mit-license.org)