ss2vue

1.1.0 verified Fri May 01 auth: no javascript

Converts Snakeskin templates into Vue 2 render functions. Stable version 1.1.0. Low release cadence. Differentiator: tight integration with Snakeskin template engine, supports adapter options for vue-template-compiler and optional ES2015 transpilation via vue-template-es2015-compiler.

Common errors

error Cannot find module 'snakeskin' ↓

cause Missing peer dependency

fix

Run: npm install snakeskin

error TypeError: ss2vue.compile is not a function ↓

cause Wrong import style (e.g., import default instead of named)

fix

Use: const { compile } = require('ss2vue')

error Error: Cannot find module 'vue-template-es2015-compiler' ↓

cause Optional peer dependency not installed when transpiler: true

fix

Run: npm install vue-template-es2015-compiler or set transpiler: false

Warnings

gotcha The package requires Node.js >= 4, but Vue 2 templates may need transpiler for older environments. ↓

fix Set adapterOptions.transpiler: true to enable transpilation via vue-template-es2015-compiler.

deprecated vue-template-es2015-compiler is deprecated; consider transpiling separately. ↓

fix Use a modern transpiler like Babel instead of relying on this peer dependency.

gotcha The compile function expects Snakeskin template syntax, not plain HTML. ↓

fix Ensure input is valid Snakeskin format; consult Snakeskin documentation.

Install

npm install ss2vue

yarn add ss2vue

pnpm add ss2vue

Imports

default
wrong
```
const ss2vue = require('ss2vue')
```
correct
```
import ss2vue from 'ss2vue'
```
Package does not export a named function; use default import or require.
compile
wrong
```
import compile from 'ss2vue/compile'
```
correct
```
import { compile } from 'ss2vue'
```
compile is a named export, not a default. Ensure using destructuring.
AdapterOptions
wrong
```
import AdapterOptions from 'ss2vue'
```
correct
```
import { AdapterOptions } from 'ss2vue'
```
AdapterOptions is a type export for TypeScript users; not available as default.

Quickstart

Demonstrates converting a Snakeskin template into a Vue 2 render function using ss2vue.compile.

const ss2vue = require('ss2vue');
const snake = require('snakeskin');

const template = '<div>{name}</div>';
const compiled = ss2vue.compile(template, {
  adapterOptions: { transpiler: false }
});
console.log(compiled.render.toString());