Home / File/ base.ts — vite Source File

base.ts — vite Source File

Architecture documentation for base.ts, a typescript file in the vite codebase. 7 imports, 2 dependents.

File typescript ViteCore ConfigEngine 7 imports 2 dependents 1 functions

Entity Profile

Dependency Diagram

graph LR
  ed4cdfe5_4523_9979_979c_b5f6e2b5f2c6["base.ts"]
  031bc221_67a8_c579_f2bf_bb30a08beeb2["utils.ts"]
  ed4cdfe5_4523_9979_979c_b5f6e2b5f2c6 --> 031bc221_67a8_c579_f2bf_bb30a08beeb2
  c9db8630_93b3_267d_8e26_8b62626a11ca["joinUrlSegments"]
  ed4cdfe5_4523_9979_979c_b5f6e2b5f2c6 --> c9db8630_93b3_267d_8e26_8b62626a11ca
  013086ce_01e9_45cb_743f_587baeb03e55["stripBase"]
  ed4cdfe5_4523_9979_979c_b5f6e2b5f2c6 --> 013086ce_01e9_45cb_743f_587baeb03e55
  abfc9e70_3c15_b3f0_a595_3cf27afb7e64["utils.ts"]
  ed4cdfe5_4523_9979_979c_b5f6e2b5f2c6 --> abfc9e70_3c15_b3f0_a595_3cf27afb7e64
  10b9dea8_362c_1af2_93be_afa4dd9aed9e["cleanUrl"]
  ed4cdfe5_4523_9979_979c_b5f6e2b5f2c6 --> 10b9dea8_362c_1af2_93be_afa4dd9aed9e
  1a3bec7b_1a11_316f_5831_a0535b829bbf["withTrailingSlash"]
  ed4cdfe5_4523_9979_979c_b5f6e2b5f2c6 --> 1a3bec7b_1a11_316f_5831_a0535b829bbf
  9165291b_077b_bedb_8c23_36e44bc99390["connect"]
  ed4cdfe5_4523_9979_979c_b5f6e2b5f2c6 --> 9165291b_077b_bedb_8c23_36e44bc99390
  e49f0ff7_5101_3a1d_5a1f_33fae58eea2d["preview.ts"]
  e49f0ff7_5101_3a1d_5a1f_33fae58eea2d --> ed4cdfe5_4523_9979_979c_b5f6e2b5f2c6
  a423a1ed_f7d8_0eb5_9b8f_ddfa7fa8147e["index.ts"]
  a423a1ed_f7d8_0eb5_9b8f_ddfa7fa8147e --> ed4cdfe5_4523_9979_979c_b5f6e2b5f2c6
  style ed4cdfe5_4523_9979_979c_b5f6e2b5f2c6 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { Connect } from '#dep-types/connect'
import { joinUrlSegments, stripBase } from '../../utils'
import { cleanUrl, withTrailingSlash } from '../../../shared/utils'

// this middleware is only active when (base !== '/')

export function baseMiddleware(
  rawBase: string,
  middlewareMode: boolean,
): Connect.NextHandleFunction {
  // Keep the named function. The name is visible in debug logs via `DEBUG=connect:dispatcher ...`
  return function viteBaseMiddleware(req, res, next) {
    const url = req.url!
    const pathname = cleanUrl(url)
    const base = rawBase

    if (pathname.startsWith(base)) {
      // rewrite url to remove base. this ensures that other middleware does
      // not need to consider base being prepended or not
      req.url = stripBase(url, base)
      return next()
    }

    // skip redirect and error fallback on middleware mode, #4057
    if (middlewareMode) {
      return next()
    }

    if (pathname === '/' || pathname === '/index.html') {
      // redirect root visit to based url with search and hash
      res.writeHead(302, {
        Location: base + url.slice(pathname.length),
      })
      res.end()
      return
    }

    // non-based page visit
    const redirectPath =
      withTrailingSlash(url) !== base ? joinUrlSegments(base, url) : base
    if (req.headers.accept?.includes('text/html')) {
      res.writeHead(404, {
        'Content-Type': 'text/html',
      })
      res.end(
        `The server is configured with a public base URL of ${base} - ` +
          `did you mean to visit <a href="${redirectPath}">${redirectPath}</a> instead?`,
      )
      return
    } else {
      // not found for resources
      res.writeHead(404, {
        'Content-Type': 'text/plain',
      })
      res.end(
        `The server is configured with a public base URL of ${base} - ` +
          `did you mean to visit ${redirectPath} instead?`,
      )
      return
    }
  }
}

Domain

Subdomains

Functions

Frequently Asked Questions

What does base.ts do?
base.ts is a source file in the vite codebase, written in typescript. It belongs to the ViteCore domain, ConfigEngine subdomain.
What functions are defined in base.ts?
base.ts defines 1 function(s): baseMiddleware.
What does base.ts depend on?
base.ts imports 7 module(s): cleanUrl, connect, joinUrlSegments, stripBase, utils.ts, utils.ts, withTrailingSlash.
What files import base.ts?
base.ts is imported by 2 file(s): index.ts, preview.ts.
Where is base.ts in the architecture?
base.ts is located at packages/vite/src/node/server/middlewares/base.ts (domain: ViteCore, subdomain: ConfigEngine, directory: packages/vite/src/node/server/middlewares).

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free