VueSSRServerPlugin Class — vue Architecture
Architecture documentation for the VueSSRServerPlugin class in server.ts from the vue codebase.
Entity Profile
Dependency Diagram
graph TD e36c9e55_f0f7_f114_a58b_ccdd13b9e292["VueSSRServerPlugin"] cd8987ca_a5b9_5c1b_a002_527ecdd456bf["server.ts"] e36c9e55_f0f7_f114_a58b_ccdd13b9e292 -->|defined in| cd8987ca_a5b9_5c1b_a002_527ecdd456bf 0800f107_6de1_f71b_8937_6c3629085615["constructor()"] e36c9e55_f0f7_f114_a58b_ccdd13b9e292 -->|method| 0800f107_6de1_f71b_8937_6c3629085615 dbfa2018_ca28_4a7e_bd4e_3f2e5fcb1d8a["apply()"] e36c9e55_f0f7_f114_a58b_ccdd13b9e292 -->|method| dbfa2018_ca28_4a7e_bd4e_3f2e5fcb1d8a
Relationship Graph
Source Code
packages/server-renderer/src/webpack-plugin/server.ts lines 3–74
export default class VueSSRServerPlugin {
constructor(options = {}) {
//@ts-expect-error
this.options = Object.assign(
{
filename: 'vue-ssr-server-bundle.json'
},
options
)
}
apply(compiler) {
validate(compiler)
const stage = 'PROCESS_ASSETS_STAGE_OPTIMIZE_TRANSFER'
onEmit(compiler, 'vue-server-plugin', stage, (compilation, cb) => {
const stats = compilation.getStats().toJson()
const entryName = Object.keys(stats.entrypoints)[0]
const entryInfo = stats.entrypoints[entryName]
if (!entryInfo) {
// #5553
return cb()
}
const entryAssets = entryInfo.assets.map(getAssetName).filter(isJS)
if (entryAssets.length > 1) {
throw new Error(
`Server-side bundle should have one single entry file. ` +
`Avoid using CommonsChunkPlugin in the server config.`
)
}
const entry = entryAssets[0]
if (!entry || typeof entry !== 'string') {
throw new Error(
`Entry "${entryName}" not found. Did you specify the correct entry option?`
)
}
const bundle = {
entry,
files: {},
maps: {}
}
Object.keys(compilation.assets).forEach(name => {
if (isJS(name)) {
bundle.files[name] = compilation.assets[name].source()
} else if (name.match(/\.js\.map$/)) {
bundle.maps[name.replace(/\.map$/, '')] = JSON.parse(
compilation.assets[name].source()
)
}
// do not emit anything else for server
delete compilation.assets[name]
})
const json = JSON.stringify(bundle, null, 2)
//@ts-expect-error
const filename = this.options.filename
compilation.assets[filename] = {
source: () => json,
size: () => json.length
}
cb()
})
}
}
Domain
Source
Frequently Asked Questions
What is the VueSSRServerPlugin class?
VueSSRServerPlugin is a class in the vue codebase, defined in packages/server-renderer/src/webpack-plugin/server.ts.
Where is VueSSRServerPlugin defined?
VueSSRServerPlugin is defined in packages/server-renderer/src/webpack-plugin/server.ts at line 3.
Analyze Your Own Codebase
Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.
Try Supermodel Free