tgext.coffeescript / README.rst

About tgext.coffeescript

CoffeeScript is a little language that compiles to JavaScript. Underneath all those awkward braces and semicolons, JavaScript has always had a gorgeous object model at its heart. CoffeeScript is an attempt to expose the good parts of JavaScript in a simple way.

tgext.coffeescript is a middleware aimed at making TurboGears2 development easier, tgext.coffeescript converts regular coffee files to javascript using the official CoffeeScript compiler.

tgext.coffeescript is based on tgext.scss by Alessandro Molina and is under the same license (MIT).


tgext.coffeescript can be installed both from pypi or from bitbucket:

easy_install tgext.coffeescript

You will also need to install the CoffeeScript compiler, for instructions on this check their website.


Enabling tgext.coffeescript

Using tgext.coffeescript is really simple, you edit your config/ and just after the #Wrap your base TurboGears 2 application with custom middleware here comment wrap app with CoffeeScriptMiddleware:

from tgext.coffeescript import CoffeeScriptMiddleware

make_base_app = base_config.setup_tg_wsgi_app(load_environment)

def make_app(global_conf, full_stack=True, **app_conf):
    app = make_base_app(global_conf, full_stack=True, **app_conf)

    # Wrap your base TurboGears 2 application with custom middleware here
    app = CoffeeScriptMiddleware(app)

    return app

Now you just have to put your .coffee files inside public/javascript and they will be served as JavaScript.

Compiler options

Currently tgext.coffeescript turns the --bare compiler option by default, this means that the resulting javascript output will not be wrapper under a top-level function, if you want to reverse this behaviour you can tell the middleware to disable it:

app = CoffeeScriptMiddleware(app, bare=False)

This will disable the bare options for all files served with tgext.coffeescript, more granular control of this option may be available later depending on the need for it.