fix: avoid breakage by not to auto augment hooks type (#386)

ktsn · web-flow · commit d54490bf603b · 2020-01-12T16:13:25.000+09:00
* fix: avoid breakage not to auto augment hooks type

* fix: add dummy hooks.js
diff --git a/README.md b/README.md
@@ -200,7 +200,21 @@ new Vue({
 })
 ```
 
-In TypeScript, all built-in lifecycle hools and special methods are declared in the component instance type to enable auto-complete in editors.
+### Enabling Custom Hooks Auto-complete in TypeScript
+
+vue-class-component provides a built-in hooks type, which enables auto-complete for `data`, `render` and other lifecycle hooks in class component declarations, for TypeScript. To enable it, you need to import hooks type located at `vue-class-component/hooks`.
+
+```ts
+// main.ts
+import 'vue-class-component/hooks' // import hooks type to enable auto-complete
+import Vue from 'vue'
+import App from './App.vue'
+
+new Vue({
+  render: h => h(App)
+}).$mount('#app')
+```
+
 If you want to make it work with custom hooks, you can manually add it by yourself:
 
 ```ts
diff --git a/hooks.d.ts b/hooks.d.ts
diff --git a/hooks.js b/hooks.js
@@ -0,0 +1 @@
+// Dummy empty file to avoid import error when using hooks.d.ts
diff --git a/package.json b/package.json
@@ -7,7 +7,8 @@
   "typings": "lib/index.d.ts",
   "files": [
     "dist",
-    "lib"
+    "lib",
+    "hooks.d.ts"
   ],
   "scripts": {
     "build": "npm run build:ts && npm run build:main",
diff --git a/src/index.ts b/src/index.ts
@@ -1,4 +1,3 @@
-import './lifecycle'
 import Vue, { ComponentOptions } from 'vue'
 import { VueClass } from './declarations'
 import { componentFactory, $internalHooks } from './component'

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+// Dummy empty file to avoid import error when using hooks.d.ts`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-import './lifecycle'`
`2`	`1`	`import Vue, { ComponentOptions } from 'vue'`
`3`	`2`	`import { VueClass } from './declarations'`
`4`	`3`	`import { componentFactory, $internalHooks } from './component'`