Registry / devops / vue-template-compiler-plugin

vue-template-compiler-plugin

JSON →
library2.7.21jsnpmunverified

An API-compatible fork of vue-template-compiler 2.7.x that includes postinstall hooks. It is used as a drop-in replacement to work around resolution issues in certain environments. Stable version is 2.7.21, matching Vue 2.7.x. Key differentiator: it allows overriding vue-template-compiler resolution via npm overrides or resolve.alias without breaking vue-loader compatibility. Ships TypeScript types.

devops
npm install vue-template-compiler-plugin
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · VUE-TEMPLATE-COMPI
V
vue-template-compiler-plugin
devopsjavascriptv2.7.21
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

compile
✓ import { compile } from 'vue-template-compiler-plugin'
✗ const compile = require('vue-template-compiler-plugin').compile
ESM import works; CJS require is also supported but ESM is preferred.
compileToFunctions
✓ import { compileToFunctions } from 'vue-template-compiler-plugin'
✗ import compileToFunctions from 'vue-template-compiler'
Named export, not default. Ensure using the correct package name.
ssrCompile
✓ import { ssrCompile } from 'vue-template-compiler-plugin'
✗ import { compile } from 'vue-template-compiler-plugin' for SSR
SSR compilation has separate export; don't use compile for SSR.
default
✓ import compiler from 'vue-template-compiler-plugin'
✗ const { default: compiler } = require('vue-template-compiler-plugin')
Default export is the whole compiler object with methods attached.

Compiles a Vue template to a render function and mounts an app using the compiled render.

import { compile } from 'vue-template-compiler-plugin'; import { createApp } from 'vue'; const template = '<div>{{ message }}</div>'; const compiled = compile(template); const render = new Function(compiled.render); const app = createApp({ data() { return { message: 'Hello Vue!' } }, render }); app.mount('#app');
Debug
Known issues
breakingVue 3 not supported; this package is for Vue 2 only.
fix
Use @vue/compiler-sfc for Vue 3 projects.
affects: >=3.0
deprecatedvue-template-compiler-plugin is a fork of the deprecated vue-template-compiler package.
fix
Use vue-template-compiler-plugin instead of vue-template-compiler to avoid resolution issues.
affects: >=2.7.0
gotchaMust use npm overrides or resolve.alias to point vue-loader's vue-template-compiler resolution to this package.
fix
Add 'overrides': { 'vue-template-compiler': 'vue-template-compiler-plugin' } in package.json
affects: *
gotchaWith syntax not supported in strict mode; render functions generated use 'with' statements.
fix
Use compileToFunctions instead of compile to get strict-mode compliant functions.
affects: *
Errors
Common errors & fixes
Cannot find module 'vue-template-compiler'
vue-loader resolves vue-template-compiler but package is replaced by vue-template-compiler-plugin
fix
Add npm override: 'overrides': { 'vue-template-compiler': 'vue-template-compiler-plugin' }
Module not found: Error: Can't resolve 'vue-template-compiler'
Webpack resolve alias not configured
fix
Add resolve.alias: { 'vue-template-compiler': 'vue-template-compiler-plugin' } in webpack config
TypeError: compiler.compile is not a function
Importing default export as a function instead of using named exports
fix
Use named import: import { compile } from 'vue-template-compiler-plugin'
Upgrade
Version history
2.7.21latest on npm
Audit
Dependencies
vuerequiredPeer dependency required to compile Vue 2.x templates
Agent activity
4 hits · last 30 days
node
4
Resources
githubhttps://github.com/vuejs/vue ↗
packagevue-template-compiler-plugin ↗
homepagehttps://github.com/vuejs/vue/tree/dev/packages/vue-template-compiler#readme ↗
vue-template-compiler-plugin — npm install vue-template-compiler-plugin · libregistry