coffeescript README

The project's README from github.com/jashkenas/coffeescript. As one markdown file: README.md.

      @@@@@@@                @@@@  @@@@@
     @@@@@@@@@@              @@@   @@@                                           {
    @@@@     @@              @@@   @@@                                        }   }   {
   @@@@          @@@@@@@    @@@   @@@     @@@@@@    @@@@@@                   {   {  }  }
  @@@@          @@@   @@  @@@@@  @@@@@@  @@@   @@  @@@@  @@                   }   }{  {
  @@@@         @@@@   @@   @@@    @@@   @@@   @@@ @@@   @@@                  {  }{  }  }
  @@@@        @@@@    @@   @@@    @@@   @@@@@@@@  @@@@@@@@                  { }{ }{  { }
  @@@@@       @@@@   @@    @@@    @@@   @@@       @@@                     {  { } { } { }  }
   @@@@@@@@@@ @@@@@@@@    @@@    @@@    @@@@@@@@  @@@@@@@@                 { }   { }   { }
      @@@@@               @@@    @@@      @@@@@     @@@@@           @@@@@@   { }   { }    @@@@@@@
                         @@@    @@@                                 @@@@@@@@@@@@@@@@@@@@@@@@@@@@
      @@@@@@            @@@    @@@                                @@ @@@@@@@@@@@@@@@@@@@@@@@@@@
   @@@@    @@          @@@   @@@@                                @@   @@@@@@@@@@@@@@@@@@@@@@@@
   @@@@   @@@                       @@                  @@@@     @@@   @@@@@@@@@@@@@@@@@@@@@
   @@@@@          @@@@@   @@  @@   @@@     @@@@@@@     @@@@@      @@@    @@@@@@@@@@@@@@@@@@
     @@@@@      @@@  @@@ @@@@@@@@         @@@@  @@@@  @@@@@@@       @@@   @@@@@@@@@@@@@@@@
       @@@@@   @@@       @@@@     @@@@    @@@    @@@   @@@                 @@@@@@@@@@@@@@
 @@@@@  @@@@  @@@@      @@@@      @@@@   @@@@   @@@@  @@@@
@@@     @@@@  @@@       @@@@     @@@@    @@@    @@@@  @@@@
@@@     @@@@  @@@@     @@@@      @@@@   @@@@   @@@@  @@@@
 @@@@@@@@@     @@@@@@  @@@@       @@@@  @@@@@@@@@    @@@@
                                       @@@          @@@@
                                      @@@
                                      @@@

CoffeeScript is a little language that compiles into JavaScript.

Installation

Once you have Node.js installed:

# Install locally for a project:
npm install --save-dev coffeescript

# Install globally to execute .coffee files anywhere:
npm install --global coffeescript

Getting Started

Execute a script:

coffee /path/to/script.coffee

Compile a script:

coffee -c /path/to/script.coffee

For documentation, usage, and examples, see: https://coffeescript.org/

To suggest a feature or report a bug: https://github.com/jashkenas/coffeescript/issues

If you’d like to chat, drop by #coffeescript on Freenode IRC.

The source repository: https://github.com/jashkenas/coffeescript.git

Changelog: https://coffeescript.org/#changelog

Our lovely and talented contributors are listed here: https://github.com/jashkenas/coffeescript/contributors

coffeescript (jashkenas/coffeescript)

coffeescript
Searching Database…

What is this?CoffeeScript is a little programming language that compiles into JavaScript: you write in its cleaner syntax and get plain, standard JavaScript out.
So is it a programming language, or a compiler tool I install?Both. CoffeeScript is the language itself, and the project ships it as a compiler you install and run from the terminal to turn CoffeeScript into JavaScript.
How do I install it and run my first script?Install Node.js, then run 'npm install -g coffeescript'. Afterwards you can execute a script directly with the 'coffee' command or compile it to JavaScript first.
Besides Node.js, do I need anything else?No. Node.js version 6 or newer is the only requirement — the package has no extra runtime dependencies or native build steps.
Can the browser run CoffeeScript directly?No — browsers don't understand CoffeeScript, so code is always compiled to JavaScript first, and that output runs anywhere JavaScript does.
What operating systems does the compiler work on?The compiler runs wherever Node.js does — Windows, macOS and Linux — with no OS-specific requirements.
What does 'Unfancy JavaScript' mean?It's the project's own tagline: CoffeeScript offers a cleaner, less noisy syntax for writing the same JavaScript programs, and the compiler translates that syntax into plain JavaScript.
How established is CoffeeScript?It's a classic of the JS ecosystem: started in December 2009, one of the longest-running JavaScript-alternative languages, with about 16.6k stars on GitHub, and the repository is not archived.
What are similar projects?TypeScript, Tov, pkg, tsx, zig, CalcKernel, tsrx, assemblyscript
Creator
jashkenas
Size
29.9 MB
Stars
16.6K
Updated
CommitSep 19
Age
16y
Commits · 90 Days