coffee-watcher

Version:

A script that can watch a directory and recompile your .coffee scripts if they change

68 lines (51 loc) • 10.4 kB

HTML

<!DOCTYPE html> <html> <head> <title>coffee-watcher.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="resources/docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> coffee-watcher.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> coffee-watcher is a script that can watch a directory and recompile your <a href="http://coffeescript.org/">.coffee scripts</a> if they change. It's very useful for development as you don't need to think about recompiling your CoffeeScript files. Search is done in a recursive manner so sub-directories are handled as well. <pre><code>Usage: coffee-watcher -p [prefix] -d [directory] Options: -d Specify which directory to scan. [default: "."] -p Which prefix should the compiled files have? Default is script.coffee will be compiled to .coffee.script.js. [default: ".coffee."] -h Prints help [boolean] </code></pre> Installing coffee-watcher is easy with <a href="http://npmjs.org/">npm</a>: <pre><code> sudo npm install coffee-watcher </code></pre> Run this to watch for changes in the current working directory: <pre><code> coffee-watcher </code></pre> Run this to watch for changes in a specified directory: <pre><code> coffee-watcher -d ~/Desktop/my_project </code></pre> coffee-watcher requires: <ul> <li><a href="http://nodejs.org/">node.js</a></li> <li><a href="http://en.wikipedia.org/wiki/Find">find</a></li> <li><a href="https://github.com/amix/watcher_lib">watcher_lib</a></li> <li><a href="https://github.com/amix/optimist">optimist</a></li> </ul> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> Specify the command line arguments for the script (using optimist) </td> <td class="code"> <div class="highlight"><pre>usage = "Watch a directory and recompile .coffee scripts if they change.\nUsage: coffee-watcher -p [prefix] -d [directory]." specs = require('optimist') .usage(usage) .default('d', '.') .describe('d', 'Specify which directory to scan.') .default('p', '.coffee.') .describe('p', 'Which prefix should the compiled files have? Default is script.coffee will be compiled to .coffee.style.css.') .boolean('h') .describe('h', 'Prints help')</pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> Handle the special -h case </td> <td class="code"> <div class="highlight"><pre>if specs.parse(process.argv).h specs.showHelp() process.exit() else argv = specs.argv</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> Use <code>watcher-lib</code>, a library that abstracts away most of the implementation details. This library also makes it possible to implement any watchers (see coffee-watcher for an example). </td> <td class="code"> <div class="highlight"><pre>watcher_lib = require 'watcher_lib'</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> Searches through a directory structure for *.coffee files using <code>find</code>. For each .coffee file it runs <code>compileIfNeeded</code> to compile the file if it's modified. </td> <td class="code"> <div class="highlight"><pre>findCoffeeFiles = (dir) -> watcher_lib.findFiles('*.coffee', dir, compileIfNeeded)</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> Keeps a track of modified times for .coffee files in a in-memory object, if a .coffee file is modified it recompiles it using compileCoffeeScript. When starting the script all files will be recompiled. </td> <td class="code"> <div class="highlight"><pre>WATCHED_FILES = {} compileIfNeeded = (file) -> watcher_lib.compileIfNeeded(WATCHED_FILES, file, compileCoffeeScript)</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> Compiles a file using <code>coffee -bp</code>. Compilation errors are printed out to stdout. </td> <td class="code"> <div class="highlight"><pre>compileCoffeeScript = (file) -> fnGetOutputFile = (file) -> file.replace(/([^\/\\]+)\.coffee/, "#{argv.p}$1.js") watcher_lib.compileFile("coffee -bp #{ file }", file, fnGetOutputFile)</pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> Starts a poller that polls each second in a directory that's either by default the current working directory or a directory that's passed through process arguments. </td> <td class="code"> <div class="highlight"><pre>watcher_lib.startDirectoryPoll(argv.d, findCoffeeFiles) </pre></div> </td> </tr> </tbody> </table> </div> </body> </html>