Skip to content
This repository

Lint your CoffeeScript.


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 warn level. 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 error.

  • Look at existing rules and test structures when deciding how to name your rule. is used for many tests designed to catch specific errors, whereas is used for tests that are designed to enforce formatting and syntax.


  1. Fork the repo locally.
  2. Run npm install to get dependencies.
  3. Create your rule in a single file as src/rules/, using the existing rules as a guide. You may examine the AST and tokens using
  4. Add your test file to the test directory.
  5. Register your rule in src/
  6. Run your test using coffee --spec test/
  7. Run the whole tests suite using npm test.
  8. Squash all commits into a single commit when done.
  9. Submit a pull request.

Build Status

Something went wrong with that request. Please try again.