fix(compiler-sfc): fix import usage detection for names containing $

fix #4274
vuejs · Aug 9, 2021 · 88a4504 · 88a4504
1 parent 4781965
commit 88a4504
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 8 deletions.
diff --git a/packages/compiler-sfc/__tests__/__snapshots__/compileScript.spec.ts.snap b/packages/compiler-sfc/__tests__/__snapshots__/compileScript.spec.ts.snap
@@ -206,15 +206,15 @@ return { x }
 
 exports[`SFC compile <script setup> imports imports not used in <template> should not be exposed 1`] = `
 "import { defineComponent as _defineComponent } from 'vue'
-import { FooBar, FooBaz, FooQux, vMyDir, x, y, z } from './x'
+import { FooBar, FooBaz, FooQux, vMyDir, x, y, z, x$y } from './x'
         
 export default _defineComponent({
   setup(__props, { expose }) {
   expose()
 
         const fooBar: FooBar = 1
         
-return { fooBar, FooBaz, FooQux, vMyDir, x, z }
+return { fooBar, FooBaz, FooQux, vMyDir, x, z, x$y }
 }
 
 })"

diff --git a/packages/compiler-sfc/__tests__/compileScript.spec.ts b/packages/compiler-sfc/__tests__/compileScript.spec.ts
@@ -213,11 +213,11 @@ defineExpose({ foo: 123 })
     test('imports not used in <template> should not be exposed', () => {
       const { content } = compile(`
         <script setup lang="ts">
-        import { FooBar, FooBaz, FooQux, vMyDir, x, y, z } from './x'
+        import { FooBar, FooBaz, FooQux, vMyDir, x, y, z, x$y } from './x'
         const fooBar: FooBar = 1
         </script>
         <template>
-          <FooBaz v-my-dir>{{ x }} {{ yy }}</FooBaz>
+          <FooBaz v-my-dir>{{ x }} {{ yy }} {{ x$y }}</FooBaz>
           <foo-qux/>
           <div :id="z + 'y'">FooBar</div>
         </template>
@@ -229,7 +229,10 @@ defineExpose({ foo: 123 })
       // vMyDir: used as directive v-my-dir
       // x: used in interpolation
       // y: should not be matched by {{ yy }} or 'y' in binding exps
-      expect(content).toMatch(`return { fooBar, FooBaz, FooQux, vMyDir, x, z }`)
+      // x$y: #4274 should escape special chars when creating Regex
+      expect(content).toMatch(
+        `return { fooBar, FooBaz, FooQux, vMyDir, x, z, x$y }`
+      )
     })
   })
 

diff --git a/packages/compiler-sfc/src/compileScript.ts b/packages/compiler-sfc/src/compileScript.ts
@@ -332,9 +332,11 @@ export function compileScript(
 
     let isUsedInTemplate = true
     if (isTS && sfc.template && !sfc.template.src) {
-      isUsedInTemplate = new RegExp(`\\b${local}\\b`).test(
-        resolveTemplateUsageCheckString(sfc)
-      )
+      isUsedInTemplate = new RegExp(
+        // #4274 escape $ since it's a special char in regex
+        // (and is the only regex special char that is valid in identifiers)
+        `[^\\w$_]${local.replace(/\$/g, '\\$')}[^\\w$_]`
+      ).test(resolveTemplateUsageCheckString(sfc))
     }
 
     userImports[local] = {