Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Use CoffeeScript in WordPress
PHP
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
.gitignore
LICENSE.txt
README.md Adding links to readme references to "examples"
functions.php
readme.txt
wp_coffeescript.php

README.md

WP CoffeeScript

Allows developers to easily use CoffeeScript in WordPress. Simply use enqueue_coffeescript(); the compilation is done automatically behind the scenes.

Description

WP CoffeeScript is a WordPress plugin that makes enqueueing CoffeeScript as easy as enqueueing JavaScript. Instead of using wp_enqueue_script(), as you would for JS, you just use enqueue_coffeescript(), which takes almost exactly the same arguments. The only difference is that the second argument should be the file path instead of the URL. If you'd like to compile multiple CS files into a single JS file, you can use an array of file paths as the second argument.

Please note that the CoffeeScript executable must be installed on the server. You can also set a custom path to the executable (see the examples).

If you'd like to grab development releases, see what new features are being added, or browse the source code please visit the GitHub repo

Installation

  1. Put wp-coffeescript into the wp-content/plugins directory
  2. Activate the plugin through the 'Plugins' menu in WordPress
  3. Make sure that the CoffeeScript executable is installed on the server or set a custom path to the executable (see the examples)

Examples

Enqueue a CoffeeScript file that's in the theme directory:

enqueue_coffeescript('my-handle', get_template_directory().'/my-script.coffee');

Enqueue multiple CS files, compiling them into a single output file:

$script1 = get_template_directory().'/script1.coffee';
$script2 = get_template_directory().'/script2.coffee';
enqueue_coffeescript('my-handle', array($script1, $script2));

Enqueue a CS file in the footer with dependencies (the arguments are exactly the same as in wp_enqueue_script()):

enqueue_coffeescript('my-handle', get_template_directory().'/my-script.coffee', array('dep1', 'dep2'), false, true);

Set a custom path to the CS executable (the default value is coffeescript):

add_filter('wpcs_executable', 'set_wpcs_executable');
function set_wpcs_executable($path) {
    return '/my/path/to/coffeescript';
}

Compile the CS on every page load (the default behavior is to only compile when the JS has been modified):

add_filter('wpcs_caching_enabled', 'disable_wpcs_caching');
function disable_wpcs_caching($is_enabled) {
    return false;
}

Frequently Asked Questions

Where should I go for support questions or to ask for a new feature?

Please feel free to either add a topic in the WordPress forum or contact me through GitHub for any questions:

Something went wrong with that request. Please try again.