Skip to content

Latest commit

 

History

History
36 lines (18 loc) · 841 Bytes

README.md

File metadata and controls

36 lines (18 loc) · 841 Bytes

Coffee-Formatter

A formatter for CoffeeScript

Status

The first version of this project is completed. I will publish it on npm ASAP.

Usage

node formatter.js [Your Files]

Or if you want to use coffee

coffee formatter.litcoffee [Your Files]

Example:

coffee formatter.litcoffee sample/vdvc.coffee

Things to note

This project is written in Literate CoffeeScript (extension '.litcoffee'), which isn't syntax-highlighted by Github at this moment.

To read the code, it's suggested to go to docs/ folder. For example, docs/formatter.html contains properly highlighted code for formatter.litcoffee.

To run the test suite, install Mocha and run mocha in the base directory.

TODO

  1. Get rid of external dependencies.

License

WTFPL.