chore: simplify ts typings (#106)

* simplify vue-template-compiler typings

* fix typings

* remove tslint comments

* remove one last comment

* fix tsconfig

Author: elevatebart

package-lock.json

@@ -36,11 +36,11 @@
   "dependencies": {
     "@babel/parser": "^7.2.3",
     "@babel/types": "^7.0.0",
-    "ast-types": "^0.11.7",
+    "ast-types": "^0.12.2",
     "hash-sum": "^1.0.2",
     "lru-cache": "^4.1.5",
     "pug": "^2.0.3",
-    "recast": "^0.16.2",
+    "recast": "^0.17.3",
     "ts-map": "^1.0.3",
     "typescript": "^3.2.2",
     "vue": "^2.6.3",

package.json

@@ -1,220 +1,10 @@
 /**
- * This declaration is copied from https://github.com/vuejs/vue/pull/7918
- * which may included vue-template-compiler v2.6.0.
+ * augment the original types with the needed comments
  */
+import 'vue-template-compiler'
 
 declare module 'vue-template-compiler' {
-  import Vue, { VNode } from 'vue'
-
-  /*
-   * Template compilation options / results
-   */
   interface CompilerOptions {
-    modules?: ModuleOptions[]
-    directives?: Record<string, DirectiveFunction>
-    preserveWhitespace?: boolean
     comments?: boolean
   }
-
-  interface CompiledResult {
-    ast: ASTElement | undefined
-    render: string
-    staticRenderFns: string[]
-    errors: string[]
-    tips: string[]
-  }
-
-  interface CompiledResultFunctions {
-    render: () => VNode
-    staticRenderFns: (() => VNode)[]
-  }
-
-  interface ModuleOptions {
-    preTransformNode: (el: ASTElement) => ASTElement | undefined
-    transformNode: (el: ASTElement) => ASTElement | undefined
-    postTransformNode: (el: ASTElement) => void
-    genData: (el: ASTElement) => string
-    transformCode?: (el: ASTElement, code: string) => string
-    staticKeys?: string[]
-  }
-
-  type DirectiveFunction = (node: ASTElement, directiveMeta: ASTDirective) => void
-
-  /*
-   * AST Types
-   */
-
-  /**
-   * - 0: FALSE - whole sub tree un-optimizable
-   * - 1: FULL - whole sub tree optimizable
-   * - 2: SELF - self optimizable but has some un-optimizable children
-   * - 3: CHILDREN - self un-optimizable but have fully optimizable children
-   * - 4: PARTIAL - self un-optimizable with some un-optimizable children
-   */
-  export type SSROptimizability = 0 | 1 | 2 | 3 | 4
-
-  export interface ASTModifiers {
-    [key: string]: boolean
-  }
-
-  export interface ASTIfCondition {
-    exp: string | undefined
-    block: ASTElement
-  }
-
-  export interface ASTElementHandler {
-    value: string
-    params?: any[]
-    modifiers: ASTModifiers | undefined
-  }
-
-  export interface ASTElementHandlers {
-    [key: string]: ASTElementHandler | ASTElementHandler[]
-  }
-
-  export interface ASTDirective {
-    name: string
-    rawName: string
-    value: string
-    arg: string | undefined
-    modifiers: ASTModifiers | undefined
-  }
-
-  export type ASTNode = ASTElement | ASTText | ASTExpression
-
-  export interface ASTElement {
-    type: 1
-    tag: string
-    attrsList: { name: string; value: any }[]
-    attrsMap: Record<string, any>
-    parent: ASTElement | undefined
-    children: ASTNode[]
-
-    processed?: true
-
-    static?: boolean
-    staticRoot?: boolean
-    staticInFor?: boolean
-    staticProcessed?: boolean
-    hasBindings?: boolean
-
-    text?: string
-    attrs?: { name: string; value: any }[]
-    props?: { name: string; value: string }[]
-    plain?: boolean
-    pre?: true
-    ns?: string
-
-    component?: string
-    inlineTemplate?: true
-    transitionMode?: string | null
-    slotName?: string
-    slotTarget?: string
-    slotScope?: string
-    scopedSlots?: Record<string, ASTElement>
-
-    ref?: string
-    refInFor?: boolean
-
-    if?: string
-    ifProcessed?: boolean
-    elseif?: string
-    else?: true
-    ifConditions?: ASTIfCondition[]
-
-    for?: string
-    forProcessed?: boolean
-    key?: string
-    alias?: string
-    iterator1?: string
-    iterator2?: string
-
-    staticClass?: string
-    classBinding?: string
-    staticStyle?: string
-    styleBinding?: string
-    events?: ASTElementHandlers
-    nativeEvents?: ASTElementHandlers
-
-    transition?: string | true
-    transitionOnAppear?: boolean
-
-    model?: {
-      value: string
-      callback: string
-      expression: string
-    }
-
-    directives?: ASTDirective[]
-
-    forbidden?: true
-    once?: true
-    onceProcessed?: boolean
-    wrapData?: (code: string) => string
-    wrapListeners?: (code: string) => string
-
-    // 2.4 ssr optimization
-    ssrOptimizability?: SSROptimizability
-
-    // weex specific
-    appendAsTree?: boolean
-  }
-
-  export interface ASTExpression {
-    type: 2
-    expression: string
-    text: string
-    tokens: (string | Record<string, any>)[]
-    static?: boolean
-    // 2.4 ssr optimization
-    ssrOptimizability?: SSROptimizability
-  }
-
-  export interface ASTText {
-    type: 3
-    text: string
-    static?: boolean
-    isComment?: boolean
-    // 2.4 ssr optimization
-    ssrOptimizability?: SSROptimizability
-  }
-
-  /*
-   * SFC parser related types
-   */
-  interface SFCParserOptions {
-    pad?: true | 'line' | 'space'
-  }
-
-  export interface SFCBlock {
-    type: string
-    content: string
-    attrs: Record<string, string>
-    start?: number
-    end?: number
-    lang?: string
-    src?: string
-    scoped?: boolean
-    module?: string | boolean
-  }
-
-  export interface SFCDescriptor {
-    template: SFCBlock | undefined
-    script: SFCBlock | undefined
-    styles: SFCBlock[]
-    customBlocks: SFCBlock[]
-  }
-
-  /*
-   * Exposed functions
-   */
-  export function compile(template: string, options?: CompilerOptions): CompiledResult
-
-  export function compileToFunctions(template: string): CompiledResultFunctions
-
-  export function ssrCompile(template: string, options?: CompilerOptions): CompiledResult
-
-  export function ssrCompileToFunctions(template: string): CompiledResultFunctions
-
-  export function parseComponent(file: string, options?: SFCParserOptions): SFCDescriptor
 }

src/@types/ast-types.d.ts

@@ -1,16 +1,14 @@
 import { ParserPlugin } from '@babel/parser'
 import * as bt from '@babel/types'
 import { NodePath } from 'ast-types'
+import recast from 'recast'
 import Map from 'ts-map'
 import buildParser from './babel-parser'
 import { Documentation } from './Documentation'
+import { ParseOptions } from './parse'
 import cacher from './utils/cacher'
 import resolveExportedComponent from './utils/resolveExportedComponent'
 
-// tslint:disable-next-line:no-var-requires
-import recast = require('recast')
-import { ParseOptions } from './parse'
-
 const ERROR_MISSING_DEFINITION = 'No suitable component definition found'
 
 export type Handler = (

src/@types/recast.d.ts

@@ -35,7 +35,7 @@ function getArgFromDecorator(
       const exp = p.get('expression')
       const decoratorIdenifier = bt.isCallExpression(exp.node) ? exp.node.callee : exp.node
       return 'Component' === (bt.isIdentifier(decoratorIdenifier) ? decoratorIdenifier.name : null)
-    })[0]
+    }, null)[0]
     .get('expression')
   if (bt.isCallExpression(expForDecorator.node)) {
     return expForDecorator.get('arguments', 0) as NodePath<

src/@types/vue-template-compiler.d.ts

@@ -1,5 +1,6 @@
 import * as bt from '@babel/types'
 import { NodePath } from 'ast-types'
+import recast from 'recast'
 import {
   BlockTag,
   DocBlockTags,
@@ -15,12 +16,9 @@ export interface TypedParamTag extends ParamTag {
   type: ParamType
 }
 
-// tslint:disable-next-line:no-var-requires
-import recast = require('recast')
-
 export default function eventHandler(documentation: Documentation, path: NodePath) {
-  recast.visit(path, {
-    visitCallExpression(pathExpression: NodePath<bt.CallExpression>) {
+  recast.visit(path.node, {
+    visitCallExpression(pathExpression) {
       if (
         bt.isMemberExpression(pathExpression.node.callee) &&
         bt.isThisExpression(pathExpression.node.callee.object) &&

src/parse-script.ts

@@ -1,13 +1,11 @@
 import * as bt from '@babel/types'
 import { NodePath } from 'ast-types'
+import recast from 'recast'
 import { BlockTag, Documentation, Tag } from '../Documentation'
 import { setEventDescriptor } from '../script-handlers/eventHandler'
 import { parseDocblock } from '../utils/getDocblock'
 import getDoclets from '../utils/getDoclets'
 
-// tslint:disable-next-line:no-var-requires
-import recast = require('recast')
-
 export default function oldEventsHanlder(
   documentation: Documentation,
   path: NodePath,

src/script-handlers/classDisplayNameHandler.ts

@@ -1,13 +1,11 @@
 import * as bt from '@babel/types'
 import { NodePath } from 'ast-types'
+import recast from 'recast'
 import { BlockTag, DocBlockTags, Documentation, PropDescriptor } from '../Documentation'
 import getDocblock from '../utils/getDocblock'
 import getDoclets from '../utils/getDoclets'
 import transformTagsIntoObject from '../utils/transformTagsIntoObject'
 
-// tslint:disable-next-line:no-var-requires
-import recast = require('recast')
-
 type ValueLitteral = bt.StringLiteral | bt.BooleanLiteral | bt.NumericLiteral
 
 export default function propHandler(documentation: Documentation, path: NodePath) {