Skip to content

zeroEvidence/express-manifest

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

express-manifest

Middleware which resolves requests based on generic filenames to the associated file fingerprint outlined in a manifest file.

// index.js (example ExpressJS application)

var express = require('express');
var manifest = require('express-manifest');
var app = express();

// view engine configuration...
// template engine configuration...

app.use(manifest({
  manifest: path.join(__dirname, 'public') + '/rev-manifest.json',
  prepend: path.join(__dirname, 'public'),
  reqPathFind: /^(\/?)/,
  reqPathReplace: '',
  debug: true;
}));
app.use(express.static(path.join(__dirname, 'public')));

// routes configuration...

module.exports = app;

How it works

It obtains the incoming request path, replaces any required parts of that string and uses that string as the index within the manifest JSON file, which should return the file path relative to the "prepend" path, then if it finds the file it will send the file to the browser. QED.

Sample manifest.json

{
  "javascripts/app.js": "javascripts/app-87efdd3684ac55b9497c.js",
  "stylesheets/global.css": "stylesheets/global-692736a41c.css"
}

Sample directory structure

.
├── index.js
├── bin
│   └── www
├── package.json
├── public
│   ├── javascripts
│   |   └── app-87efdd3684ac55b9497c.js
│   └── stylesheets
│       └── global-692736a41c.css

Config

defaults.json file defaults to the following configuration values:

{
  "manifest": "./public/rev-manifest.json",
  "prepend": "",
  "debug": false
}

manifest: String

Path to JSON manifest file relative to your "index.js".

prepend: String

Path to where the static assets are.

reqPathFind: String || Regex

The search String / Regex to modify the req.path as you see fit.

reqPathReplace: String

What to replace the matching "reqPathFind" value with.

debug: Boolean

Output useful information to the console. It, obviously, requires for one to hit the server.

About

Middleware which resolves requests based on generic filenames to the associated file fingerprint outlined in a manifest file.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published