generator-esperanto

A Yeoman generator for esperanto

===================

Getting Started

1. Install the esperanto generator

npm install -g generator-esperanto

1. Create a new directory, and cd into it:

mkdir my-project && cd $_

1. Run yo esperanto:

yo esperanto

This will create a esperanto-boilerplate app, runs npm install, and installs all the dev dependencies via grunt bower task.

Sub-Generators

Available sub-generators:

• esperanto:view
• esperanto:command
• esperanto:context

View

Generates a Marionette ItemView (or) Layout (or)CollectionView at a specified location.

Example:

yo esperanto:view "YourViewName"

This will be followed by a bunch of questions for fetching path information.

Produces

• a Marionette ItemView/Layout/CollectionView
• a html template file associated with this view
• a test spec file for the view
• adds the test spec to the test suite
• if your view type is a collection view, it will associate an itemview to the newly created view.

Command

Generates a Geppetto Command at the specified location.

Example:

yo esperanto:command "YourCommandName"

Produces

• YourCommandName.js at the specified location.
• A test spec file for this command
• adds the test spec to the test suite

Context

Generates a Geppetto Context at the specified location.

Example:

yo esperanto:context "YourContextName"

Produces

• YourContextName.js at the specified location.

Grunt tasks

Here are the most commonly used grunt tasks for esperanto

• grunt
• grunt bower:install
• grunt sass

grunt

• Checks for jshint errors
• Runs your unit tests and blanket code coverage

Example:

grunt

grunt bower:install

• installs all 3rd party dependencies via bower.
• All libs are copied into www/libs directory
• This task is run when the app is created. Run this task only if you made changes to bower.json

Example:

grunt bower:install

grunt sass

• compiles your sass files under www/src/scss and produces a css file under www/src/css

Example:

grunt sass

For additional grunt tasks please see the [esperanto documentation] (https://github.com/ModelN/esperanto)