/coffeescript-php

A port of the CoffeeScript compiler to PHP.

Primary LanguagePHPMIT LicenseMIT

CoffeeScript PHP

A port of the CoffeeScript compiler to PHP.

Status

CoffeeScript version 1.1.1 has been fully ported over (see tags). Compiled code nearly matches the reference 100%, except for the occasional extra newline. Tons of E_STRICT problems.

Work towards porting version 1.3.1 and making it E_STRICT is taking place on the master branch.

Requirements

PHP 5.3+ (uses namespaces, anonymous functions).

Install

It's recommended that you use Composer to install and autoload CoffeeScript. Alternatively you can load it manually:

<?php

require 'vendor/CoffeeScript/Init.php';

// Load manually
CoffeeScript\Init::load();

?>

Usage

At the moment the API is pretty basic. It'll probably be expanded a bit in the future.

<?php

$coffee = file_get_contents('path/to/source.coffee');

try
{
  $js = CoffeeScript\Compiler::compile($coffee);
}
catch (Exception e)
{
  echo $e->getMessage();
}

?>

Development

To rebuild the parser run php make.php. Tests are run in the browser; simply clone the repository somewhere Apache can see it and navigate to tests/.

FAQ

Why not modify the original compiler to emit PHP?

The compiler itself depends on Jison, which is written in JavaScript, so you'd have to do something about that... More generally speaking, it'd be much more work to try and sort out all the differences between JavaScript and PHP (object model, core classes/libraries, etc), I imagine. There's also much less incentive to do all that work server side, where the choice to not use one language is, if not easy, at least available.

What parser generator are you using?

Since there's no PHP port of Bison (which the reference compiler uses), we're using a port of Lemon called ParserGenerator.

It's included locally since the PEAR package is unmaintained and seems to be broken. In addition, some minor changes have been made to the parser template (Lempar.php) and the actual generator.