|
|
@@ -0,0 +1,67 @@
|
|
|
+import { ElementNode, Namespace } from './ast'
|
|
|
+import { TextModes } from './parse'
|
|
|
+import { CompilerError } from './errors'
|
|
|
+import { NodeTransform, DirectiveTransform } from './transform'
|
|
|
+
|
|
|
+export interface ParserOptions {
|
|
|
+ isVoidTag?: (tag: string) => boolean // e.g. img, br, hr
|
|
|
+ isNativeTag?: (tag: string) => boolean // e.g. loading-indicator in weex
|
|
|
+ isPreTag?: (tag: string) => boolean // e.g. <pre> where whitespace is intact
|
|
|
+ isCustomElement?: (tag: string) => boolean
|
|
|
+ isBuiltInComponent?: (tag: string) => symbol | void
|
|
|
+ getNamespace?: (tag: string, parent: ElementNode | undefined) => Namespace
|
|
|
+ getTextMode?: (tag: string, ns: Namespace) => TextModes
|
|
|
+ delimiters?: [string, string] // ['{{', '}}']
|
|
|
+
|
|
|
+ // Map to HTML entities. E.g., `{ "amp;": "&" }`
|
|
|
+ // The full set is https://html.spec.whatwg.org/multipage/named-characters.html#named-character-references
|
|
|
+ namedCharacterReferences?: Record<string, string>
|
|
|
+ // this number is based on the map above, but it should be pre-computed
|
|
|
+ // to avoid the cost on every parse() call.
|
|
|
+ maxCRNameLength?: number
|
|
|
+
|
|
|
+ onError?: (error: CompilerError) => void
|
|
|
+}
|
|
|
+
|
|
|
+export interface TransformOptions {
|
|
|
+ nodeTransforms?: NodeTransform[]
|
|
|
+ directiveTransforms?: { [name: string]: DirectiveTransform }
|
|
|
+ isBuiltInComponent?: (tag: string) => symbol | void
|
|
|
+ // Transform expressions like {{ foo }} to `_ctx.foo`.
|
|
|
+ // Default: mode === 'module'
|
|
|
+ prefixIdentifiers?: boolean
|
|
|
+ // Hoist static VNodes and props objects to `_hoisted_x` constants
|
|
|
+ // Default: false
|
|
|
+ hoistStatic?: boolean
|
|
|
+ // Cache v-on handlers to avoid creating new inline functions on each render,
|
|
|
+ // also avoids the need for dynamically patching the handlers by wrapping it.
|
|
|
+ // e.g `@click="foo"` by default is compiled to `{ onClick: foo }`. With this
|
|
|
+ // option it's compiled to:
|
|
|
+ // `{ onClick: _cache[0] || (_cache[0] = e => _ctx.foo(e)) }`
|
|
|
+ // Default: false
|
|
|
+ cacheHandlers?: boolean
|
|
|
+ onError?: (error: CompilerError) => void
|
|
|
+}
|
|
|
+
|
|
|
+export interface CodegenOptions {
|
|
|
+ // - Module mode will generate ES module import statements for helpers
|
|
|
+ // and export the render function as the default export.
|
|
|
+ // - Function mode will generate a single `const { helpers... } = Vue`
|
|
|
+ // statement and return the render function. It is meant to be used with
|
|
|
+ // `new Function(code)()` to generate a render function at runtime.
|
|
|
+ // Default: 'function'
|
|
|
+ mode?: 'module' | 'function'
|
|
|
+ // Prefix suitable identifiers with _ctx.
|
|
|
+ // If this option is false, the generated code will be wrapped in a
|
|
|
+ // `with (this) { ... }` block.
|
|
|
+ // Default: false
|
|
|
+ prefixIdentifiers?: boolean
|
|
|
+ // Generate source map?
|
|
|
+ // Default: false
|
|
|
+ sourceMap?: boolean
|
|
|
+ // Filename for source map generation.
|
|
|
+ // Default: `template.vue.html`
|
|
|
+ filename?: string
|
|
|
+}
|
|
|
+
|
|
|
+export type CompilerOptions = ParserOptions & TransformOptions & CodegenOptions
|
Evan You