preprocess() — vue Function Reference

Architecture documentation for the preprocess() function in compileTemplate.ts from the vue codebase.

Function typescript SfcCompiler ScriptCompiler called by 1

Entity Profile

SfcCompiler→ ScriptCompiler→ preprocess() — vue Function Reference

Dependency Diagram

graph TD
  dc1988e8_1a5f_087d_975c_0b61e072267f["preprocess()"]
  b824bd73_da14_5076_9939_3d47171265ea["compileTemplate.ts"]
  dc1988e8_1a5f_087d_975c_0b61e072267f -->|defined in| b824bd73_da14_5076_9939_3d47171265ea
  795ab079_4dc2_c8c2_2823_264abd630fbc["compileTemplate()"]
  795ab079_4dc2_c8c2_2823_264abd630fbc -->|calls| dc1988e8_1a5f_087d_975c_0b61e072267f
  style dc1988e8_1a5f_087d_975c_0b61e072267f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/compiler-sfc/src/compileTemplate.ts lines 66–95

function preprocess(
  options: SFCTemplateCompileOptions,
  preprocessor: any
): string {
  const { source, filename, preprocessOptions } = options

  const finalPreprocessOptions = Object.assign(
    {
      filename
    },
    preprocessOptions
  )

  // Consolidate exposes a callback based API, but the callback is in fact
  // called synchronously for most templating engines. In our case, we have to
  // expose a synchronous API so that it is usable in Jest transforms (which
  // have to be sync because they are applied via Node.js require hooks)
  let res: any, err
  preprocessor.render(
    source,
    finalPreprocessOptions,
    (_err: Error | null, _res: string) => {
      if (_err) err = _err
      res = _res
    }
  )

  if (err) throw err
  return res
}