A Yeoman generator for esperanto
npm install generator-esperanto
npm install -g generator-esperanto
`
Create a new directory, and cd into it:
`
mkdir my-project && cd $_
`
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
$3
Generates a Marionette ItemView (or) Layout (or)CollectionView at a specified location.
Example:
`bash
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.
$3
Generates a Geppetto Command at the specified location.
Example:
`bash
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
$3
Generates a Geppetto Context at the specified location.
Example:
`bash
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
$3
- Checks for jshint errors
- Runs your unit tests and blanket code coverage
Example:
`bash
grunt
`
$3
- 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:
`bash
grunt bower:install
`
$3
- compiles your sass files under www/src/scss and produces a css file under www/src/css
Example:
`bash
grunt sass
``