Django template tags to compile CoffeeScript
Project description
Django CoffeeScript provides template tags to compile CoffeeScript into JavaScript from templates. It works with both inline code and extenal files.
Installation
Add "coffeescript" to INSTALLED_APPS setting.
Make sure that you have coffee executable installed. See CoffeeScript official site for details.
Optionally, you can specify the full path to coffee executable with COFFEESCRIPT_EXECUTABLE setting. By default it’s set to coffee.
Example Usage
Inline
{% load coffeescript %} <script type="text/javascript"> {% inlinecoffeescript %} console.log "Hello, World!" {% endinlinecoffeescript %} </script>
renders to
<script type="text/javascript"> (function() { console.log("Hello, World!"); }).call(this); </script>
External file
{% load coffeescript %} <script type="text/javascript" src="{{ STATIC_URL}}{% coffeescript "path/to/script.coffee" %}"> </script>
renders to
<script type="text/javascript" src="/media/COFFEESCRIPT_CACHE/path/to/script-91ce1f66f583.js"> </script>
Note that by default compiled files are saved into COFFEESCRIPT_CACHE folder under your STATIC_ROOT (or MEDIA_ROOT if you have no STATIC_ROOT in your settings). You can change this folder name with COFFEESCRIPT_OUTPUT_DIR setting.
Settings
- COFFEESCRIPT_EXECUTABLE
Path to CoffeeScript compiler executable. Default: "coffee".
- COFFEESCRIPT_OUTPUT_DIR
Output directory for compiled external scripts. It’s relative to STATIC_ROOT. Default: "COFFEESCRIPT_CACHE".
- COFFEESCRIPT_USE_CACHE
Whether to use cache for inline scripts. Default: True.
- COFFEESCRIPT_CACHE_TIMEOUT
Cache timeout for inline scripts (in seconds). Default: 30 days.
- COFFEESCRIPT_MTIME_DELAY
Cache timeout for reading the modification time of external scripts (in seconds). Default: 10 seconds.
Changes
0.4
Log coffeescript compilation errors
Fixed bug with paths on Windows (by syabro)
0.3
Use STATIC_ROOT / STATIC_URL settings when possible instead of MEDIA_ROOT / MEDIA_URL (by Roman Vorushin)
0.2.1
Add CHANGES.rst to MANIFEST.in
0.2
Automatically remove old files from COFFEESCRIPT_CACHE
Add basic unit tests
0.1
Initial release
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.