perf: better management of cache (#83)

* better management of cache

* add caching for templates

Author: elevatebart

src/main.ts

@@ -1,8 +1,5 @@
 import { ComponentDoc, Documentation } from './Documentation'
 import { parseFile, parseSource as parseSourceLocal } from './parse'
-import * as utils from './utils'
-
-export { utils }
 
 export { ComponentDoc }
 

src/parse-script.ts

@@ -3,6 +3,7 @@ import * as bt from '@babel/types'
 import { NodePath } from 'ast-types'
 import buildParser from './babel-parser'
 import { Documentation } from './Documentation'
+import cacher from './utils/cacher'
 import resolveExportedComponent from './utils/resolveExportedComponent'
 
 // tslint:disable-next-line:no-var-requires
@@ -19,7 +20,8 @@ export default function parseScript(
   options: { lang: 'ts' | 'js'; filePath: string },
 ) {
   const plugins: ParserPlugin[] = options.lang === 'ts' ? ['typescript'] : ['flow']
-  const ast = recast.parse(source, { parser: buildParser({ plugins }) })
+
+  const ast = cacher(() => recast.parse(source, { parser: buildParser({ plugins }) }), source)
   if (!ast) {
     throw new Error(ERROR_MISSING_DEFINITION)
   }

src/parse-template.ts

@@ -1,6 +1,7 @@
 import * as pug from 'pug'
 import { ASTElement, ASTNode, compile, SFCBlock } from 'vue-template-compiler'
 import { Documentation } from './Documentation'
+import cacher from './utils/cacher'
 
 export interface TemplateParserOptions {
   functional: boolean
@@ -23,7 +24,7 @@ export default function parseTemplate(
       tpl.attrs && tpl.attrs.lang === 'pug'
         ? pug.render(tpl.content, { filename: filePath })
         : tpl.content
-    const ast = compile(template, { comments: true }).ast
+    const ast = cacher(() => compile(template, { comments: true }).ast, template)
     if (ast) {
       traverse(ast, documentation, handlers, { functional: !!tpl.attrs.functional })
     }

src/parse.ts

@@ -1,12 +1,12 @@
 import * as fs from 'fs'
 import * as path from 'path'
-import { SFCDescriptor } from 'vue-template-compiler'
+import { parseComponent, SFCDescriptor } from 'vue-template-compiler'
 import { Documentation } from './Documentation'
 import parseScript from './parse-script'
 import parseTemplate from './parse-template'
 import handlers from './script-handlers'
 import templateHandlers from './template-handlers'
-import scfParser from './utils/sfc-parser'
+import cacher from './utils/cacher'
 
 const ERROR_EMPTY_DOCUMENT = 'The passed source is empty'
 
@@ -38,7 +38,7 @@ export function parseSource(source: string, filePath: string, documentation: Doc
   }
 
   if (singleFileComponent) {
-    parts = scfParser(source, filePath)
+    parts = cacher(() => parseComponent(source), source)
   }
 
   const scriptSource = parts ? (parts.script ? parts.script.content : undefined) : source

src/utils/__tests__/__snapshots__/sfc-parser.ts.snap

@@ -1,20 +1,19 @@
-import { parseComponent, SFCDescriptor } from 'vue-template-compiler'
 // tslint:disable-next-line:no-var-requires
 const LRUCache = require('lru-cache')
 // tslint:disable-next-line:no-var-requires
 const hash = require('hash-sum')
 
 const cache = new LRUCache(250)
 
-export default function scfParser(source: string, filename: string): SFCDescriptor {
-  const hashTmp = hash
-  const cacheKey = hashTmp(filename + source)
+export default function<T>(creator: () => T, ...argsKey: string[]): T {
+  const cacheKey = hash(argsKey.join(''))
+
   // source-map cache busting for hot-reloadded modules
-  let output: SFCDescriptor = cache.get(cacheKey)
+  let output: T = cache.get(cacheKey)
   if (output) {
     return output
   }
-  output = parseComponent(source)
+  output = creator()
   cache.set(cacheKey, output)
   return output
 }

src/utils/__tests__/sfc-parser.ts

@@ -6,7 +6,7 @@ const button = path.join(__dirname, './Button.vue')
 let docButton: ComponentDoc
 
 describe('tests button', () => {
-  beforeEach(done => {
+  beforeAll(done => {
     docButton = parse(button)
     done()
   })