The stupid development server.
$ npm install -g 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 Examples:Serve the current directory$ cd /var/www$ workitServing /var/www atServe a specific directory$ workit /var/www/fooServing /var/www/foo atServe a specific directory with options$ workit -a 192.168.0.1 -p 8080 /var/www/fooServing /var/www/foo at
workit transparently compiles
.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
File extensions are taken literally. If you request
.jade, you'll get Jade:
$ curl ''!!! 5title Hello worldlink(rel='stylesheet', href='foo.css')script(src='workit-reload.js')script(src='foo.js')
If you want the slightly-more-useful compiled HTML, request
$ curl ''<!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
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>// Jadescript(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
header to enable CORS.
Third-party resources that aren't CORS friendly can be requested via the built-in, and quite naive, proxy:
$ curl ''<!doctype html><html itemscope="itemscope" itemtype="" ...
Nib is made available to Stylus files. Just import it:
@import 'nib'*// Nib will add vendor prefixed variantsbox-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
workit-so as not to be confused with middleware of the same name by different authors.
watchr. Vastly improves performance and cross-platform reliability of file watching, especially when the server should be idle. Fixes #6.
fs.*Syncwith their async counterparts.
hound. Common system and hidden files are now ignored. Fixes #5.
(The MIT License)
Copyright (c) Shannon Moeller <email@example.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.