feat: expose more options

Author: antfu

jest.js

@@ -4,6 +4,7 @@ const { transform } = require('./dist/index')
 module.exports = {
   process(source, filename, ...args) {
     const transformed = transform(source, filename)
-    return require('vue-jest').process.call(this, transformed.code, filename, ...args)
+    const code = transformed ? transformed.code : source
+    return require('vue-jest').process.call(this, code, filename, ...args)
   },
 }

playground/main.ts

@@ -1,10 +1,8 @@
 import Vue from 'vue'
-import VueComposisionAPI from '@vue/composition-api'
+import VueCompositionAPI from '@vue/composition-api'
 import App from './App.vue'
 
-Vue.use(VueComposisionAPI)
+Vue.use(VueCompositionAPI)
 
-const app = new Vue({
-  render: h => h(App),
-})
+const app = new Vue({ render: h => h(App) })
 app.$mount('#app')

pnpm-lock.yaml

@@ -0,0 +1,14 @@
+import { ScriptSetupTransformOptions, ResolvedOptions } from '../types'
+
+export function resolveOptions(options: ScriptSetupTransformOptions = {}): ResolvedOptions {
+  return Object.assign(
+    {},
+    {
+      sourceMap: true,
+      refTransform: false,
+      importHelpersFrom: '@vue/composition-api',
+      astTransforms: {},
+    },
+    options,
+  )
+}

src/core/options.ts

@@ -1,44 +1,45 @@
 import MagicString from 'magic-string'
 import { shouldTransform as shouldTransformRefSugar, transform as transformRef } from '@vue/ref-transform'
-import { ScriptSetupTransformOptions, TransformResult } from '../types'
+import { ResolvedOptions, ScriptSetupTransformOptions, TransformResult } from '../types'
 import { parseSFC } from './parseSFC'
 import { transformScriptSetup } from './transformScriptSetup'
 import { transformSfcRefSugar } from './transformSfcRefSugar'
+import { resolveOptions } from './options'
 
-export const importHelpersFrom = '@vue/composition-api'
 const scriptSetupRE = /<script\s(.*\s)?setup(\s.*)?>/
 
 export function shouldTransform(code: string, id: string, options?: ScriptSetupTransformOptions): boolean {
-  if (options?.refTransform)
-    return true
-  return scriptSetupRE.test(code)
+  return (options?.refTransform && shouldTransformRefSugar(code)) || scriptSetupRE.test(code)
 }
 
 export function transform(input: string, id: string, options?: ScriptSetupTransformOptions): TransformResult {
+  if (!shouldTransform(input, id, options))
+    return null
+  const resolved = resolveOptions(options)
   if (!id.endsWith('.vue'))
-    return transformNonVue(input, id, options)
+    return transformNonVue(input, id, resolved)
   else
-    return transformVue(input, id, options)
+    return transformVue(input, id, resolved)
 }
 
