🔁 vite-proxy-redirects-plugin

A powerful Vite plugin for dynamic dev proxying and build-time redirect generation based on environment variables.

Supports:

• Vite dev server proxy rewrites (vite serve)
• Netlify-style _redirects output
• Vercel-style vercel.json output
• Nginx-style nginx.conf.snippet output ... based on detected platform or override.

📦 Installation

npm install vite-proxy-redirects-plugin --save-dev

⚙️ Usage

1. Add to vite.config.js

import redirectsUpdate from 'vite-proxy-redirects-plugin';

export default {
  plugins: [
    redirectsUpdate({
      templateFile: 'redirects.template',      // optional, defaults to 'redirects.template'
      deployPlatform: 'netlify'                // optional, defaults to 'netlify', override: 'netlify' | 'vercel' | 'nginx'
    })
  ]
};

2. Set environment variables

BASE_PROXY_URL=https://api.example.com
AUTH_URL=https://auth.example.com

3. Create redirects.template in root

# Format: [source_path] [target_url]
/api/* {{BASE_PROXY_URL}}/v1/*
/auth/* {{AUTH_URL}}/login/*
/admin/* {{ADMIN_URL}}/dashboard/*

⚠️ Lines with missing {{VAR}} are skipped automatically.

🧠 Platform Detection

This plugin detects the deploy environment automatically via:

• process.env.DEPLOY_PLATFORM=netlify|vercel|nginx

• or CI-specific variables:

  • VERCEL=1
  • NETLIFY=true

🛠 Behavior Overview

🔧 Development (vite serve)

• Loads redirects.template
• Replaces {{VAR}} with .env values
• Skips invalid/missing lines
• Applies proxy rewrites to vite.config.server.proxy
• Logs each mapping

📦 Production (vite build)

• Resolves {{VAR}} in each rule

• Based on detected or configured platform:

  • Writes _redirects for Netlify
  • Writes vercel.json for Vercel

• Skips lines with unresolved env vars

• Logs each rewrite

🧪 Example

redirects.template:

/api/* {{BASE_PROXY_URL}}/v1/*
/auth/* {{AUTH_URL}}/login/*
/skip/* {{UNDEFINED}}/noop/*

.env:

BASE_PROXY_URL=https://api.example.com
AUTH_URL=https://auth.example.com

Output (vite):

vite.config:
{
  "proxy": {
    "/api/": {
      target: "https://api.example.com",
      changeOrigin: true,
      secure: false,
      rewrite: p => p.replace(/^\/api/, "/v1/")
    },
    "/auth/": {
      target: "https://auth.example.com",
      changeOrigin: true,
      secure: false,
      rewrite: p => p.replace(/^\/auth/, "/login/")
    }
  }
}

Output (Netlify):

_redirects:
  /api/* https://api.example.com/v1/:splat 200!
  /auth/* https://auth.example.com/login/:splat 200!

Output (Vercel):

vercel.json:
{
  "rewrites": [
    {
      "source": "/api/*",
      "destination": "https://api.example.com/v1/"
    },
    {
      "source": "/auth/*",
      "destination": "https://auth.example.com/login/"
    }
  ]
}

Output Nginx:

nginx.conf.snippet:
# Nginx Redirects
#
# Copy and paste the following rewrite rules into your Nginx server block.
#
# Example server block:
# server {
#   listen 80;
#   server_name example.com;
#   root /var/www/html;
#
#   // Paste the content below here
#
#   location / {
#     try_files $uri $uri/ =404;
#   }
# }
rewrite ^/api/(.*)$ https://api.example.com/v1/$1 permanent;
rewrite ^/auth/(.*)$ https://auth.example.com/login/$1 permanent;

🧩 Template Syntax

• Lines beginning with # are comments
• Use {{VAR}} for dynamic replacement
• Supports wildcards: /api/*
• Auto-rewrites path differences in dev proxy
• Skips malformed or undefined routes

📜 License

MIT