Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
fix(compiler-sfc/reactivity-transform): fix edge case where normal sc…
…ript has ref macros but script setup does not
  • Loading branch information
yyx990803 committed Jan 21, 2022
1 parent a05b000 commit 4768f26
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 14 deletions.
Expand Up @@ -71,6 +71,23 @@ exports[`sfc ref transform usage in normal <script> 1`] = `
"
`;
exports[`sfc ref transform usage with normal <script> (has macro usage) + <script setup> (no macro usage) 1`] = `
"import { ref as _ref } from 'vue'
let data = _ref()
export default {
setup(__props, { expose }) {
expose();
console.log(data.value)
return { data }
}
}"
`;
exports[`sfc ref transform usage with normal <script> + <script setup> 1`] = `
"import { ref as _ref } from 'vue'
Expand Down
13 changes: 13 additions & 0 deletions packages/compiler-sfc/__tests__/compileScriptRefTransform.spec.ts
Expand Up @@ -146,6 +146,19 @@ describe('sfc ref transform', () => {
})
})

test('usage with normal <script> (has macro usage) + <script setup> (no macro usage)', () => {
const { content } = compileWithReactivityTransform(`
<script>
let data = $ref()
</script>
<script setup>
console.log(data)
</script>
`)
expect(content).toMatch(`console.log(data.value)`)
assertCode(content)
})

describe('errors', () => {
test('defineProps/Emit() referencing ref declarations', () => {
expect(() =>
Expand Down
29 changes: 15 additions & 14 deletions packages/compiler-sfc/src/compileScript.ts
Expand Up @@ -48,10 +48,7 @@ import { compileTemplate, SFCTemplateCompileOptions } from './compileTemplate'
import { warnOnce } from './warn'
import { rewriteDefault } from './rewriteDefault'
import { createCache } from './cache'
import {
shouldTransform as shouldTransformRef,
transformAST as transformRefAST
} from '@vue/reactivity-transform'
import { shouldTransform, transformAST } from '@vue/reactivity-transform'

// Special compiler macros
const DEFINE_PROPS = 'defineProps'
Expand Down Expand Up @@ -143,7 +140,7 @@ export function compileScript(
let { script, scriptSetup, source, filename } = sfc
// feature flags
// TODO remove support for deprecated options when out of experimental
const enableRefTransform =
const enableReactivityTransform =
!!options.reactivityTransform ||
!!options.refSugar ||
!!options.refTransform
Expand All @@ -170,6 +167,8 @@ export function compileScript(
scriptLang === 'tsx' ||
scriptSetupLang === 'ts' ||
scriptSetupLang === 'tsx'

// resolve parser plugins
const plugins: ParserPlugin[] = []
if (!isTS || scriptLang === 'tsx' || scriptSetupLang === 'tsx') {
plugins.push('jsx')
Expand All @@ -193,11 +192,11 @@ export function compileScript(
sourceType: 'module'
}).program
const bindings = analyzeScriptBindings(scriptAst.body)
if (enableRefTransform && shouldTransformRef(content)) {
if (enableReactivityTransform && shouldTransform(content)) {
const s = new MagicString(source)
const startOffset = script.loc.start.offset
const endOffset = script.loc.end.offset
const { importedHelpers } = transformRefAST(scriptAst, s, startOffset)
const { importedHelpers } = transformAST(scriptAst, s, startOffset)
if (importedHelpers.length) {
s.prepend(
`import { ${importedHelpers
Expand Down Expand Up @@ -862,14 +861,14 @@ export function compileScript(
}
}

// apply ref transform
if (enableRefTransform && shouldTransformRef(script.content)) {
const { rootRefs: rootVars, importedHelpers } = transformRefAST(
// apply reactivity transform
if (enableReactivityTransform && shouldTransform(script.content)) {
const { rootRefs, importedHelpers } = transformAST(
scriptAst,
s,
scriptStartOffset!
)
refBindings = rootVars
refBindings = rootRefs
for (const h of importedHelpers) {
helperImports.add(h)
}
Expand Down Expand Up @@ -1109,12 +1108,14 @@ export function compileScript(
}
}

// 3. Apply ref sugar transform
// 3. Apply reactivity transform
if (
(enableRefTransform && shouldTransformRef(scriptSetup.content)) ||
(enableReactivityTransform &&
// normal <script> had ref bindings that maybe used in <script setup>
(refBindings || shouldTransform(scriptSetup.content))) ||
propsDestructureDecl
) {
const { rootRefs, importedHelpers } = transformRefAST(
const { rootRefs, importedHelpers } = transformAST(
scriptSetupAst,
s,
startOffset,
Expand Down

0 comments on commit 4768f26

Please sign in to comment.