Skip to content
This repository has been archived by the owner on Oct 19, 2021. It is now read-only.

Commit

Permalink
Added testrule script and updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AsaAyers committed May 17, 2015
1 parent a6f90d0 commit 4bd4a7a
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ Past:
2. Run `npm install` to get dependencies.
3. Create your rule in a single file as `src/rules/your_rule_here.coffee`, using the existing
rules as a guide.
You may examine the AST and tokens using
You may examine the AST and tokens using
[http://asaayers.github.io/clfiddle/](http://asaayers.github.io/clfiddle/).
4. Add your test file `my_test.coffee` to the `test` directory.
5. Register your rule in `src/coffeelint.coffee`.
6. Run your test using `./vowsrunner.js --spec test/your_test_here.coffee`.
6. Run your test using `npm run testrule test/your_test_here.coffee`.
7. Run the whole tests suite using `npm test`.
8. Check that your rule's documentation is generated properly (see _Updating documentation when
adding a new rule_ below).
Expand Down Expand Up @@ -93,4 +93,3 @@ follow these steps:
probably need to install rake.
* Open the `index.html` file with your favorite browser and make sure that your
rule's documentation is generated properly.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
"scripts": {
"pretest": "cake compile",
"test": "./vowsrunner.js --spec test/*.coffee test/*.litcoffee",
"testrule": "npm run compile && ./vowsrunner.js --spec",
"posttest": "npm run lint",
"prepublish": "cake prepublish",
"publish": "cake publish",
Expand Down

0 comments on commit 4bd4a7a

Please sign in to comment.