vue-sfc-descriptor-write-back

A lightweight utility to parse Vue Single-File Components (SFC) and write modified SFCDescriptor back to the original source code, preserving non-block content (comments, whitespace) and maintaining correct offset positions.

Features

- Parse Vue SFC files into SFCDescriptor (powered by @vue/compiler-sfc)
- Write modified SFCDescriptor back to the original source code
- Preserve non-block content (comments, whitespace outside template/script/style)
- Efficiently update only changed blocks using offset-based overwrites (via MagicString)
- Type-safe API with full TypeScript support

Installation

``shell


pnpm (recommended)

`ts
import fs from 'node:fs'
import { parse, writeBack } from 'vue-sfc-descriptor-write-back'

const parseResult = parse('./src/MyComponent.vue')
const { errors, descriptor, code } = parseResult
if (errors.length > 0) {
console.error('SFC parsing errors:', errors)
process.exit(1)
}

if (descriptor.template) {
descriptor.template.content =

if (hasChanged) {
fs.writeFileSync(filename, resolvedCode, 'utf-8')
console.log(Successfully updated ${filename})
}
`

Options

- ParseOptions
- disableCache (boolean, default: true): Whether to disable caching of @vue/compiler-sfc parse`.

Acknowledgements

- vue-sfc-descriptor-to-string
- @vue/compiler-sfc

License

MIT