README
grunt-nate-connect-rewrite v0.2.1
This plugin provides RewriteRules middleware for the Grunt Connect / Express. Which could be used to redirect (rewrite internally or redirect using HTTP codes) User to the specific URL based on RegExp Rules.
More flexible alternative
In case you like this plugin it makes sense to look at http-rewrite-middleware as more flexible alternative.
Getting Started
This plugin requires Grunt ~0.4.1
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-nate-connect-rewrite --save-dev
Options
Rule's format:
{from: '__from__', to: '__to__'[, redirect: 'permanent'|'temporary']}
Where:
__from__
- RegExp string to match.__to__
- String that replaces matched URL.redirect
- Optional parameter:- When it is omitted then the Rule will be dispatched as an internal rewrite (aka proxified).
- If the value is set then Browser will receive HTTP
Location
Header with value of parsed__to__
(permanent
value will giveHTTP 301
, any other value will giveHTTP 302
).
rulesProvider
Type: String
Default value: connect.rules
You can specify grunt config section from which Rules will be read, like so:
grunt.initConfig({
express: {
options: {
port: 9000
},
server: {
hostname: 'localhost'
},
rules: [
// ... your rules here
]
},
configureRewriteRules: {
options: {
rulesProvider: 'express.rules'
}
}
})
Example of usage
In your project's Gruntfile:
- Include the
rewriteRequest
snippet. - Add a section named
rules
to your existing Connect or Express definition. Please note: unlike options, rules cannot be set per server, so therules
attribute must always be nested directly underconnect
orexpress
. - Add
configureRewriteRules
before the web server task. - Don't forget to load the plugin (e.g.
grunt.loadNpmTasks('grunt-nate-connect-rewrite')
).
var rewriteRulesSnippet = require('grunt-nate-connect-rewrite/lib/utils').rewriteRequest;
grunt.initConfig({
connect: {
options: {
port: 9000,
hostname: 'localhost'
},
rules: [
// Internal rewrite
{from: '^/index_dev.html