semi-static

semi-static

Simple, lazy way to serve a directory of semi-static pages in express.js. Handy for building quick "static" pages inside an otherwise "dynamic" app.

Often you have a dynamic web app that also needs a bunch of mostly "static" pages. But you still want to use the same app layouts and template system to build out those pages. Take for instance an FAQ page inside your app that otherwise has a bunch of dynamic content.

It's silly to build a specifc route for that page when all you really want is a route that at 'http://yourapp.com/faq' renders the faq.pug template in your express.js app.

I find myself adding code like this to nearly every express app I write, so I figured why the heck not publish an npm module and re-use that. So, here we are.

Basic use

1. Install with npm: npm install semi-static

2. Create a folder called static inside your express views folder.

3. Register a handler that tells it to use semi-static to render and serve template names at urls as if they were static: app.get('*', semiStatic());

4. Profit!

Full Example

You can run the example in this repo by changing to the example directory and running node server.js and both http://localhost:3000/ and http://localhost:3000/help should render the correct templates.

Here's basic sample code (see the example directory for a more elaborate example):

// super simple demo
var express = require('express');
var semiStatic = require('semi-static');

// init our app
app = express();

// use pug
app.set('view engine', 'pug');

// serve our static files
app.use(express.static(__dirname + '/public'))

// register our handler
app.get('*', semiStatic());

// we can still have a normal 404 at the end
// because it will only do something if there's
// a path that matches.
app.all('*', function (req, res) {
    res.send('not found', 404);
});

app.listen(3000);
console.log('started');

Options / How it works

All it needs is the folder where your "static" templates live and the file extension your templates use. If you just need to render Pug (the default extension), you can simply call semiStatic("path/to/your/pug/templates"). For compatibility reasons, the default also falls back to accepting .jade, but you should change that extension ASAP.

If you need more customization, you can set the options as follows:

// This is with the default options
app.get("/hello*", semiStatic({
    // Path to your templates
    folderPath: path.dirname(require.main.filename) + "/views/static",

    // Extension for your templates.
    fileExt: "ejs",

    // URL root for your templates.
    root: "/",

    // Whether to pass the request as `req` to res.render()
    passReq: false,

    // A custom context to send to the file, either a value or a function that
    // accepts two arguments: the request and a Node-style callback that takes
    // an error and return value.
    context: undefined
}));

That's it, easy-peasy.

You may also include an option called context that will be passed to the rendering engine. Context can either be an object that will be passed as variables or a function that takes the req from express and a callback (whose result will then be passed to the template). If you specify passReq: true the express request object will also be passed (useful to access req.params, req.query, etc from your template). See the example code for more details.

Little sneaky static sites within your app (great for docs)

If you want to serve an index file you can do that too.

So if you do this:

app.get("*", semiStatic());

And put a file called index.pug inside views/static it will get served at yoursite.com as well as yoursite.com/index.

This is so you can basically have little mini static sites inside your app. For example, I like doing stuff like this for serving out a little semi-static help site within an app:

app.get('/help/*', semiStatic({
    folderPath: __dirname + '/help-site',
    root: '/help'
}));

As long as you've got a folder with an index.pug file in it your help site will be available at yoursite.com/help

License

MIT

If you think this is handy, follow @HenrikJoreteg on the twitters. See you on the interwebz!