checkBadCharactersInPath() — vite Function Reference

Architecture documentation for the checkBadCharactersInPath() function in config.ts from the vite codebase.

Function typescript ViteCore ConfigEngine calls 1 called by 2

Entity Profile

ViteCore→ ConfigEngine→ checkBadCharactersInPath() — vite Function Reference

Dependency Diagram

graph TD
  1ce04abd_e38d_39ef_c5e9_a9ef75086f4f["checkBadCharactersInPath()"]
  7da774f9_eca5_d54e_6e01_6bee7d460a2b["config.ts"]
  1ce04abd_e38d_39ef_c5e9_a9ef75086f4f -->|defined in| 7da774f9_eca5_d54e_6e01_6bee7d460a2b
  58c4a210_68fe_1b4d_ed49_d59203f97ef1["resolveConfig()"]
  58c4a210_68fe_1b4d_ed49_d59203f97ef1 -->|calls| 1ce04abd_e38d_39ef_c5e9_a9ef75086f4f
  53f0a505_9626_e709_c92b_e7f00c6e0bd7["loadConfigFromFile()"]
  53f0a505_9626_e709_c92b_e7f00c6e0bd7 -->|calls| 1ce04abd_e38d_39ef_c5e9_a9ef75086f4f
  00831e67_fe39_7ed4_eed0_e29cb8e15286["warn()"]
  1ce04abd_e38d_39ef_c5e9_a9ef75086f4f -->|calls| 00831e67_fe39_7ed4_eed0_e29cb8e15286
  style 1ce04abd_e38d_39ef_c5e9_a9ef75086f4f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/vite/src/node/config.ts lines 1029–1058

function checkBadCharactersInPath(
  name: string,
  path: string,
  logger: Logger,
): void {
  const badChars = []

  if (path.includes('#')) {
    badChars.push('#')
  }
  if (path.includes('?')) {
    badChars.push('?')
  }
  if (path.includes('*')) {
    badChars.push('*')
  }

  if (badChars.length > 0) {
    const charString = badChars.map((c) => `"${c}"`).join(' and ')
    const inflectedChars = badChars.length > 1 ? 'characters' : 'character'

    logger.warn(
      colors.yellow(
        `${name} contains the ${charString} ${inflectedChars} (${colors.cyan(
          path,
        )}), which may not work when running Vite. Consider renaming the directory / file to remove the characters.`,
      ),
    )
  }
}