Skip to content

Commit

Permalink
Add README and LICENSE.
Browse files Browse the repository at this point in the history
  • Loading branch information
abuiles committed Feb 25, 2015
1 parent 85b92cc commit f095a04
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 1 deletion.
21 changes: 21 additions & 0 deletions LICENSE.md
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2015 Adolfo Builes and contributors.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
47 changes: 46 additions & 1 deletion README.md
@@ -1,3 +1,48 @@
## ember-watson [![Build Status](https://travis-ci.org/abuiles/ember-watson.png?branch=master)](https://travis-ci.org/abuiles/ember-watson)

A young Ember Doctor.
A young Ember Doctor. Currently I can only upgrade your QUnit test so
you don't have to do it manually.


## Using as an ember CLI addon

`ember-watson` can be used as an `ember CLI addon`, it will extend the
available list of commands.

To install, run `npm install ember-watson --save-dev` and you are good
to go.


### Commands

#### `ember upgrade-qunit-tests`

This command will transverse your tests directory fixing your QUnit
test to use the 2.0 compatible output (see
[ember-cli#3197](https://github.com/ember-cli/ember-cli/pull/3197)).

The following are some of the changes:

- Add `import { module, test } from 'qunit'` if ember-qunit is not
used. You need to use ember-cli-qunit-v0.3.8 which includes
QUnit's shims. See [ember-cli#3245](https://github.com/ember-cli/ember-cli/pull/3245)
- Import `skip` if used in tests: `import { module,test, skip } from 'qunit'`
- Add assert to callback function in `test`.
- Use `assert` inside test, e.g. `ok` becomes `assert.ok`.
- Use `beforeEach` and `afterEach` instead of `setup` and `teardown` inside module.

## Using without ember CLI

`ember-watson` can be used without `ember CLI` too, just do `npm
install -g ember-watson`

### Commands

#### `ember-watson upgrade-qunit-tests`

This command will transverse your tests directory fixing your QUnit
test to use the 2.0 compatible output.

## License

ember-watson is [MIT Licensed](https://github.com/abuiles/ember-watson/blob/master/LICENSE.md).

0 comments on commit f095a04

Please sign in to comment.