marufsiddiqui / ember-tools Goto Github PK

Ember Tools

Current Version: 0.0.2

The cli is still rough around the edges. Next thing on my todo list is making the cli polished.

Installation

npm install -g ember-tools

What's in the bag?

Features

• prescribed file organization for sanity
• scaffolding for learning curve mitigation
• template precompilation for performance
• single file application build for convenience
• generators for faster application development
• commonjs (node) style modules for js community <3 and isolated testing

Commands

• ember create [appDir]
• ember build
• ember-generate --scaffold [resource]
• ember-generate [options] [resource]
• ember-precompile --directory [directory] --file [file]

Current Library Versions

• ember 1.0.0.pre4
• ember-data rev 11
• handlebars 1.0.rc.2
• jQuery 1.9.0

ember create [dir]

Creates the directory at [dir] and shoves a boilerplate ember app into it. Also creates an .ember file in the current directory so ember build knows what directory to build.

IMPORTANT: Your app must be a sub-directory of the app you create it from. I anticipate more information to be stored in the .ember file like CoffeeScript and AMD support, etc.

Example:

ember create client

ember build

Builds your app, handing you a fresh-from-the-oven application.js with everything inside.

Example:

ember build

ember-generate --scaffold [resource]

Creates fully functional CRUD.

Example:

ember-generate --scaffold person name:string age:number

Visiting /#people will now present the user with a fully functional interface to create, edit, and destroy people models.

NOTE: It is important to give it the singular version of word.

ember-generate [options] [resource]

Generates boilerplate application modules. See also ember-generate --scaffold.

Examples:

ember-generate -m recipe

Notes:

• Models will always be singular.
• Sub-directories will be created for you if they don't exist.
• Files will be overwritten without warning.

ember-precompile --directory [dir] --file [file]

Precompiles templates found in dir into file.

Examples

ember-precompile --directory app/templates --file app/templates.js ember-precompile -d app/templates -f app/templates.js

Roadmap

• clean up cli
  • consolidate all commands into ember
  • make help and usage information accurate and valuable
• create CONTRIBUTING file
• moar tests
• travis-ci
• warn before overwriting a file
• baked in testing
• generated tests
• support for custom application namespace (instead of just App)
• emblem.js templates
• coffeescript generators
• AMD generators/build (maybe)
• coffeescript + AMD generators! (maybe-er)
• ES6 module generators/build EVEN THOUGH E'RBODY UP IN THEIR GRILL (maybeist)

License and Copyright

MIT Style License

Copyright © 2013 Ryan Florence

Contributing

Run tests with

npm test

Run tests and watch for changes with

npm run-script watch-test