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 | 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 38x 8x 35x 35x 35x 35x 35x 26x 22x 27x 26x 8x 60x 60x 60x 168x 5x 60x 9x 2x 2x 1x 1x 60x 58x 60x 59x 60x 60x 60x 60x 60x 60x 60x 60x 2x 3x 60x 22x 20x 20x 20x 5x 5x 1x 5x 9x 9x 9x 225x 5x 220x 32x 188x 108x 80x 10x 10x 10x 72x 72x 132x 132x 132x 60x 77x 60x 10x 5x 85x 218x 106x 112x 11x 11x 101x 2x 99x 2x 97x 2x 112x 112x 119x 119x 71x 48x 48x 57x 22x 35x 71x 71x 17x 17x 7x 10x 6x 4x 4x 54x 52x 52x 2x 9x 6x 6x 9x 15x 14x 8x 8x 7x 1x 1x 1x 6x 6x 2x 4x 1x 3x 1x 2x 2x 1x 1x 1x 1x 1x 14x 11x 11x 11x 11x 11x 8x 5x 5x 4x 4x 5x 9x 9x 9x 6x 3x 1x 1x 2x 1x 1x 1x 8x 7x 7x 7x 7x 4x 3x 18x 4x 5x 1x 4x 18x 5x 1x 4x 4x 211x 91x 91x 68x 4x 64x 64x 6x 6x 2x 2x 2x 4x 58x 7x 2x 2x 5x 51x 87x 120x 60x 4x 2x 2x 2x 60x 56x 1601x 1601x 28x 28x 28x 18x 28x 1573x 1x 1x 1x 1x 1x 1572x 6x 6x 6x 1566x 5x 1561x 582x 582x 171x 171x 211x 87x 1470x 138x 138x 138x 2x 136x 32x 32x 32x 13x 13x 67x 67x 11x 11x 56x 2x 136x 136x 1570x 1570x 34x 34x 1570x 28x 50x 122x 122x 8x 8x 60x 60x | import { Node, Identifier, BlockStatement, CallExpression, ObjectPattern, ArrayPattern, Program, VariableDeclarator, Expression, VariableDeclaration, ImportDeclaration, ImportSpecifier, ImportDefaultSpecifier, ImportNamespaceSpecifier } from '@babel/types' import MagicString, { SourceMap } from 'magic-string' import { walk } from 'estree-walker' import { extractIdentifiers, isFunctionType, isInDestructureAssignment, isReferencedIdentifier, isStaticProperty, walkFunctionParams } from '@vue/compiler-core' import { parse, ParserPlugin } from '@babel/parser' import { hasOwn, isArray, isString, genPropsAccessExp } from '@vue/shared' const CONVERT_SYMBOL = '$' const ESCAPE_SYMBOL = '$$' const IMPORT_SOURCE = 'vue/macros' const shorthands = ['ref', 'computed', 'shallowRef', 'toRef', 'customRef'] const transformCheckRE = /[^\w]\$(?:\$|ref|computed|shallowRef)?\s*(\(|\<)/ export function shouldTransform(src: string): boolean { return transformCheckRE.test(src) } interface Binding { isConst?: boolean isProp?: boolean } type Scope = Record<string, Binding | false> export interface RefTransformOptions { filename?: string sourceMap?: boolean parserPlugins?: ParserPlugin[] importHelpersFrom?: string } export interface RefTransformResults { code: string map: SourceMap | null rootRefs: string[] importedHelpers: string[] } export interface ImportBinding { local: string imported: string source: string specifier: ImportSpecifier | ImportDefaultSpecifier | ImportNamespaceSpecifier } export function transform( src: string, { filename, sourceMap, parserPlugins, importHelpersFrom = 'vue' }: RefTransformOptions = {} ): RefTransformResults { const plugins: ParserPlugin[] = parserPlugins || [] Iif (filename) { Iif (/\.tsx?$/.test(filename)) { plugins.push('typescript') } Iif (filename.endsWith('x')) { plugins.push('jsx') } } const ast = parse(src, { sourceType: 'module', plugins }) const s = new MagicString(src) const res = transformAST(ast.program, s, 0) // inject helper imports if (res.importedHelpers.length) { s.prepend( `import { ${res.importedHelpers .map(h => `${h} as _${h}`) .join(', ')} } from '${importHelpersFrom}'\n` ) } return { ...res, code: s.toString(), map: sourceMap ? s.generateMap({ source: filename, hires: true, includeContent: true }) : null } } export function transformAST( ast: Program, s: MagicString, offset = 0, knownRefs?: string[], knownProps?: Record< string, // public prop key { local: string // local identifier, may be different default?: any isConst?: boolean } > ): { rootRefs: string[] importedHelpers: string[] } { // TODO remove when out of experimental warnExperimental() const userImports: Record<string, ImportBinding> = Object.create(null) for (const node of ast.body) { if (node.type !== 'ImportDeclaration') continue walkImportDeclaration(node) } // macro import handling let convertSymbol: string | undefined let escapeSymbol: string | undefined for (const { local, imported, source, specifier } of Object.values( userImports )) { if (source === IMPORT_SOURCE) { Iif (imported === ESCAPE_SYMBOL) { escapeSymbol = local } else if (imported === CONVERT_SYMBOL) { convertSymbol = local } else Iif (imported !== local) { error( `macro imports for ref-creating methods do not support aliasing.`, specifier ) } } } // default symbol if (!convertSymbol && !userImports[CONVERT_SYMBOL]) { convertSymbol = CONVERT_SYMBOL } if (!escapeSymbol && !userImports[ESCAPE_SYMBOL]) { escapeSymbol = ESCAPE_SYMBOL } const importedHelpers = new Set<string>() const rootScope: Scope = {} const scopeStack: Scope[] = [rootScope] let currentScope: Scope = rootScope let escapeScope: CallExpression | undefined // inside $$() const excludedIds = new WeakSet<Identifier>() const parentStack: Node[] = [] const propsLocalToPublicMap: Record<string, string> = Object.create(null) if (knownRefs) { for (const key of knownRefs) { rootScope[key] = {} } } if (knownProps) { for (const key in knownProps) { const { local, isConst } = knownProps[key] rootScope[local] = { isProp: true, isConst: !!isConst } propsLocalToPublicMap[local] = key } } function walkImportDeclaration(node: ImportDeclaration) { const source = node.source.value if (source === IMPORT_SOURCE) { s.remove(node.start! + offset, node.end! + offset) } for (const specifier of node.specifiers) { const local = specifier.local.name const imported = (specifier.type === 'ImportSpecifier' && specifier.imported.type === 'Identifier' && specifier.imported.name) || 'default' userImports[local] = { source, local, imported, specifier } } } function isRefCreationCall(callee: string): string | false { if (!convertSymbol || currentScope[convertSymbol] !== undefined) { return false } if (callee === convertSymbol) { return convertSymbol } if (callee[0] === '$' && shorthands.includes(callee.slice(1))) { return callee } return false } function error(msg: string, node: Node): never { const e = new Error(msg) ;(e as any).node = node throw e } function helper(msg: string) { importedHelpers.add(msg) return `_${msg}` } function registerBinding(id: Identifier, binding?: Binding) { excludedIds.add(id) if (currentScope) { currentScope[id.name] = binding ? binding : false } else E{ error( 'registerBinding called without active scope, something is wrong.', id ) } } const registerRefBinding = (id: Identifier, isConst = false) => registerBinding(id, { isConst }) let tempVarCount = 0 function genTempVar() { return `__$temp_${++tempVarCount}` } function snip(node: Node) { return s.original.slice(node.start! + offset, node.end! + offset) } function walkScope(node: Program | BlockStatement, isRoot = false) { for (const stmt of node.body) { if (stmt.type === 'VariableDeclaration') { walkVariableDeclaration(stmt, isRoot) } else if ( stmt.type === 'FunctionDeclaration' || stmt.type === 'ClassDeclaration' ) { Iif (stmt.declare || !stmt.id) continue registerBinding(stmt.id) } else if ( (stmt.type === 'ForOfStatement' || stmt.type === 'ForInStatement') && stmt.left.type === 'VariableDeclaration' ) { walkVariableDeclaration(stmt.left) } else if ( stmt.type === 'ExportNamedDeclaration' && stmt.declaration && stmt.declaration.type === 'VariableDeclaration' ) { walkVariableDeclaration(stmt.declaration, isRoot) } else if ( stmt.type === 'LabeledStatement' && stmt.body.type === 'VariableDeclaration' ) { walkVariableDeclaration(stmt.body, isRoot) } } } function walkVariableDeclaration(stmt: VariableDeclaration, isRoot = false) { Iif (stmt.declare) { return } for (const decl of stmt.declarations) { let refCall const isCall = decl.init && decl.init.type === 'CallExpression' && decl.init.callee.type === 'Identifier' if ( isCall && (refCall = isRefCreationCall((decl as any).init.callee.name)) ) { processRefDeclaration( refCall, decl.id, decl.init as CallExpression, stmt.kind === 'const' ) } else { const isProps = isRoot && isCall && (decl as any).init.callee.name === 'defineProps' for (const id of extractIdentifiers(decl.id)) { if (isProps) { // for defineProps destructure, only exclude them since they // are already passed in as knownProps excludedIds.add(id) } else { registerBinding(id) } } } } } function processRefDeclaration( method: string, id: VariableDeclarator['id'], call: CallExpression, isConst: boolean ) { excludedIds.add(call.callee as Identifier) if (method === convertSymbol) { // $ // remove macro s.remove(call.callee.start! + offset, call.callee.end! + offset) if (id.type === 'Identifier') { // single variable registerRefBinding(id, isConst) } else if (id.type === 'ObjectPattern') { processRefObjectPattern(id, call, isConst) } else if (id.type === 'ArrayPattern') { processRefArrayPattern(id, call, isConst) } } else { // shorthands if (id.type === 'Identifier') { registerRefBinding(id, isConst) // replace call s.overwrite( call.start! + offset, call.start! + method.length + offset, helper(method.slice(1)) ) } else { error(`${method}() cannot be used with destructure patterns.`, call) } } } function processRefObjectPattern( pattern: ObjectPattern, call: CallExpression, isConst: boolean, tempVar?: string, path: PathSegment[] = [] ) { if (!tempVar) { tempVar = genTempVar() // const { x } = $(useFoo()) --> const __$temp_1 = useFoo() s.overwrite(pattern.start! + offset, pattern.end! + offset, tempVar) } let nameId: Identifier | undefined for (const p of pattern.properties) { let key: Expression | string | undefined let defaultValue: Expression | undefined if (p.type === 'ObjectProperty') { if (p.key.start! === p.value.start!) { // shorthand { foo } nameId = p.key as Identifier if (p.value.type === 'Identifier') { // avoid shorthand value identifier from being processed excludedIds.add(p.value) } else if ( p.value.type === 'AssignmentPattern' && p.value.left.type === 'Identifier' ) { // { foo = 1 } excludedIds.add(p.value.left) defaultValue = p.value.right } } else { key = p.computed ? p.key : (p.key as Identifier).name if (p.value.type === 'Identifier') { // { foo: bar } nameId = p.value } else if (p.value.type === 'ObjectPattern') { processRefObjectPattern(p.value, call, isConst, tempVar, [ ...path, key ]) } else if (p.value.type === 'ArrayPattern') { processRefArrayPattern(p.value, call, isConst, tempVar, [ ...path, key ]) } else if (p.value.type === 'AssignmentPattern') { if (p.value.left.type === 'Identifier') { // { foo: bar = 1 } nameId = p.value.left defaultValue = p.value.right } else if (p.value.left.type === 'ObjectPattern') { processRefObjectPattern(p.value.left, call, isConst, tempVar, [ ...path, [key, p.value.right] ]) } else Eif (p.value.left.type === 'ArrayPattern') { processRefArrayPattern(p.value.left, call, isConst, tempVar, [ ...path, [key, p.value.right] ]) } else { // MemberExpression case is not possible here, ignore } } } } else { // rest element { ...foo } error(`reactivity destructure does not support rest elements.`, p) } if (nameId) { registerRefBinding(nameId, isConst) // inject toRef() after original replaced pattern const source = pathToString(tempVar, path) const keyStr = isString(key) ? `'${key}'` : key ? snip(key) : `'${nameId.name}'` const defaultStr = defaultValue ? `, ${snip(defaultValue)}` : `` s.appendLeft( call.end! + offset, `,\n ${nameId.name} = ${helper( 'toRef' )}(${source}, ${keyStr}${defaultStr})` ) } } if (nameId) { s.appendLeft(call.end! + offset, ';') } } function processRefArrayPattern( pattern: ArrayPattern, call: CallExpression, isConst: boolean, tempVar?: string, path: PathSegment[] = [] ) { if (!tempVar) { // const [x] = $(useFoo()) --> const __$temp_1 = useFoo() tempVar = genTempVar() s.overwrite(pattern.start! + offset, pattern.end! + offset, tempVar) } let nameId: Identifier | undefined for (let i = 0; i < pattern.elements.length; i++) { const e = pattern.elements[i] Iif (!e) continue let defaultValue: Expression | undefined if (e.type === 'Identifier') { // [a] --> [__a] nameId = e } else if (e.type === 'AssignmentPattern') { // [a = 1] nameId = e.left as Identifier defaultValue = e.right } else if (e.type === 'RestElement') { // [...a] error(`reactivity destructure does not support rest elements.`, e) } else if (e.type === 'ObjectPattern') { processRefObjectPattern(e, call, isConst, tempVar, [...path, i]) } else IEif (e.type === 'ArrayPattern') { processRefArrayPattern(e, call, isConst, tempVar, [...path, i]) } if (nameId) { registerRefBinding(nameId, isConst) // inject toRef() after original replaced pattern const source = pathToString(tempVar, path) const defaultStr = defaultValue ? `, ${snip(defaultValue)}` : `` s.appendLeft( call.end! + offset, `,\n ${nameId.name} = ${helper( 'toRef' )}(${source}, ${i}${defaultStr})` ) } } if (nameId) { s.appendLeft(call.end! + offset, ';') } } type PathSegmentAtom = Expression | string | number type PathSegment = | PathSegmentAtom | [PathSegmentAtom, Expression /* default value */] function pathToString(source: string, path: PathSegment[]): string { if (path.length) { for (const seg of path) { if (isArray(seg)) { source = `(${source}${segToString(seg[0])} || ${snip(seg[1])})` } else { source += segToString(seg) } } } return source } function segToString(seg: PathSegmentAtom): string { if (typeof seg === 'number') { return `[${seg}]` } else if (typeof seg === 'string') { return `.${seg}` } else E{ return snip(seg) } } function rewriteId( scope: Scope, id: Identifier, parent: Node, parentStack: Node[] ): boolean { if (hasOwn(scope, id.name)) { const binding = scope[id.name] if (binding) { if ( binding.isConst && ((parent.type === 'AssignmentExpression' && id === parent.left) || parent.type === 'UpdateExpression') ) { error(`Assignment to constant variable.`, id) } const { isProp } = binding if (isStaticProperty(parent) && parent.shorthand) { // let binding used in a property shorthand // skip for destructure patterns if ( !(parent as any).inPattern || isInDestructureAssignment(parent, parentStack) ) { if (isProp) { if (escapeScope) { // prop binding in $$() // { prop } -> { prop: __props_prop } registerEscapedPropBinding(id) s.appendLeft( id.end! + offset, `: __props_${propsLocalToPublicMap[id.name]}` ) } else E{ // { prop } -> { prop: __props.prop } s.appendLeft( id.end! + offset, `: ${genPropsAccessExp(propsLocalToPublicMap[id.name])}` ) } } else { // { foo } -> { foo: foo.value } s.appendLeft(id.end! + offset, `: ${id.name}.value`) } } } else { if (isProp) { if (escapeScope) { // x --> __props_x registerEscapedPropBinding(id) s.overwrite( id.start! + offset, id.end! + offset, `__props_${propsLocalToPublicMap[id.name]}` ) } else { // x --> __props.x s.overwrite( id.start! + offset, id.end! + offset, genPropsAccessExp(propsLocalToPublicMap[id.name]) ) } } else { // x --> x.value s.appendLeft(id.end! + offset, '.value') } } } return true } return false } const propBindingRefs: Record<string, true> = {} function registerEscapedPropBinding(id: Identifier) { if (!propBindingRefs.hasOwnProperty(id.name)) { propBindingRefs[id.name] = true const publicKey = propsLocalToPublicMap[id.name] s.prependRight( offset, `const __props_${publicKey} = ${helper( `toRef` )}(__props, '${publicKey}');\n` ) } } // check root scope first walkScope(ast, true) ;(walk as any)(ast, { enter(node: Node, parent?: Node) { parent && parentStack.push(parent) // function scopes if (isFunctionType(node)) { scopeStack.push((currentScope = {})) walkFunctionParams(node, registerBinding) if (node.body.type === 'BlockStatement') { walkScope(node.body) } return } // catch param if (node.type === 'CatchClause') { scopeStack.push((currentScope = {})) if (node.param && node.param.type === 'Identifier') { registerBinding(node.param) } walkScope(node.body) return } // non-function block scopes if (node.type === 'BlockStatement' && !isFunctionType(parent!)) { scopeStack.push((currentScope = {})) walkScope(node) return } // skip type nodes if ( parent && parent.type.startsWith('TS') && parent.type !== 'TSAsExpression' && parent.type !== 'TSNonNullExpression' && parent.type !== 'TSTypeAssertion' ) { return this.skip() } if (node.type === 'Identifier') { const binding = rootScope[node.name] if ( // if inside $$(), skip unless this is a destructured prop binding !(escapeScope && (!binding || !binding.isProp)) && isReferencedIdentifier(node, parent!, parentStack) && !excludedIds.has(node) ) { // walk up the scope chain to check if id should be appended .value let i = scopeStack.length while (i--) { if (rewriteId(scopeStack[i], node, parent!, parentStack)) { return } } } } if (node.type === 'CallExpression' && node.callee.type === 'Identifier') { const callee = node.callee.name const refCall = isRefCreationCall(callee) if (refCall && (!parent || parent.type !== 'VariableDeclarator')) { return error( `${refCall} can only be used as the initializer of ` + `a variable declaration.`, node ) } if ( escapeSymbol && currentScope[escapeSymbol] === undefined && callee === escapeSymbol ) { escapeScope = node s.remove(node.callee.start! + offset, node.callee.end! + offset) if (parent?.type === 'ExpressionStatement') { // edge case where the call expression is an expression statement // if its own - prepend semicolon to avoid it being parsed as // function invocation of previous line let i = (node.leadingComments ? node.leadingComments[0].start : node.start)! + offset while (i--) { const char = s.original.charAt(i) if (char === '\n') { // only insert semi if it's actually the fisrt thign after // newline s.prependRight(node.start! + offset, ';') break } else if (!/\s/.test(char)) { break } } } } // TODO remove when out of experimental Iif (callee === '$raw') { error( `$raw() has been replaced by $$(). ` + `See ${RFC_LINK} for latest updates.`, node ) } Iif (callee === '$fromRef') { error( `$fromRef() has been replaced by $(). ` + `See ${RFC_LINK} for latest updates.`, node ) } } }, leave(node: Node, parent?: Node) { parent && parentStack.pop() if ( (node.type === 'BlockStatement' && !isFunctionType(parent!)) || isFunctionType(node) ) { scopeStack.pop() currentScope = scopeStack[scopeStack.length - 1] || null } if (node === escapeScope) { escapeScope = undefined } } }) return { rootRefs: Object.keys(rootScope).filter(key => { const binding = rootScope[key] return binding && !binding.isProp }), importedHelpers: [...importedHelpers] } } const RFC_LINK = `https://github.com/vuejs/rfcs/discussions/369` const hasWarned: Record<string, boolean> = {} function warnExperimental() { // eslint-disable-next-line if (typeof window !== 'undefined') { return } warnOnce( `Reactivity transform is an experimental feature.\n` + `Experimental features may change behavior between patch versions.\n` + `It is recommended to pin your vue dependencies to exact versions to avoid breakage.\n` + `You can follow the proposal's status at ${RFC_LINK}.` ) } function warnOnce(msg: string) { const isNodeProd = typeof process !== 'undefined' && process.env.NODE_ENV === 'production' Iif (!isNodeProd && !__TEST__ && !hasWarned[msg]) { hasWarned[msg] = true warn(msg) } } function warn(msg: string) { console.warn( `\x1b[1m\x1b[33m[@vue/reactivity-transform]\x1b[0m\x1b[33m ${msg}\x1b[0m\n` ) } |