hmrShouldReload() — vue Function Reference

Architecture documentation for the hmrShouldReload() function in compileScript.ts from the vue codebase.

Function typescript SfcCompiler ScriptCompiler calls 1 called by 1

Entity Profile

SfcCompiler→ ScriptCompiler→ hmrShouldReload() — vue Function Reference

Dependency Diagram

graph TD
  4963bb7f_aa8f_8391_a726_4dfb648391e3["hmrShouldReload()"]
  c9346cac_54e3_f6ca_68a7_03c6e82c9609["compileScript.ts"]
  4963bb7f_aa8f_8391_a726_4dfb648391e3 -->|defined in| c9346cac_54e3_f6ca_68a7_03c6e82c9609
  9805a097_f548_6bcf_28b2_a636f018a4de["parse()"]
  9805a097_f548_6bcf_28b2_a636f018a4de -->|calls| 4963bb7f_aa8f_8391_a726_4dfb648391e3
  4fe50d93_1397_443f_6dd0_df2c8c87a955["isImportUsed()"]
  4963bb7f_aa8f_8391_a726_4dfb648391e3 -->|calls| 4fe50d93_1397_443f_6dd0_df2c8c87a955
  style 4963bb7f_aa8f_8391_a726_4dfb648391e3 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/compiler-sfc/src/compileScript.ts lines 1896–1916

export function hmrShouldReload(
  prevImports: Record<string, ImportBinding>,
  next: SFCDescriptor
): boolean {
  if (!next.scriptSetup) {
    return false
  }

  const isTS = next.scriptSetup.lang === 'ts' || next.scriptSetup.lang === 'tsx'
  // for each previous import, check if its used status remain the same based on
  // the next descriptor's template
  for (const key in prevImports) {
    // if an import was previous unused, but now is used, we need to force
    // reload so that the script now includes that import.
    if (!prevImports[key].isUsedInTemplate && isImportUsed(key, next, isTS)) {
      return true
    }
  }

  return false
}