Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

plugins.ts

76 lines2.2 KB

1import type { Module } from 'yuku-analyzer'
2import type {
3 Expression,
4 Node,
5 ObjectExpression,
6 ObjectProperty,
7 Program,
8 ProgramStatement,
9} from '@yuku-toolchain/types'
10import type { Config, DeletableNodes, HmrStyle } from '../config'
11import type { CodeSplitGroupings } from '../constants'
12import type { SplitNodeMeta } from './types'
13​
14export type CompileCodeSplitReferenceRouteOptions = {
15 codeSplitGroupings: CodeSplitGroupings
16 deleteNodes?: Set<DeletableNodes>
17 targetFramework: Config['target']
18 filename: string
19 id: string
20 addHmr?: boolean
21 hmrStyle?: HmrStyle
22 hmrRouteId?: string
23 sharedBindings?: Set<string>
25​
26export type ReferenceRouteCompilerPluginContext = {
27 program: Program
28 module: Module
29 originalNodes: WeakMap<Node, Node>
30 insertBefore: (nodes: Array<ProgramStatement>) => void
31 renameBinding: (node: Node, name: string) => void
32 routeOptions: ObjectExpression
33 createRouteFn: string
34 opts: CompileCodeSplitReferenceRouteOptions
36​
37export type ReferenceRouteSplitPropertyCompilerPluginContext =
38 ReferenceRouteCompilerPluginContext & {
39 prop: ObjectProperty
40 splitNodeMeta: SplitNodeMeta
41 lazyRouteComponentIdent: string
42 opts: CompileCodeSplitReferenceRouteOptions
43 }
44​
45export type ReferenceRouteCompilerPluginResult = {
46 modified?: boolean
48​
49export type VirtualRouteSplitNodeCompilerPluginContext = {
50 program: Program
51 renameBinding: (node: Node, name: string) => void
52 splitNode: Node
53 splitNodeMeta: SplitNodeMeta
55​
56export type CodeSplitCompilerPlugin = {
57 name: string
58 getStableRouteOptionKeys?: () => Array<string>
59 onRouteOptions?: (
60 ctx: ReferenceRouteCompilerPluginContext,
61 ) => void | ReferenceRouteCompilerPluginResult
62 onAddHmr?: (
63 ctx: ReferenceRouteCompilerPluginContext,
64 ) => void | ReferenceRouteCompilerPluginResult
65 onUnsplittableRoute?: (
66 ctx: ReferenceRouteCompilerPluginContext,
67 ) => void | ReferenceRouteCompilerPluginResult
68 onSplitRouteProperty?: (
69 ctx: ReferenceRouteSplitPropertyCompilerPluginContext,
70 ) => void | Expression
71 onVirtualRouteSplitNode?: (
72 ctx: VirtualRouteSplitNodeCompilerPluginContext,
73 ) => void
75​
76export type ReferenceRouteCompilerPlugin = CodeSplitCompilerPlugin