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.
New rules should be set to a
warnlevel. Developers will expect new changes to NOT break their existing workflow, so unless your change is extremely usefull, default to
warn. Expect discussion if you choose to use
Look at existing rules and test structures when deciding how to name your rule.
no_foo.coffeeis used for many tests designed to catch specific errors, whereas
foo.coffeeis used for tests that are designed to enforce formatting and syntax.
- Fork the repo locally.
npm installto 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
- Register your rule in
- Run your test using
coffee vowsrunner.coffee --spec test/your_test_here.coffee.
- Run the whole tests suite using
- Squash all commits into a single commit when done.
- Submit a pull request.