Press n or j to go to the next uncovered block, b, p or k for the previous block.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 250x 250x 250x 250x 250x 250x 250x 250x 250x 250x 250x 250x 20x 20x 20x 250x 1x 1x 1x 1x 250x 228x 228x 228x 228x 228x 228x 228x 250x 250x 250x 137x 137x 137x 1x 1x 1x 1x 137x 1052x 137x 137x 915x 915x 137x 137x 250x 106x 106x 106x 106x 106x 106x 106x 106x 106x 106x 85x 55x 46x 46x 106x 46x 46x 106x 106x 106x 106x 106x 106x 106x 106x 106x 250x 1015x 87x 62x 62x 4x 4x 4x 4x 4x 87x 1015x 250x 250x 250x 25x 39x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 39x 25x 250x 411x 73x 73x 73x 3x 3x 3x 3x 3x 3x 3x 3x 1x 2x 3x 3x 73x 105x 105x 105x 105x 105x 105x 1x 1x 1x 1x 1x 1x 105x 2x 2x 2x 104x 102x 102x 102x 102x 102x 101x 91x 102x 102x 102x 102x 105x 73x 2x 2x 73x 411x 228x 250x 106x 106x 106x 250x 25x 39x 12x 12x 12x 10x 10x 2x 2x 1x 2x 1x 1x 12x 11x 6x 6x 5x 5x 6x 3x 3x 6x 6x 6x 6x 6x 6x 11x 12x 12x 12x 39x 10x 10x 1x 10x 10x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 10x 9x 9x 9x 9x 9x 9x 9x 9x 10x 17x 11x 9x 8x 11x 17x 11x 11x 11x 11x 11x 11x 11x 11x 39x 25x 6x 6x 6x 6x 6x 25x 250x 411x 82x 82x 82x 55x 48x 34x 82x 36x 48x 2x 2x 2x 2x 2x 2x 33x 31x 31x 82x 411x 204x 204x 204x 204x 211x 211x 211x 211x 211x 211x 2x 2x 2x 207x 211x 211x 188x 186x 211x 211x 46x 44x 211x 26x 22x 26x 4x 4x 4x 1x 4x 3x 3x 4x 4x 4x 211x 19x 19x 19x 19x 19x 181x 162x 162x 211x 211x 200x 394x 394x 394x 194x 188x 186x 216x 411x 216x 216x 216x 216x 216x 216x 216x 216x 216x 411x 36x 36x 394x 411x 194x 411x 274x 274x 274x 2819x 38x 38x 2819x 16x 16x 2819x 35x 35x 35x 55x 55x 34x 28x 35x 35x 35x 35x 35x 35x 35x 35x 2819x 274x 274x 274x 394x 411x 392x 391x 411x 3x 3x 3x 3x 3x 411x 154x 154x 124x 6x 118x 154x 36x 28x 28x 36x 154x 411x 250x 28x 28x 202x 202x 202x 202x 202x 250x 23x 12x 12x 22x 250x 25x 6x 6x 6x 25x 19x 19x 19x 19x 250x 173x 173x 173x 250x 25x 25x 198x 198x 250x 102x 100x 100x 98x 95x 26x 74x 102x 250x 18x 18x 229x 197x 197x 250x 198x 198x 10x 250x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 198x 250x 33x 33x 240x 39x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 39x 18x 18x 18x 18x 18x 18x 39x 250x 13x 13x 13x 198x 219x 155x 43x 250x 19x 19x 236x 156x 156x 198x 198x 198x 44x 250x 154x 154x 154x 154x 154x 85x 85x 83x 85x 65x 65x 85x 154x 154x 205x 205x 65x 54x 205x 54x 204x 11x 11x 11x 11x 151x 140x 140x 205x 154x 250x 44x 17x 1x 1x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 1x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 6x 6x 17x 44x 27x 27x 44x 250x 250x 198x 198x 198x 5x 193x 250x 250x 3x 3x 3x 3x 3x 250x 1x 1x 198x 248x 197x 248x 196x 250x 1x 1x 1x 1x 196x 250x 250x 89x 89x 89x 89x 89x 89x 89x 89x 89x 89x 89x 89x 250x 107x 12x 12x 12x 12x 12x 12x 12x 12x 107x 95x 95x 95x 95x 95x 95x 95x 107x 250x 120x 120x 120x 1x 119x 120x 120x 120x 120x 120x 120x 196x 196x 196x 196x 196x 196x 196x 196x 196x 196x 196x 196x 250x 250x 250x 250x 250x 196x 196x 196x 196x 196x 196x 196x 236x 236x 236x 236x 236x 236x 236x 236x 236x 236x 212x 212x 212x 183x 183x 183x 212x 219x 219x 219x 190x 190x 190x 116x 80x 61x 52x 190x 219x 185x 185x 185x 185x 173x 185x 46x 185x 1x 1x 1x 138x 101x 138x 61x 8x 53x 138x 50x 50x 50x 50x 47x 33x 32x 32x 32x 31x 50x 50x 36x 49x 14x 14x 77x 27x 27x 185x 219x 34x 28x 28x 6x 6x 33x 34x 219x 236x 11x 11x 11x 11x 10x 1x 11x 13x 5x 13x 11x 11x 236x 236x 8x 8x 8x 8x 8x 8x 8x 13x 13x 13x 13x 13x 13x 13x 8x 13x 13x 13x 13x 13x 13x 13x 11x 2x 9x 8x 1x 11x 13x 2x 2x 2x 13x 75x 75x 75x 75x 75x 75x 75x 75x 75x 75x 75x 75x 13x 75x 1x 1x 1x 1x 75x 61x 11x 11x 50x 75x 75x 290x 290x 290x 290x 1x 290x 290x 3x 290x 1x 1x 1x 1x 1x 290x 290x 6x 290x 290x 290x 290x 290x 290x 74x 290x 205x 205x | import { BindingTypes, UNREF, isFunctionType, unwrapTSNode, walkIdentifiers, } from '@vue/compiler-dom' import { DEFAULT_FILENAME, type SFCDescriptor, type SFCScriptBlock, } from './parse' import type { ParserPlugin } from '@babel/parser' import { generateCodeFrame } from '@vue/shared' import type { ArrayPattern, CallExpression, Declaration, ExportSpecifier, Identifier, Node, ObjectPattern, Statement, } from '@babel/types' import { walk } from 'estree-walker' import type { RawSourceMap } from 'source-map-js' import { normalScriptDefaultVar, processNormalScript, } from './script/normalScript' import { CSS_VARS_HELPER, genCssVarsCode } from './style/cssVars' import { type SFCTemplateCompileOptions, compileTemplate, } from './compileTemplate' import { warnOnce } from './warn' import { transformDestructuredProps } from './script/definePropsDestructure' import { ScriptCompileContext } from './script/context' import { DEFINE_PROPS, WITH_DEFAULTS, genRuntimeProps, processDefineProps, } from './script/defineProps' import { DEFINE_EMITS, genRuntimeEmits, processDefineEmits, } from './script/defineEmits' import { DEFINE_EXPOSE, processDefineExpose } from './script/defineExpose' import { DEFINE_OPTIONS, processDefineOptions } from './script/defineOptions' import { DEFINE_SLOTS, processDefineSlots } from './script/defineSlots' import { DEFINE_MODEL, processDefineModel } from './script/defineModel' import { getImportedName, isCallOf, isLiteralNode } from './script/utils' import { analyzeScriptBindings } from './script/analyzeScriptBindings' import { isImportUsed } from './script/importUsageCheck' import { processAwait } from './script/topLevelAwait' export interface SFCScriptCompileOptions { /** * Scope ID for prefixing injected CSS variables. * This must be consistent with the `id` passed to `compileStyle`. */ id: string /** * Production mode. Used to determine whether to generate hashed CSS variables */ isProd?: boolean /** * Enable/disable source map. Defaults to true. */ sourceMap?: boolean /** * https://babeljs.io/docs/en/babel-parser#plugins */ babelParserPlugins?: ParserPlugin[] /** * A list of files to parse for global types to be made available for type * resolving in SFC macros. The list must be fully resolved file system paths. */ globalTypeFiles?: string[] /** * Compile the template and inline the resulting render function * directly inside setup(). * - Only affects `<script setup>` * - This should only be used in production because it prevents the template * from being hot-reloaded separately from component state. */ inlineTemplate?: boolean /** * Generate the final component as a variable instead of default export. * This is useful in e.g. @vitejs/plugin-vue where the script needs to be * placed inside the main module. */ genDefaultAs?: string /** * Options for template compilation when inlining. Note these are options that * would normally be passed to `compiler-sfc`'s own `compileTemplate()`, not * options passed to `compiler-dom`. */ templateOptions?: Partial<SFCTemplateCompileOptions> /** * Hoist <script setup> static constants. * - Only enables when one `<script setup>` exists. * @default true */ hoistStatic?: boolean /** * Set to `false` to disable reactive destructure for `defineProps` (pre-3.5 * behavior), or set to `'error'` to throw hard error on props destructures. * @default true */ propsDestructure?: boolean | 'error' /** * File system access methods to be used when resolving types * imported in SFC macros. Defaults to ts.sys in Node.js, can be overwritten * to use a virtual file system for use in browsers (e.g. in REPLs) */ fs?: { fileExists(file: string): boolean readFile(file: string): string | undefined realpath?(file: string): string } /** * Transform Vue SFCs into custom elements. */ customElement?: boolean | ((filename: string) => boolean) } export interface ImportBinding { isType: boolean imported: string local: string source: string isFromSetup: boolean isUsedInTemplate: boolean } const MACROS = [ DEFINE_PROPS, DEFINE_EMITS, DEFINE_EXPOSE, DEFINE_OPTIONS, DEFINE_SLOTS, DEFINE_MODEL, WITH_DEFAULTS, ] /** * Compile `<script setup>` * It requires the whole SFC descriptor because we need to handle and merge * normal `<script>` + `<script setup>` if both are present. */ export function compileScript( sfc: SFCDescriptor, options: SFCScriptCompileOptions, ): SFCScriptBlock { if (!options.id) { warnOnce( `compileScript now requires passing the \`id\` option.\n` + `Upgrade your vite or vue-loader version for compatibility with ` + `the latest experimental proposals.`, ) } const ctx = new ScriptCompileContext(sfc, options) const { script, scriptSetup, source, filename } = sfc const hoistStatic = options.hoistStatic !== false && !script const scopeId = options.id ? options.id.replace(/^data-v-/, '') : '' const scriptLang = script && script.lang const scriptSetupLang = scriptSetup && scriptSetup.lang let refBindings: string[] | undefined if (!scriptSetup) { if (!script) { throw new Error(`[@vue/compiler-sfc] SFC contains no <script> tags.`) } // normal <script> only return processNormalScript(ctx, scopeId) } if (script && scriptLang !== scriptSetupLang) { throw new Error( `[@vue/compiler-sfc] <script> and <script setup> must have the same ` + `language type.`, ) } if (scriptSetupLang && !ctx.isJS && !ctx.isTS) { // do not process non js/ts script blocks return scriptSetup } // metadata that needs to be returned // const ctx.bindingMetadata: BindingMetadata = {} const scriptBindings: Record<string, BindingTypes> = Object.create(null) const setupBindings: Record<string, BindingTypes> = Object.create(null) let defaultExport: Node | undefined let hasAwait = false let hasInlinedSsrRenderFn = false // string offsets const startOffset = ctx.startOffset! const endOffset = ctx.endOffset! const scriptStartOffset = script && script.loc.start.offset const scriptEndOffset = script && script.loc.end.offset function hoistNode(node: Statement) { const start = node.start! + startOffset let end = node.end! + startOffset // locate comment if (node.trailingComments && node.trailingComments.length > 0) { const lastCommentNode = node.trailingComments[node.trailingComments.length - 1] end = lastCommentNode.end! + startOffset } // locate the end of whitespace between this statement and the next while (end <= source.length) { if (!/\s/.test(source.charAt(end))) { break } end++ } ctx.s.move(start, end, 0) } function registerUserImport( source: string, local: string, imported: string, isType: boolean, isFromSetup: boolean, needTemplateUsageCheck: boolean, ) { // template usage check is only needed in non-inline mode, so we can skip // the work if inlineTemplate is true. let isUsedInTemplate = needTemplateUsageCheck if ( needTemplateUsageCheck && ctx.isTS && sfc.template && !sfc.template.src && !sfc.template.lang ) { isUsedInTemplate = isImportUsed(local, sfc) } ctx.userImports[local] = { isType, imported, local, source, isFromSetup, isUsedInTemplate, } } function checkInvalidScopeReference(node: Node | undefined, method: string) { if (!node) return walkIdentifiers(node, id => { const binding = setupBindings[id.name] if (binding && binding !== BindingTypes.LITERAL_CONST) { ctx.error( `\`${method}()\` in <script setup> cannot reference locally ` + `declared variables because it will be hoisted outside of the ` + `setup() function. If your component options require initialization ` + `in the module scope, use a separate normal <script> to export ` + `the options instead.`, id, ) } }) } const scriptAst = ctx.scriptAst const scriptSetupAst = ctx.scriptSetupAst! // 1.1 walk import declarations of <script> if (scriptAst) { for (const node of scriptAst.body) { if (node.type === 'ImportDeclaration') { // record imports for dedupe for (const specifier of node.specifiers) { const imported = getImportedName(specifier) registerUserImport( node.source.value, specifier.local.name, imported, node.importKind === 'type' || (specifier.type === 'ImportSpecifier' && specifier.importKind === 'type'), false, !options.inlineTemplate, ) } } } } // 1.2 walk import declarations of <script setup> for (const node of scriptSetupAst.body) { if (node.type === 'ImportDeclaration') { // import declarations are moved to top hoistNode(node) // dedupe imports let removed = 0 const removeSpecifier = (i: number) => { const removeLeft = i > removed removed++ const current = node.specifiers[i] const next = node.specifiers[i + 1] ctx.s.remove( removeLeft ? node.specifiers[i - 1].end! + startOffset : current.start! + startOffset, next && !removeLeft ? next.start! + startOffset : current.end! + startOffset, ) } for (let i = 0; i < node.specifiers.length; i++) { const specifier = node.specifiers[i] const local = specifier.local.name const imported = getImportedName(specifier) const source = node.source.value const existing = ctx.userImports[local] if (source === 'vue' && MACROS.includes(imported)) { if (local === imported) { warnOnce( `\`${imported}\` is a compiler macro and no longer needs to be imported.`, ) } else { ctx.error( `\`${imported}\` is a compiler macro and cannot be aliased to ` + `a different name.`, specifier, ) } removeSpecifier(i) } else if (existing) { if (existing.source === source && existing.imported === imported) { // already imported in <script setup>, dedupe removeSpecifier(i) } else { ctx.error( `different imports aliased to same local name.`, specifier, ) } } else { registerUserImport( source, local, imported, node.importKind === 'type' || (specifier.type === 'ImportSpecifier' && specifier.importKind === 'type'), true, !options.inlineTemplate, ) } } if (node.specifiers.length && removed === node.specifiers.length) { ctx.s.remove(node.start! + startOffset, node.end! + startOffset) } } } // 1.3 resolve possible user import alias of `ref` and `reactive` const vueImportAliases: Record<string, string> = {} for (const key in ctx.userImports) { const { source, imported, local } = ctx.userImports[key] if (source === 'vue') vueImportAliases[imported] = local } // 2.1 process normal <script> body if (script && scriptAst) { for (const node of scriptAst.body) { if (node.type === 'ExportDefaultDeclaration') { // export default defaultExport = node // check if user has manually specified `name` or 'render` option in // export default // if has name, skip name inference // if has render and no template, generate return object instead of // empty render function (#4980) let optionProperties if (defaultExport.declaration.type === 'ObjectExpression') { optionProperties = defaultExport.declaration.properties } else if ( defaultExport.declaration.type === 'CallExpression' && defaultExport.declaration.arguments[0] && defaultExport.declaration.arguments[0].type === 'ObjectExpression' ) { optionProperties = defaultExport.declaration.arguments[0].properties } if (optionProperties) { for (const p of optionProperties) { if ( p.type === 'ObjectProperty' && p.key.type === 'Identifier' && p.key.name === 'name' ) { ctx.hasDefaultExportName = true } if ( (p.type === 'ObjectMethod' || p.type === 'ObjectProperty') && p.key.type === 'Identifier' && p.key.name === 'render' ) { // TODO warn when we provide a better way to do it? ctx.hasDefaultExportRender = true } } } // export default { ... } --> const __default__ = { ... } const start = node.start! + scriptStartOffset! const end = node.declaration.start! + scriptStartOffset! ctx.s.overwrite(start, end, `const ${normalScriptDefaultVar} = `) } else if (node.type === 'ExportNamedDeclaration') { const defaultSpecifier = node.specifiers.find( s => s.exported.type === 'Identifier' && s.exported.name === 'default', ) as ExportSpecifier if (defaultSpecifier) { defaultExport = node // 1. remove specifier if (node.specifiers.length > 1) { ctx.s.remove( defaultSpecifier.start! + scriptStartOffset!, defaultSpecifier.end! + scriptStartOffset!, ) } else { ctx.s.remove( node.start! + scriptStartOffset!, node.end! + scriptStartOffset!, ) } if (node.source) { // export { x as default } from './x' // rewrite to `import { x as __default__ } from './x'` and // add to top ctx.s.prepend( `import { ${defaultSpecifier.local.name} as ${normalScriptDefaultVar} } from '${node.source.value}'\n`, ) } else { // export { x as default } // rewrite to `const __default__ = x` and move to end ctx.s.appendLeft( scriptEndOffset!, `\nconst ${normalScriptDefaultVar} = ${defaultSpecifier.local.name}\n`, ) } } if (node.declaration) { walkDeclaration( 'script', node.declaration, scriptBindings, vueImportAliases, hoistStatic, ) } } else if ( (node.type === 'VariableDeclaration' || node.type === 'FunctionDeclaration' || node.type === 'ClassDeclaration' || node.type === 'TSEnumDeclaration') && !node.declare ) { walkDeclaration( 'script', node, scriptBindings, vueImportAliases, hoistStatic, ) } } // <script> after <script setup> // we need to move the block up so that `const __default__` is // declared before being used in the actual component definition if (scriptStartOffset! > startOffset) { // if content doesn't end with newline, add one if (!/\n$/.test(script.content.trim())) { ctx.s.appendLeft(scriptEndOffset!, `\n`) } ctx.s.move(scriptStartOffset!, scriptEndOffset!, 0) } } // 2.2 process <script setup> body for (const node of scriptSetupAst.body) { if (node.type === 'ExpressionStatement') { const expr = unwrapTSNode(node.expression) // process `defineProps` and `defineEmit(s)` calls if ( processDefineProps(ctx, expr) || processDefineEmits(ctx, expr) || processDefineOptions(ctx, expr) || processDefineSlots(ctx, expr) ) { ctx.s.remove(node.start! + startOffset, node.end! + startOffset) } else if (processDefineExpose(ctx, expr)) { // defineExpose({}) -> expose({}) const callee = (expr as CallExpression).callee ctx.s.overwrite( callee.start! + startOffset, callee.end! + startOffset, '__expose', ) } else { processDefineModel(ctx, expr) } } if (node.type === 'VariableDeclaration' && !node.declare) { const total = node.declarations.length let left = total let lastNonRemoved: number | undefined for (let i = 0; i < total; i++) { const decl = node.declarations[i] const init = decl.init && unwrapTSNode(decl.init) if (init) { if (processDefineOptions(ctx, init)) { ctx.error( `${DEFINE_OPTIONS}() has no returning value, it cannot be assigned.`, node, ) } // defineProps const isDefineProps = processDefineProps(ctx, init, decl.id) if (ctx.propsDestructureRestId) { setupBindings[ctx.propsDestructureRestId] = BindingTypes.SETUP_REACTIVE_CONST } // defineEmits const isDefineEmits = !isDefineProps && processDefineEmits(ctx, init, decl.id) !isDefineEmits && (processDefineSlots(ctx, init, decl.id) || processDefineModel(ctx, init, decl.id)) if ( isDefineProps && !ctx.propsDestructureRestId && ctx.propsDestructureDecl ) { if (left === 1) { ctx.s.remove(node.start! + startOffset, node.end! + startOffset) } else { let start = decl.start! + startOffset let end = decl.end! + startOffset if (i === total - 1) { // last one, locate the end of the last one that is not removed // if we arrive at this branch, there must have been a // non-removed decl before us, so lastNonRemoved is non-null. start = node.declarations[lastNonRemoved!].end! + startOffset } else { // not the last one, locate the start of the next end = node.declarations[i + 1].start! + startOffset } ctx.s.remove(start, end) left-- } } else if (isDefineEmits) { ctx.s.overwrite( startOffset + init.start!, startOffset + init.end!, '__emit', ) } else { lastNonRemoved = i } } } } let isAllLiteral = false // walk declarations to record declared bindings if ( (node.type === 'VariableDeclaration' || node.type === 'FunctionDeclaration' || node.type === 'ClassDeclaration' || node.type === 'TSEnumDeclaration') && !node.declare ) { isAllLiteral = walkDeclaration( 'scriptSetup', node, setupBindings, vueImportAliases, hoistStatic, !!ctx.propsDestructureDecl, ) } // hoist literal constants if (hoistStatic && isAllLiteral) { hoistNode(node) } // walk statements & named exports / variable declarations for top level // await if ( (node.type === 'VariableDeclaration' && !node.declare) || node.type.endsWith('Statement') ) { const scope: Statement[][] = [scriptSetupAst.body] walk(node, { enter(child: Node, parent: Node | null) { if (isFunctionType(child)) { this.skip() } if (child.type === 'BlockStatement') { scope.push(child.body) } if (child.type === 'AwaitExpression') { hasAwait = true // if the await expression is an expression statement and // - is in the root scope // - or is not the first statement in a nested block scope // then it needs a semicolon before the generated code. const currentScope = scope[scope.length - 1] const needsSemi = currentScope.some((n, i) => { return ( (scope.length === 1 || i > 0) && n.type === 'ExpressionStatement' && n.start === child.start ) }) processAwait( ctx, child, needsSemi, parent!.type === 'ExpressionStatement', ) } }, exit(node: Node) { if (node.type === 'BlockStatement') scope.pop() }, }) } if ( (node.type === 'ExportNamedDeclaration' && node.exportKind !== 'type') || node.type === 'ExportAllDeclaration' || node.type === 'ExportDefaultDeclaration' ) { ctx.error( `<script setup> cannot contain ES module exports. ` + `If you are using a previous version of <script setup>, please ` + `consult the updated RFC at https://github.com/vuejs/rfcs/pull/227.`, node, ) } if (ctx.isTS) { // move all Type declarations to outer scope if ( node.type.startsWith('TS') || (node.type === 'ExportNamedDeclaration' && node.exportKind === 'type') || (node.type === 'VariableDeclaration' && node.declare) ) { if (node.type !== 'TSEnumDeclaration') { hoistNode(node) } } } } // 3 props destructure transform if (ctx.propsDestructureDecl) { transformDestructuredProps(ctx, vueImportAliases) } // 4. check macro args to make sure it doesn't reference setup scope // variables checkInvalidScopeReference(ctx.propsRuntimeDecl, DEFINE_PROPS) checkInvalidScopeReference(ctx.propsRuntimeDefaults, DEFINE_PROPS) checkInvalidScopeReference(ctx.propsDestructureDecl, DEFINE_PROPS) checkInvalidScopeReference(ctx.emitsRuntimeDecl, DEFINE_EMITS) checkInvalidScopeReference(ctx.optionsRuntimeDecl, DEFINE_OPTIONS) for (const { runtimeOptionNodes } of Object.values(ctx.modelDecls)) { for (const node of runtimeOptionNodes) { checkInvalidScopeReference(node, DEFINE_MODEL) } } // 5. remove non-script content if (script) { if (startOffset < scriptStartOffset!) { // <script setup> before <script> ctx.s.remove(0, startOffset) ctx.s.remove(endOffset, scriptStartOffset!) ctx.s.remove(scriptEndOffset!, source.length) } else { // <script> before <script setup> ctx.s.remove(0, scriptStartOffset!) ctx.s.remove(scriptEndOffset!, startOffset) ctx.s.remove(endOffset, source.length) } } else { // only <script setup> ctx.s.remove(0, startOffset) ctx.s.remove(endOffset, source.length) } // 6. analyze binding metadata // `defineProps` & `defineModel` also register props bindings if (scriptAst) { Object.assign(ctx.bindingMetadata, analyzeScriptBindings(scriptAst.body)) } for (const [key, { isType, imported, source }] of Object.entries( ctx.userImports, )) { if (isType) continue ctx.bindingMetadata[key] = imported === '*' || (imported === 'default' && source.endsWith('.vue')) || source === 'vue' ? BindingTypes.SETUP_CONST : BindingTypes.SETUP_MAYBE_REF } for (const key in scriptBindings) { ctx.bindingMetadata[key] = scriptBindings[key] } for (const key in setupBindings) { ctx.bindingMetadata[key] = setupBindings[key] } // known ref bindings if (refBindings) { for (const key of refBindings) { ctx.bindingMetadata[key] = BindingTypes.SETUP_REF } } // 7. inject `useCssVars` calls if ( sfc.cssVars.length && // no need to do this when targeting SSR !options.templateOptions?.ssr ) { ctx.helperImports.add(CSS_VARS_HELPER) ctx.helperImports.add('unref') ctx.s.prependLeft( startOffset, `\n${genCssVarsCode( sfc.cssVars, ctx.bindingMetadata, scopeId, !!options.isProd, )}\n`, ) } // 8. finalize setup() argument signature let args = `__props` if (ctx.propsTypeDecl) { // mark as any and only cast on assignment // since the user defined complex types may be incompatible with the // inferred type from generated runtime declarations args += `: any` } // inject user assignment of props // we use a default __props so that template expressions referencing props // can use it directly if (ctx.propsDecl) { if (ctx.propsDestructureRestId) { ctx.s.overwrite( startOffset + ctx.propsCall!.start!, startOffset + ctx.propsCall!.end!, `${ctx.helper(`createPropsRestProxy`)}(__props, ${JSON.stringify( Object.keys(ctx.propsDestructuredBindings), )})`, ) ctx.s.overwrite( startOffset + ctx.propsDestructureDecl!.start!, startOffset + ctx.propsDestructureDecl!.end!, ctx.propsDestructureRestId, ) } else if (!ctx.propsDestructureDecl) { ctx.s.overwrite( startOffset + ctx.propsCall!.start!, startOffset + ctx.propsCall!.end!, '__props', ) } } // inject temp variables for async context preservation if (hasAwait) { const any = ctx.isTS ? `: any` : `` ctx.s.prependLeft(startOffset, `\nlet __temp${any}, __restore${any}\n`) } const destructureElements = ctx.hasDefineExposeCall || !options.inlineTemplate ? [`expose: __expose`] : [] if (ctx.emitDecl) { destructureElements.push(`emit: __emit`) } if (destructureElements.length) { args += `, { ${destructureElements.join(', ')} }` } // 9. generate return statement let returned if ( !options.inlineTemplate || (!sfc.template && ctx.hasDefaultExportRender) ) { // non-inline mode, or has manual render in normal <script> // return bindings from script and script setup const allBindings: Record<string, any> = { ...scriptBindings, ...setupBindings, } for (const key in ctx.userImports) { if ( !ctx.userImports[key].isType && ctx.userImports[key].isUsedInTemplate ) { allBindings[key] = true } } returned = `{ ` for (const key in allBindings) { if ( allBindings[key] === true && ctx.userImports[key].source !== 'vue' && !ctx.userImports[key].source.endsWith('.vue') ) { // generate getter for import bindings // skip vue imports since we know they will never change returned += `get ${key}() { return ${key} }, ` } else if (ctx.bindingMetadata[key] === BindingTypes.SETUP_LET) { // local let binding, also add setter const setArg = key === 'v' ? `_v` : `v` returned += `get ${key}() { return ${key} }, ` + `set ${key}(${setArg}) { ${key} = ${setArg} }, ` } else { returned += `${key}, ` } } returned = returned.replace(/, $/, '') + ` }` } else { // inline mode if (sfc.template && !sfc.template.src) { if (options.templateOptions && options.templateOptions.ssr) { hasInlinedSsrRenderFn = true } // inline render function mode - we are going to compile the template and // inline it right here const { code, ast, preamble, tips, errors } = compileTemplate({ filename, ast: sfc.template.ast, source: sfc.template.content, inMap: sfc.template.map, ...options.templateOptions, id: scopeId, scoped: sfc.styles.some(s => s.scoped), isProd: options.isProd, ssrCssVars: sfc.cssVars, compilerOptions: { ...(options.templateOptions && options.templateOptions.compilerOptions), inline: true, isTS: ctx.isTS, bindingMetadata: ctx.bindingMetadata, }, }) if (tips.length) { tips.forEach(warnOnce) } const err = errors[0] if (typeof err === 'string') { throw new Error(err) } else if (err) { if (err.loc) { err.message += `\n\n` + sfc.filename + '\n' + generateCodeFrame( source, err.loc.start.offset, err.loc.end.offset, ) + `\n` } throw err } if (preamble) { ctx.s.prepend(preamble) } // avoid duplicated unref import // as this may get injected by the render function preamble OR the // css vars codegen if (ast && ast.helpers.has(UNREF)) { ctx.helperImports.delete('unref') } returned = code } else { returned = `() => {}` } } if (!options.inlineTemplate && !__TEST__) { // in non-inline mode, the `__isScriptSetup: true` flag is used by // componentPublicInstance proxy to allow properties that start with $ or _ ctx.s.appendRight( endOffset, `\nconst __returned__ = ${returned}\n` + `Object.defineProperty(__returned__, '__isScriptSetup', { enumerable: false, value: true })\n` + `return __returned__` + `\n}\n\n`, ) } else { ctx.s.appendRight(endOffset, `\nreturn ${returned}\n}\n\n`) } // 10. finalize default export const genDefaultAs = options.genDefaultAs ? `const ${options.genDefaultAs} =` : `export default` let runtimeOptions = `` if (!ctx.hasDefaultExportName && filename && filename !== DEFAULT_FILENAME) { const match = filename.match(/([^/\\]+)\.\w+$/) if (match) { runtimeOptions += `\n __name: '${match[1]}',` } } if (hasInlinedSsrRenderFn) { runtimeOptions += `\n __ssrInlineRender: true,` } const propsDecl = genRuntimeProps(ctx) if (propsDecl) runtimeOptions += `\n props: ${propsDecl},` const emitsDecl = genRuntimeEmits(ctx) if (emitsDecl) runtimeOptions += `\n emits: ${emitsDecl},` let definedOptions = '' if (ctx.optionsRuntimeDecl) { definedOptions = scriptSetup.content .slice(ctx.optionsRuntimeDecl.start!, ctx.optionsRuntimeDecl.end!) .trim() } // <script setup> components are closed by default. If the user did not // explicitly call `defineExpose`, call expose() with no args. const exposeCall = ctx.hasDefineExposeCall || options.inlineTemplate ? `` : ` __expose();\n` // wrap setup code with function. if (ctx.isTS) { // for TS, make sure the exported type is still valid type with // correct props information // we have to use object spread for types to be merged properly // user's TS setting should compile it down to proper targets // export default defineComponent({ ...__default__, ... }) const def = (defaultExport ? `\n ...${normalScriptDefaultVar},` : ``) + (definedOptions ? `\n ...${definedOptions},` : '') ctx.s.prependLeft( startOffset, `\n${genDefaultAs} /*@__PURE__*/${ctx.helper( `defineComponent`, )}({${def}${runtimeOptions}\n ${ hasAwait ? `async ` : `` }setup(${args}) {\n${exposeCall}`, ) ctx.s.appendRight(endOffset, `})`) } else { if (defaultExport || definedOptions) { // without TS, can't rely on rest spread, so we use Object.assign // export default Object.assign(__default__, { ... }) ctx.s.prependLeft( startOffset, `\n${genDefaultAs} /*@__PURE__*/Object.assign(${ defaultExport ? `${normalScriptDefaultVar}, ` : '' }${definedOptions ? `${definedOptions}, ` : ''}{${runtimeOptions}\n ` + `${hasAwait ? `async ` : ``}setup(${args}) {\n${exposeCall}`, ) ctx.s.appendRight(endOffset, `})`) } else { ctx.s.prependLeft( startOffset, `\n${genDefaultAs} {${runtimeOptions}\n ` + `${hasAwait ? `async ` : ``}setup(${args}) {\n${exposeCall}`, ) ctx.s.appendRight(endOffset, `}`) } } // 11. finalize Vue helper imports if (ctx.helperImports.size > 0) { const runtimeModuleName = options.templateOptions?.compilerOptions?.runtimeModuleName const importSrc = runtimeModuleName ? JSON.stringify(runtimeModuleName) : `'vue'` ctx.s.prepend( `import { ${[...ctx.helperImports] .map(h => `${h} as _${h}`) .join(', ')} } from ${importSrc}\n`, ) } return { ...scriptSetup, bindings: ctx.bindingMetadata, imports: ctx.userImports, content: ctx.s.toString(), map: options.sourceMap !== false ? (ctx.s.generateMap({ source: filename, hires: true, includeContent: true, }) as unknown as RawSourceMap) : undefined, scriptAst: scriptAst?.body, scriptSetupAst: scriptSetupAst?.body, deps: ctx.deps ? [...ctx.deps] : undefined, } } function registerBinding( bindings: Record<string, BindingTypes>, node: Identifier, type: BindingTypes, ) { bindings[node.name] = type } function walkDeclaration( from: 'script' | 'scriptSetup', node: Declaration, bindings: Record<string, BindingTypes>, userImportAliases: Record<string, string>, hoistStatic: boolean, isPropsDestructureEnabled = false, ): boolean { let isAllLiteral = false if (node.type === 'VariableDeclaration') { const isConst = node.kind === 'const' isAllLiteral = isConst && node.declarations.every( decl => decl.id.type === 'Identifier' && isStaticNode(decl.init!), ) // export const foo = ... for (const { id, init: _init } of node.declarations) { const init = _init && unwrapTSNode(_init) const isConstMacroCall = isConst && isCallOf( init, c => c === DEFINE_PROPS || c === DEFINE_EMITS || c === WITH_DEFAULTS || c === DEFINE_SLOTS, ) if (id.type === 'Identifier') { let bindingType const userReactiveBinding = userImportAliases['reactive'] if ( (hoistStatic || from === 'script') && (isAllLiteral || (isConst && isStaticNode(init!))) ) { bindingType = BindingTypes.LITERAL_CONST } else if (isCallOf(init, userReactiveBinding)) { // treat reactive() calls as let since it's meant to be mutable bindingType = isConst ? BindingTypes.SETUP_REACTIVE_CONST : BindingTypes.SETUP_LET } else if ( // if a declaration is a const literal, we can mark it so that // the generated render fn code doesn't need to unref() it isConstMacroCall || (isConst && canNeverBeRef(init!, userReactiveBinding)) ) { bindingType = isCallOf(init, DEFINE_PROPS) ? BindingTypes.SETUP_REACTIVE_CONST : BindingTypes.SETUP_CONST } else if (isConst) { if ( isCallOf( init, m => m === userImportAliases['ref'] || m === userImportAliases['computed'] || m === userImportAliases['shallowRef'] || m === userImportAliases['customRef'] || m === userImportAliases['toRef'] || m === DEFINE_MODEL, ) ) { bindingType = BindingTypes.SETUP_REF } else { bindingType = BindingTypes.SETUP_MAYBE_REF } } else { bindingType = BindingTypes.SETUP_LET } registerBinding(bindings, id, bindingType) } else { if (isCallOf(init, DEFINE_PROPS) && isPropsDestructureEnabled) { continue } if (id.type === 'ObjectPattern') { walkObjectPattern(id, bindings, isConst, isConstMacroCall) } else if (id.type === 'ArrayPattern') { walkArrayPattern(id, bindings, isConst, isConstMacroCall) } } } } else if (node.type === 'TSEnumDeclaration') { isAllLiteral = node.members.every( member => !member.initializer || isStaticNode(member.initializer), ) bindings[node.id!.name] = isAllLiteral ? BindingTypes.LITERAL_CONST : BindingTypes.SETUP_CONST } else if ( node.type === 'FunctionDeclaration' || node.type === 'ClassDeclaration' ) { // export function foo() {} / export class Foo {} // export declarations must be named. bindings[node.id!.name] = BindingTypes.SETUP_CONST } return isAllLiteral } function walkObjectPattern( node: ObjectPattern, bindings: Record<string, BindingTypes>, isConst: boolean, isDefineCall = false, ) { for (const p of node.properties) { if (p.type === 'ObjectProperty') { if (p.key.type === 'Identifier' && p.key === p.value) { // shorthand: const { x } = ... const type = isDefineCall ? BindingTypes.SETUP_CONST : isConst ? BindingTypes.SETUP_MAYBE_REF : BindingTypes.SETUP_LET registerBinding(bindings, p.key, type) } else { walkPattern(p.value, bindings, isConst, isDefineCall) } } else { // ...rest // argument can only be identifier when destructuring const type = isConst ? BindingTypes.SETUP_CONST : BindingTypes.SETUP_LET registerBinding(bindings, p.argument as Identifier, type) } } } function walkArrayPattern( node: ArrayPattern, bindings: Record<string, BindingTypes>, isConst: boolean, isDefineCall = false, ) { for (const e of node.elements) { e && walkPattern(e, bindings, isConst, isDefineCall) } } function walkPattern( node: Node, bindings: Record<string, BindingTypes>, isConst: boolean, isDefineCall = false, ) { if (node.type === 'Identifier') { const type = isDefineCall ? BindingTypes.SETUP_CONST : isConst ? BindingTypes.SETUP_MAYBE_REF : BindingTypes.SETUP_LET registerBinding(bindings, node, type) } else if (node.type === 'RestElement') { // argument can only be identifier when destructuring const type = isConst ? BindingTypes.SETUP_CONST : BindingTypes.SETUP_LET registerBinding(bindings, node.argument as Identifier, type) } else if (node.type === 'ObjectPattern') { walkObjectPattern(node, bindings, isConst) } else if (node.type === 'ArrayPattern') { walkArrayPattern(node, bindings, isConst) } else if (node.type === 'AssignmentPattern') { if (node.left.type === 'Identifier') { const type = isDefineCall ? BindingTypes.SETUP_CONST : isConst ? BindingTypes.SETUP_MAYBE_REF : BindingTypes.SETUP_LET registerBinding(bindings, node.left, type) } else { walkPattern(node.left, bindings, isConst) } } } function canNeverBeRef(node: Node, userReactiveImport?: string): boolean { if (isCallOf(node, userReactiveImport)) { return true } switch (node.type) { case 'UnaryExpression': case 'BinaryExpression': case 'ArrayExpression': case 'ObjectExpression': case 'FunctionExpression': case 'ArrowFunctionExpression': case 'UpdateExpression': case 'ClassExpression': case 'TaggedTemplateExpression': return true case 'SequenceExpression': return canNeverBeRef( node.expressions[node.expressions.length - 1], userReactiveImport, ) default: if (isLiteralNode(node)) { return true } return false } } function isStaticNode(node: Node): boolean { node = unwrapTSNode(node) switch (node.type) { case 'UnaryExpression': // void 0, !true return isStaticNode(node.argument) case 'LogicalExpression': // 1 > 2 case 'BinaryExpression': // 1 + 2 return isStaticNode(node.left) && isStaticNode(node.right) case 'ConditionalExpression': { // 1 ? 2 : 3 return ( isStaticNode(node.test) && isStaticNode(node.consequent) && isStaticNode(node.alternate) ) } case 'SequenceExpression': // (1, 2) case 'TemplateLiteral': // `foo${1}` return node.expressions.every(expr => isStaticNode(expr)) case 'ParenthesizedExpression': // (1) return isStaticNode(node.expression) case 'StringLiteral': case 'NumericLiteral': case 'BooleanLiteral': case 'NullLiteral': case 'BigIntLiteral': return true } return false } |