Skip to content

fix(define-stylex): fix unwanted code hoist #987

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 20, 2025
Merged

fix(define-stylex): fix unwanted code hoist #987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6bdd4d8
test(define-stylex): add fixture
BeiyanYunyi Aug 19, 2025
c8aaba2
fix(define-stylex): do not hoist other declarations
BeiyanYunyi Aug 19, 2025
0da6031
chore(define-stylex): format
BeiyanYunyi Aug 20, 2025
5591257
test(define-stylex): improve test case, fix cspell
BeiyanYunyi Aug 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 20 additions & 17 deletions packages/define-stylex/src/core/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import {
type NodeTransform,
type NodeTypes,
} from '@vue/compiler-dom'
import type { Node } from '@babel/types'
import type { CallExpression, Node } from '@babel/types'

const STYLEX_CREATE = '_stylex_create'
const STYLEX_PROPS = '_stylex_props'
Expand Down Expand Up @@ -67,33 +67,36 @@ export function transformDefineStyleX(
const { scriptSetup, getSetupAst, template } = sfc
if (!scriptSetup || !template) return

let scriptOffset: number | undefined
const setupOffset = scriptSetup.loc.start.offset

const s = new MagicStringAST(code)
const normalScript = addNormalScript(sfc, s)

function moveToScript(decl: Node, prefix: 'const ' | '' = '') {
if (scriptOffset === undefined) scriptOffset = normalScript.start()

const text = `\n${prefix}${s.sliceNode(decl, { offset: setupOffset })}`
s.appendRight(scriptOffset, text)

s.removeNode(decl, { offset: setupOffset })
}
const scriptOffset = normalScript.start()

const setupAST = getSetupAst()!

walkAST<Node>(setupAST, {
enter(node) {
if (node.type !== 'VariableDeclaration') return
const shouldChange = node.declarations.some((decl) =>
isCallOf(decl.init, DEFINE_STYLEX),
)
if (!shouldChange) return

node.declarations.forEach((decl) => {
if (!isCallOf(decl.init, DEFINE_STYLEX)) return
s.overwriteNode(decl.init.callee, STYLEX_CREATE, {
offset: setupOffset,
})
const isDefineStyleX = isCallOf(decl.init, DEFINE_STYLEX)
if (isDefineStyleX) {
s.overwriteNode((decl.init as CallExpression).callee, STYLEX_CREATE, {
offset: setupOffset,
})
}
const text = `\n${node.kind} ${s.sliceNode(decl, { offset: setupOffset })}`
s.appendRight(
isDefineStyleX ? scriptOffset : node.start! + setupOffset - 1,
text,
)
})
moveToScript(node)
s.removeNode(node, { offset: setupOffset })
},
})

Expand All @@ -104,7 +107,7 @@ export function transformDefineStyleX(
})
traverseNode(template.ast!, ctx)

s.appendRight(
s.appendLeft(
setupOffset,
`\nimport { create as ${STYLEX_CREATE}, props as ${STYLEX_PROPS} } from '@stylexjs/stylex'`,
)
Expand Down
44 changes: 44 additions & 0 deletions packages/define-stylex/tests/__snapshots__/fixtures.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,26 @@ import { create as _stylex_create, props as _stylex_props } from '@stylexjs/styl
"
`;

exports[`fixtures > ./fixtures/multiple-statements.vue 1`] = `
"<script lang="ts">
const stylesA = _stylex_create({ redBold: { color: 'red', fontWeight: 'bold' } })
const stylesB = _stylex_create({ redBold: { color: 'red', fontWeight: 'bold' } })
</script>
<script setup lang="ts">
import { create as _stylex_create, props as _stylex_props } from '@stylexjs/stylex'
const a = 'a'

</script>

<template>
<p>
<span v-bind="_stylex_props(stylesA.redBold)">Red</span>
<span v-bind="_stylex_props(stylesB.redBold)">{{ a }}</span>
</p>
</template>
"
`;

exports[`fixtures > ./fixtures/optional-rules.vue 1`] = `
"<script lang="ts">
const styles = _stylex_create({
Expand All @@ -51,3 +71,27 @@ defineProps<{ bold?: boolean }>()
</template>
"
`;

exports[`fixtures > ./fixtures/other-statements.vue 1`] = `
"<script lang="ts">
const styles = _stylex_create({ redBold: { color: 'red', fontWeight: 'bold' } })
</script>
<script setup lang="ts">
import { create as _stylex_create, props as _stylex_props } from '@stylexjs/stylex'
// separated declarations before
const a = 'a'
// multiple declarations
const b = 'b'
const c = 'c'

// separated declarations after
const d = 'd'
</script>

<template>
<p>
<span v-bind="_stylex_props(styles.redBold)">Red</span> {{ a }} {{ b }} {{ c }} {{ d }}
</p>
</template>
"
`;
12 changes: 12 additions & 0 deletions packages/define-stylex/tests/fixtures/multiple-statements.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<script setup lang="ts">
const a = 'a'
const stylesA = defineStyleX({ redBold: { color: 'red', fontWeight: 'bold' } }),
stylesB = defineStyleX({ redBold: { color: 'red', fontWeight: 'bold' } })
</script>

<template>
<p>
<span v-stylex="stylesA.redBold">Red</span>
<span v-stylex="stylesB.redBold">{{ a }}</span>
</p>
</template>
16 changes: 16 additions & 0 deletions packages/define-stylex/tests/fixtures/other-statements.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<script setup lang="ts">
// separated declarations before
const a = 'a'
// multiple declarations
const b = 'b',
styles = defineStyleX({ redBold: { color: 'red', fontWeight: 'bold' } }),
c = 'c'
// separated declarations after
const d = 'd'
</script>

<template>
<p>
<span v-stylex="styles.redBold">Red</span> {{ a }} {{ b }} {{ c }} {{ d }}
</p>
</template>
Loading