CoffeeLint
CoffeeLint is a style checker that helps keep CoffeeScript code clean and consistent.
For guides on installing, using and configuring CoffeeLint, head over here.
To suggest a feature, report a bug, or general discussion, head over here.
Contributing
-
New rules should be set to a
warn
level. Developers will expect new changes to NOT break their existing workflow, so unless your change is extremely usefull, default towarn
. Expect discussion if you choose to useerror
. -
Look at existing rules and test structures when deciding how to name your rule.
no_foo.coffee
is used for many tests designed to catch specific errors, whereasfoo.coffee
is used for tests that are designed to enforce formatting and syntax.
Steps
- Fork the repo locally.
- Run
npm install
to get dependencies. - 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 http://asaayers.github.io/clfiddle/. - Add your test file
my_test.coffee
to thetest
directory. - Register your rule in
src/coffeelint.coffee
. - Run your test using
coffee vowsrunner.coffee --spec test/your_test_here.coffee
. - Run the whole tests suite using
npm test
. - Squash all commits into a single commit when done.
- Submit a pull request.