An ember command line utility.
- irc: #ember-cli on freenode
- issues: ember-cli/issues
Although potentially exciting, this is still really a WIP, use at your own risk.
The ember-app-kit project has proved to be quite useful, we have learned lots, and it allowed us to iterate quickly while building real ambitious applications.
While it's initial incarnation is useful, it has several meta problems:
- It is not "simple" and appears daunting
- Because of inline configuration, the API surface area is massive
- #2 does not allow users to express the "what" just the "how", this prevents EAK from doing more of the heavy lifting itself
- [#2 #3] makes it quite tedious to upgrade
If we want to upgrade or swap in a faster build pipeline it would be a major pain currently. But with #3, in theory it should be minimal pain.
- convention over configuration. (look to rails)
- we should provide internal configuration/implementation to satisfy the 'what' with the how.
- simple > easy
- the current contents of
tasks/*
should reside in the ember executables library - the pipeline-related Broccoli configuration should also reside in the above mentioned library.
npm install -g ember-cli
ember new my-cool-app
cd my-cool-app
ember server
ember build <env-name>
ember server
ember init [app-name] [--dry-run] [--skip-npm-install]
ember new [app-name]
You may want to use npm link
to make your local source directory a globally installed package.
See npm-developers.
Once:
npm test
On every file change:
npm run-script autotest
You can use LESS, Sass (scss only), or Stylus by installing the corresponding Broccoli package (broccoli-sass
, broccoli-less-single
or broccoli-stylus-single
).
For example, to enable SCSS compilation:
npm install --save-dev broccoli-sass
Building will now compile app/styles/app.scss
into app.css
in your output.
You can also use CoffeeScript with ember-cli
.
Install the broccoli-coffee
package:
npm install --save-dev broccoli-coffee
Now CoffeeScript files will be complied.
Note that export
and default
are reserved words in CoffeeScript so they must be escaped:
`export default Router`
Submit a pull request (code + tests) and make sure to add the change to CHANGELOG.md.
-
executable (this project)
ember ember new <app-name> ember help ember init <app-name> ember build <env-name> [default: development] [optional: target path] ember server --autotest [default: false] --port [default: 4200] --host [default: 0.0.0.0] --subscribe [default:release, optional: (beta|canary)] # on "start" of an app, it will prompt the user if the channel they # subscribe to has an update. # if an update occured. they are asked [yes, no] to try the update (using bower) # (what about other libs? ember-data or components or..) --env [default: development] # allow previewing the various build envs. --app [default: .] ember generate <generator-name> <options...> See https://github.com/cavneb/loom-generators-ember-appkit for available generators ember generate scaffold [...] # for resources ember addon # reserved for future use.
-
folder structure: (very similar to what we currently have)
app/* # like EAK today tasks/ # custom user tasks vendor/ # mostly for bower, some non-bower stuff will reside. tests/ # tests test config and test helpers. tmp/* # created on demand, but scratch pad for EAK. Brocfile.js # should contain a mechanism for default ember tasks to be loaded # should be the place for users to define custom broccoli related things. package.json bower.json .gitignore .travis .jshintrc
-
configuration
server.js # for adding additional connect middleware (like a proxy to the backend) Brocfile # default tasks will exist in "ember" tasks/ # custom user tasks
-
detect
.js
,.coffee
,.styl
,.scss
,.sass
and use the appropriate filter, or throw with useful error.new Error('Tried compiling: `app.coffee` but CoffesScript is missing, to install please: `npm install coffee-script --save-dev`')
-
tasks (consider extracting them into
broccoli-ember
)
ember-cli is MIT Licensed.