generator-can

Yeoman generator for CanJS

npm install generator-can
8 downloads in the last week
18 downloads in the last month

CanJS Generator ScreenShot

Maintainer: Scott Markley

Based on Generator-Angular

Usage

First make a new directory, and cd into it:

mkdir my-new-project && cd $_

Then install generator-can and generator-karma:

npm install generator-can generator-karma

Run yo can, optionally passing an app name:

yo can [app-name]

Finally, install npm and bower dependencies:

npm install && bower install --dev

Generators

Available generators:

App

Sets up a new CanJS app, generating all the boilerplate you need to get started. The app generator also optionally installs Twitter Bootstrap as well as testing suite Qunit.

Example:

yo can

Route

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

Controller

Generates a controller in app/scripts/controllers.

Example:

yo can:controller user

Produces app/scripts/controllers/user.js:

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

View

Generates an HTML view file in app/views.

Example:

yo can:view user

Produces app/views/user.html:

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

Options

There are options for each of the methods for registering services. For more on using these services, see the CanJs AMD documentation.

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 can:controller user --coffee

Produces app/scripts/controller/user.coffee:

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

A project can mix CoffeScript and JavaScript files.

Bower Components

The following packages are always installed by the app generator:

  • Can
  • can-mocks
  • can-scenario

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

  • can-cookies
  • can-loader
  • can-resource
  • can-sanitize

All of these can be updated with bower update as new versions of CanJS 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 component.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

For tests to work properly, karma needs the can-mocks bower package. This script is included in the component.json in the devDependencies section, which will be available very soon, probably with the next minor release of bower.

While bower devDependencies are not yet implemented, you can fix it by running:

bower install can-mocks

By running grunt test you should now be able to run your 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 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

Grunt Debugging

node --debug-brk $(which grunt) task
Use node-inspector &
npm loves you