Skip to content

Commit 2726b6d

Browse files
committed
fix: further align types with v3
1 parent fa2115c commit 2726b6d

File tree

4 files changed

+21
-33
lines changed

4 files changed

+21
-33
lines changed

packages/compiler-sfc/src/compileTemplate.ts

+7-11
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
import {
2-
BindingMetadata,
3-
VueTemplateCompiler,
4-
VueTemplateCompilerOptions
5-
} from './types'
1+
import { BindingMetadata, TemplateCompiler } from './types'
62
import assetUrlsModule, {
73
AssetURLOptions,
84
TransformAssetUrlsOptions
@@ -11,13 +7,13 @@ import srcsetModule from './templateCompilerModules/srcset'
117
import consolidate from '@vue/consolidate'
128
import * as _compiler from 'web/entry-compiler'
139
import { prefixIdentifiers } from './prefixIdentifiers'
14-
import { WarningMessage } from 'types/compiler'
10+
import { CompilerOptions, WarningMessage } from 'types/compiler'
1511

1612
export interface SFCTemplateCompileOptions {
1713
source: string
1814
filename: string
19-
compiler?: VueTemplateCompiler
20-
compilerOptions?: VueTemplateCompilerOptions
15+
compiler?: TemplateCompiler
16+
compilerOptions?: CompilerOptions
2117
transformAssetUrls?: AssetURLOptions | boolean
2218
transformAssetUrlsOptions?: TransformAssetUrlsOptions
2319
preprocessLang?: string
@@ -31,7 +27,7 @@ export interface SFCTemplateCompileOptions {
3127
bindings?: BindingMetadata
3228
}
3329

34-
export interface SFCTemplateCompileResult {
30+
export interface SFCTemplateCompileResults {
3531
ast: Object | undefined
3632
code: string
3733
source: string
@@ -41,7 +37,7 @@ export interface SFCTemplateCompileResult {
4137

4238
export function compileTemplate(
4339
options: SFCTemplateCompileOptions
44-
): SFCTemplateCompileResult {
40+
): SFCTemplateCompileResults {
4541
const { preprocessLang } = options
4642
const preprocessor = preprocessLang && consolidate[preprocessLang]
4743
if (preprocessor) {
@@ -100,7 +96,7 @@ function preprocess(
10096

10197
function actuallyCompile(
10298
options: SFCTemplateCompileOptions
103-
): SFCTemplateCompileResult {
99+
): SFCTemplateCompileResults {
104100
const {
105101
source,
106102
compiler = _compiler,

packages/compiler-sfc/src/index.ts

+9-2
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,17 @@ export { compileScript } from './compileScript'
66
export { generateCodeFrame } from 'compiler/codeframe'
77

88
// types
9-
export { SFCBlock, SFCCustomBlock, SFCDescriptor } from './parseComponent'
9+
export { CompilerOptions } from 'types/compiler'
10+
export { TemplateCompiler } from './types'
11+
export {
12+
SFCBlock,
13+
SFCCustomBlock,
14+
SFCScriptBlock,
15+
SFCDescriptor
16+
} from './parseComponent'
1017
export {
1118
SFCTemplateCompileOptions,
12-
SFCTemplateCompileResult
19+
SFCTemplateCompileResults
1320
} from './compileTemplate'
1421
export { SFCStyleCompileOptions, SFCStyleCompileResults } from './compileStyle'
1522
export { SFCScriptCompileOptions } from './compileScript'

packages/compiler-sfc/src/parse.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { SourceMapGenerator } from 'source-map'
2-
import { RawSourceMap, VueTemplateCompiler } from './types'
2+
import { RawSourceMap, TemplateCompiler } from './types'
33
import {
44
parseComponent,
55
VueTemplateCompilerParseOptions,
@@ -19,7 +19,7 @@ const emptyRE = /^(?:\/\/)?\s*$/
1919
export interface ParseOptions {
2020
source: string
2121
filename?: string
22-
compiler?: VueTemplateCompiler
22+
compiler?: TemplateCompiler
2323
compilerParseOptions?: VueTemplateCompilerParseOptions
2424
sourceRoot?: string
2525
needMap?: boolean

packages/compiler-sfc/src/types.ts

+3-18
Original file line numberDiff line numberDiff line change
@@ -14,27 +14,12 @@ export interface RawSourceMap extends StartOfSourceMap {
1414
mappings: string
1515
}
1616

17-
export interface VueTemplateCompiler {
17+
export interface TemplateCompiler {
1818
parseComponent(source: string, options?: any): SFCDescriptor
19-
20-
compile(
21-
template: string,
22-
options: VueTemplateCompilerOptions
23-
): VueTemplateCompilerResults
24-
25-
ssrCompile(
26-
template: string,
27-
options: VueTemplateCompilerOptions
28-
): VueTemplateCompilerResults
19+
compile(template: string, options: CompilerOptions): CompiledResult
20+
ssrCompile(template: string, options: CompilerOptions): CompiledResult
2921
}
3022

31-
// we'll just shim this much for now - in the future these types
32-
// should come from vue-template-compiler directly, or this package should be
33-
// part of the vue monorepo.
34-
export type VueTemplateCompilerOptions = CompilerOptions
35-
36-
export type VueTemplateCompilerResults = CompiledResult
37-
3823
export const enum BindingTypes {
3924
/**
4025
* returned from data()

0 commit comments

Comments
 (0)