JSPM

vue-sfc-descriptor-to-string

3.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 48651
  • Score
    100M100P100Q158356F
  • License MIT

Convert SFCDescriptor to source

Package Exports

  • vue-sfc-descriptor-to-string
  • vue-sfc-descriptor-to-string/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vue-sfc-descriptor-to-string) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

vue-sfc-descriptor-to-string

Convert SFCDescriptor to source

Install

npm install vue-sfc-descriptor-to-string

Usage

// parse an sfc
const compiler = require('vue-template-compiler');
const sfcDescriptor = compiler.parseComponent(sfcSource);

// convert sfc descriptor back to source
const toString = require('vue-sfc-descriptor-to-string');
const result = toString(sfcDescriptor);

result == sfcSource // => true, but see caveats below

API

const toString = require('vue-sfc-descriptor-to-string');

toString(SFCDescriptor, options)

SFCDescriptor

Object that looks like an SFCDescriptor

options

Optional object, defaults to {}

options.indents

Optional object that can have a property for each sfc block name (e.g. template). Values are the number of spaces to indent that block's content.

Defaults to

{
  template: 0,
  script: 0,
  style: 0
}

Caveats

This module isn't a true inverse of compiler.parseComponent() because it doesn't always produce the exact same sfc compared to what was parsed. It assumes the parsed sfc

  • ends with a single newline
  • has a single space before each attribute on <script>, <template>, <style>
  • other stuff

License

MIT