Repository navigation
Expand file tree
/
Copy pathtypes.ts
More file actions
432 lines (375 loc) · 10.1 KB
/
Copy pathtypes.ts
File metadata and controls
432 lines (375 loc) · 10.1 KB
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
import type MagicString from 'magic-string'
import type { ESMExport } from 'mlly'
import type { BuiltinPresetName } from './presets'
export type ModuleId = string
export type ImportName = string
export interface ImportCommon {
/** Module specifier to import from */
from: ModuleId
/**
* Priority of the import, if multiple imports have the same name, the one with the highest priority will be used
* @default 1
*/
priority?: number
/** If this import is disabled */
disabled?: boolean
/** Won't output import in declaration file if true */
dtsDisabled?: boolean
/** Import declaration type like const / var / enum */
declarationType?: ESMExport['declarationType']
/**
* Metadata of the import
*/
meta?: {
/** Short description of the import */
description?: string
/** URL to the documentation */
docsUrl?: string
/** Additional metadata */
[key: string]: any
}
/**
* If this import is a pure type import
*/
type?: boolean
/**
* Using this as the from when generating type declarations
*/
typeFrom?: ModuleId
}
export interface Import extends ImportCommon {
/** Import name to be detected */
name: ImportName
/** Import as this name */
as?: ImportName
/**
* With properties
*
* Ignored for CJS imports.
*/
with?: Record<string, string>
}
export type PresetImport = Omit<Import, 'from'> | ImportName | [name: ImportName, as?: ImportName, from?: ModuleId]
export interface InlinePreset extends ImportCommon {
imports: (PresetImport | InlinePreset)[]
}
/**
* Auto extract exports from a package for auto import
*/
export interface PackagePreset {
/**
* Name of the package
*/
package: string
/**
* Path of the importer
* @default process.cwd()
*/
url?: string
/**
* RegExp, string, or custom function to exclude names of the extracted imports
*/
ignore?: (string | RegExp | ((name: string) => boolean))[]
/**
* Use local cache if exits
* @default true
*/
cache?: boolean
}
export type Preset = InlinePreset | PackagePreset
export interface UnimportContext {
readonly version: string
options: Partial<UnimportOptions>
staticImports: Import[]
dynamicImports: Import[]
addons: Addon[]
getImports: () => Promise<Import[]>
getImportMap: () => Promise<Map<string, Import>>
getMetadata: () => UnimportMeta | undefined
modifyDynamicImports: (fn: (imports: Import[]) => Thenable<void | Import[]>) => Promise<void>
clearDynamicImports: () => void
replaceImports: (imports: UnimportOptions['imports']) => Promise<Import[]>
invalidate: () => void
resolveId: (id: string, parentId?: string) => Thenable<string | null | undefined | void>
}
export interface DetectImportResult {
s: MagicString
strippedCode: string
isCJSContext: boolean
matchedImports: Import[]
firstOccurrence: number
}
export interface Unimport {
readonly version: string
init: () => Promise<void>
clearDynamicImports: UnimportContext['clearDynamicImports']
getImportMap: UnimportContext['getImportMap']
getImports: UnimportContext['getImports']
getInternalContext: () => UnimportContext
getMetadata: UnimportContext['getMetadata']
modifyDynamicImports: UnimportContext['modifyDynamicImports']
generateTypeDeclarations: (options?: TypeDeclarationOptions) => Promise<string>
/**
* Get un-imported usages from code
*/
detectImports: (code: string | MagicString) => Promise<DetectImportResult>
/**
* Insert missing imports statements to code
*/
injectImports: (code: string | MagicString, id?: string, options?: InjectImportsOptions) => Promise<ImportInjectionResult>
scanImportsFromDir: (dir?: (string | ScanDir)[], options?: ScanDirExportsOptions) => Promise<Import[]>
scanImportsFromFile: (file: string, includeTypes?: boolean) => Promise<Import[]>
/**
* @deprecated
*/
toExports: (filepath?: string, includeTypes?: boolean) => Promise<string>
}
export interface InjectionUsageRecord {
import: Import
count: number
moduleIds: string[]
}
export interface UnimportMeta {
injectionsUsageMap: Map<string, InjectionUsageRecord>
/**
* @deprecated use `injectionsUsageMap` instead
*/
get injectionUsage(): Record<string, InjectionUsageRecord>
}
export interface AddonsOptions {
addons?: Addon[]
/**
* Enable auto import inside for Vue's <template>
*
* @default false
*/
vueTemplate?: boolean
/**
* Enable auto import directives for Vue's SFC.
*
* Library authors should include `meta.vueDirective: true` in the import metadata.
*
* When using a local directives folder, provide the `isDirective`
* callback to check if the import is a Vue directive.
*/
vueDirectives?: true | AddonVueDirectivesOptions
}
export interface AddonVueDirectivesOptions {
/**
* Checks if the import is a Vue directive.
*
* **NOTES**:
* - imports from a library should include `meta.vueDirective: true`.
* - this callback is only invoked for local directives (only when meta.vueDirective is not set).
*
* @param from The path of the import normalized.
* @param importEntry The import entry.
*/
isDirective?: (from: string, importEntry: Import) => boolean
}
export interface UnimportOptions extends Pick<InjectImportsOptions, 'injectAtEnd' | 'mergeExisting' | 'parser'> {
/**
* Auto import items
*/
imports: Import[]
/**
* Auto import preset
*/
presets: (Preset | BuiltinPresetName)[]
/**
* Custom warning function
* @default console.warn
*/
warn: (msg: string) => void
/**
* Custom debug log function
* @default console.log
*/
debugLog: (msg: string) => void
/**
* Unimport Addons.
* To use built-in addons, use:
* ```js
* addons: {
* addons: [<custom-addons-here>] // if you want to use also custom addons
* vueTemplate: true,
* vueDirectives: [<the-directives-here>]
* }
* ```
*
* Built-in addons:
* - vueDirectives: enable auto import directives for Vue's SFC
* - vueTemplate: enable auto import inside for Vue's <template>
*
* @default {}
*/
addons: AddonsOptions | Addon[]
/**
* Name of virtual modules that exposed all the registed auto-imports
* @default []
*/
virtualImports: string[]
/**
* Directories to scan for auto import
* @default []
*/
dirs?: (string | ScanDir)[]
/**
* Options for scanning directories for auto import
*/
dirsScanOptions?: ScanDirExportsOptions
/**
* Custom resolver to auto import id
*/
resolveId?: (id: string, importee?: string) => Thenable<string | void>
/**
* Custom magic comments to be opt-out for auto import, per file/module
*
* @default ['@unimport-disable', '@imports-disable']
*/
commentsDisable?: string[]
/**
* Custom magic comments to debug auto import, printed to console
*
* @default ['@unimport-debug', '@imports-debug']
*/
commentsDebug?: string[]
/**
* Collect meta data for each auto import. Accessible via `ctx.meta`
*/
collectMeta?: boolean
}
export type PathFromResolver = (_import: Import) => string | undefined
export interface ScanDirExportsOptions {
/**
* Glob patterns for matching files
*
* @default ['*.{ts,js,mjs,cjs,mts,cts,tsx,jsx}']
*/
filePatterns?: string[]
/**
* Custom function to filter scanned files
*/
fileFilter?: (file: string) => boolean
/**
* Register type exports
*
* @default true
*/
types?: boolean
/**
* Current working directory
*
* @default process.cwd()
*/
cwd?: string
}
export interface ScanDir {
/**
* Path pattern of the directory
*/
glob: string
/**
* Register type exports
*
* @default true
*/
types?: boolean
}
export interface TypeDeclarationOptions {
/**
* Custom resolver for path of the import
*/
resolvePath?: PathFromResolver
/**
* Append `export {}` to the end of the file
*
* @default true
*/
exportHelper?: boolean
/**
* Auto-import for type exports
*
* @default true
*/
typeReExports?: boolean
}
export interface InjectImportsOptions {
/**
* Merge the existing imports
*
* @default false
*/
mergeExisting?: boolean
/**
* If the module should be auto imported
*
* @default true
*/
autoImport?: boolean
/**
* If the module should be transformed for virtual modules.
* Only available when `virtualImports` is set.
*
* @default true
*/
transformVirtualImports?: boolean
/**
* Parser to use for parsing the code
*
* Note that `acorn` only takes valid JS Code, should usually only be used after transformationa and transpilation
*
* @default 'regex'
*/
parser?: 'acorn' | 'oxc' | 'regex'
/**
* Inject the imports at the end of other imports
*
* @default false
*/
injectAtEnd?: boolean
}
export type Thenable<T> = Promise<T> | T
export interface Addon {
name?: string
transform?: (this: UnimportContext, code: MagicString, id: string | undefined) => Thenable<MagicString>
declaration?: (this: UnimportContext, dts: string, options: TypeDeclarationOptions) => Thenable<string>
matchImports?: (this: UnimportContext, identifiers: Set<string>, matched: Import[]) => Thenable<Import[] | void>
/**
* Extend or modify the imports list before injecting
*/
extendImports?: (this: UnimportContext, imports: Import[]) => Import[] | void
/**
* Resolve imports before injecting
*/
injectImportsResolved?: (this: UnimportContext, imports: Import[], code: MagicString, id?: string) => Import[] | void
/**
* Modify the injection code before injecting
*/
injectImportsStringified?: (this: UnimportContext, injection: string, imports: Import[], code: MagicString, id?: string) => string | void
}
export interface InstallGlobalOptions {
/**
* @default globalThis
*/
globalObject?: any
/**
* Overrides the existing property
* @default false
*/
overrides?: boolean
}
export interface MagicStringResult {
s: MagicString
code: string
}
export interface ImportInjectionResult extends MagicStringResult {
imports: Import[]
}
export interface ToExportsOptions {
/**
* Whether to retrieve module names from imports' `typeFrom` property when provided
* @default false
*/
declaration?: boolean
}