DEPRECATION NOTICE: This project is no longer maintained and the package name has been transferred to MiguelCastillo/workit. For a generic static server see serve and http-server.
The stupid development server.
- Reloads browser on source-file change.
- Serves CoffeeScript, Jade, and Stylus like a champ.
- Compiled output sent directly to browser for a pristine working directory.
- No preprocessor caching so you're guaranteed to load the freshest code.
- CORS enabled.
Built with Node.js using Connect, Socket.io, Commander.js, and Chokidar. Inspired by visionmedia's serve and nodejitsu's http-server.
Via npm:
$ npm install -g shannonmoeller/workit
Usage: workit [options] [dir]
Options:
-h, --help output usage information
-V, --version output the version number
-a, --address <string> set hostname [127.0.0.1]
-f, --format <string> connect logger format [dev]
-p, --port <number> set port number [3000]
Examples:
Serve the current directory
$ cd /var/www
$ workit
Serving /var/www at http://localhost:3000/
Serve a specific directory
$ workit /var/www/foo
Serving /var/www/foo at http://localhost:3000/
Serve a specific directory with options
$ workit -a 192.168.0.1 -p 8080 /var/www/foo
Serving /var/www/foo at http://192.168.0.1:8080/
workit transparently compiles .coffee, .jade, and .styl files and sends
the output directly to the browser. No rendered files are written to disk, so
your working directory is left in a pristine state (I'm looking at you
connect-assets).
File extensions are taken literally. If you request .jade, you'll get Jade:
$ curl 'http://localhost:3000/foo.jade'
!!! 5
title Hello world
link(rel='stylesheet', href='foo.css')
script(src='workit-reload.js')
script(src='foo.js')
If you want the slightly-more-useful compiled HTML, request .htm or .html
instead:
$ curl 'http://localhost:3000/foo.html'
<!DOCTYPE html>
<title>Hello world</title>
<link rel="stylesheet" href="foo.css">
<script src="workit-reload.js"></script>
<script src="foo.js"></script>
Same goes for .coffee vs .js and .styl vs .css.
To enable automatic reloading of a page when a file in your project is created
or changed, simply include the virtual workit-reload.js in your markup:
<!-- HTML -->
<script src="workit-reload.js"></script>
// Jade
script(src='workit-reload.js')
The filename is magic, so the path doesn't matter:
// Also works!
script(src='../my/public/assets/dir/workit-reload.js')
All requests are forcibly served with the Access-Control-Allow-Origin: *
header to enable CORS.
Third-party resources that aren't CORS friendly can be requested via the built-in, and quite naive, proxy:
$ curl 'http://localhost:3000/workit-cors/http://www.google.com/search?q=nodejs'
<!doctype html><html itemscope="itemscope" itemtype="http://schema.org/WebPage" ...
Nib is made available to Stylus files. Just import it:
@import 'nib'
*
// Nib will add vendor prefixed variants
box-sizing: border-box
Inlining of assets via Stylus' url() is not enabled (this is a dev server
after all), but you may install node-canvas to get IE-friendly inlined
gradients.
- Added markdown support.
- Corrected host value in piped request headers.
- Fixed another string length bug in workit-cors.
- Fixed string length bug in workit-cors.
- Changed middleware prefixes from
connect-toworkit-so as not to be confused with middleware of the same name by different authors.
- Now using
chokidarinstead ofwatchr. Vastly improves performance and cross-platform reliability of file watching, especially when the server should be idle. Fixes #6.
- Upgraded from
flowtostep.
- Replaced all
fs.*Syncwith their async counterparts. - Nuked some superfluous variable assignments.
- Added CORS header and proxy.
- Now using
watchrinstead ofhound. Common system and hidden files are now ignored. Fixes #5. - Now using
foreverinstead ofsupervisorinmake test.
(The MIT License)
Copyright (c) Shannon Moeller <me@shannonmoeller.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.