-export function transformNonVue(input: string, id: string, options: ScriptSetupTransformOptions | undefined): TransformResult {
-  if (options?.refTransform && shouldTransformRefSugar(input)) {
+function transformNonVue(input: string, id: string, options: ResolvedOptions): TransformResult {
+  if (options.refTransform && shouldTransformRefSugar(input)) {
     return transformRef(input, {
       filename: id,
-      sourceMap: true,
-      importHelpersFrom,
+      sourceMap: options.sourceMap,
+      importHelpersFrom: options.importHelpersFrom,
     })
   }
   return null
 }
 
-export function transformVue(input: string, id: string, options: ScriptSetupTransformOptions | undefined): TransformResult {
+function transformVue(input: string, id: string, options: ResolvedOptions): TransformResult {
   const s = new MagicString(input)
 
   const sfc = parseSFC(input, id)
 
   if (options?.refTransform)
-    transformSfcRefSugar(sfc)
+    transformSfcRefSugar(sfc, options)
 
   const { code } = transformScriptSetup(sfc, options)
 
@@ -68,6 +69,8 @@ export function transformVue(input: string, id: string, options: ScriptSetupTran
   }
   return {
     code: s.toString(),
-    get map() { return s.generateMap() },
+    map: options.sourceMap
+      ? s.generateMap()
+      : null,
   }
 }

src/core/transform.ts

@@ -2,10 +2,9 @@ import { shouldTransform, transformAST } from '@vue/ref-transform'
 import MagicString from 'magic-string'
 import { parse } from '@babel/parser'
 import { types as t } from '@babel/core'
-import type { ParsedSFC } from '../types'
-import { importHelpersFrom } from './transform'
+import type { ParsedSFC, ResolvedOptions } from '../types'
 
-export function transformSfcRefSugar(sfc: ParsedSFC) {
+export function transformSfcRefSugar(sfc: ParsedSFC, options: ResolvedOptions) {
   const importedHelpers = new Set<string>()
 
   for (const script of [sfc.script, sfc.scriptSetup]) {
@@ -22,7 +21,7 @@ export function transformSfcRefSugar(sfc: ParsedSFC) {
     sfc.extraDeclarations = [
       t.importDeclaration(
         Array.from(importedHelpers).map(i => t.importSpecifier(t.identifier(`_${i}`), t.identifier(i))),
-        t.stringLiteral(importHelpersFrom),
+        t.stringLiteral(options.importHelpersFrom),
       ),
     ]
   }

src/core/transformSfcRefSugar.ts

@@ -1,7 +1,7 @@
 import { createUnplugin } from 'unplugin'
 import { createFilter } from '@rollup/pluginutils'
 import { PluginOptions } from './types'
-import { transform, shouldTransform } from './core'
+import { transform } from './core'
 
 export * from './core'
 export * from './types'
@@ -20,8 +20,7 @@ export default createUnplugin<PluginOptions>((options = {}) => {
     },
     transform(code, id) {
       try {
-        if (shouldTransform(code, id, options))
-          return transform(code, id, options)
+        return transform(code, id, options)
       }
       catch (e) {
         this.error(e)

src/index.ts

@@ -1,6 +1,7 @@
 import type { ParserOptions } from '@babel/parser'
 import type { Program, Node } from '@babel/types'
 import type { FilterPattern } from '@rollup/pluginutils'
+import type { SourceMap } from 'rollup'
 
 export interface ScriptTagMeta {
   start: number
@@ -32,14 +33,18 @@ export interface ScriptSetupTransformOptions {
     post?: (ast: Program, sfc: ParsedSFC) => Program
   }
   refTransform?: boolean
+  importHelpersFrom?: string
+  sourceMap?: boolean
 }
 
 export interface PluginOptions extends ScriptSetupTransformOptions {
   include?: FilterPattern
   exclude?: FilterPattern
 }
 
+export type ResolvedOptions = Required<ScriptSetupTransformOptions>
+
 export type TransformResult = {
   code: string
-  readonly map: any
+  readonly map: SourceMap | null
 } | null

src/types.ts

@@ -294,15 +294,12 @@ export default __sfc_main;
 
 exports[`transform fixture ScriptOnly.vue 1`] = `
 "<script lang=\\"ts\\">
-import { defineComponent } from '@vue/composition-api';
+import { defineComponent } from '@vue/composition-api'
 
-const __sfc_main = defineComponent({
-  name: 'Hi'
-});
-
-export default __sfc_main;
+export default defineComponent({
+  name: 'Hi',
+})
 </script>
-
 "
 `;
 

test/__snapshots__/transform.test.ts.snap

@@ -14,7 +14,7 @@ describe('transform', () => {
     for (const file of files) {
       it(file, async() => {
         const fixture = await fs.readFile(resolve(root, file), 'utf-8')
-        expect(transform(fixture, file)?.code).toMatchSnapshot()
+        expect(transform(fixture, file)?.code || fixture).toMatchSnapshot()
       })
     }
   })
@@ -31,7 +31,7 @@ describe('transform', () => {
         const warn = jest.spyOn(console, 'warn').mockImplementation(() => {})
 
         const fixture = await fs.readFile(resolve(root, file), 'utf-8')
-        expect(transform(fixture, file, { refTransform: true })?.code).toMatchSnapshot()
+        expect(transform(fixture, file, { refTransform: true })?.code || fixture).toMatchSnapshot()
 
         warn.mockRestore()
       })