docs: Improve typescript docs generation

microcipcip · microcipcip · commit 91859171ff56 · 2020-02-21T21:18:26.000Z
diff --git a/.eslintrc b/.eslintrc
@@ -14,6 +14,12 @@
     "prettier/prettier": "error",
     "@typescript-eslint/explicit-function-return-type": "off",
     "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/unbound-method": "off"
+    "@typescript-eslint/unbound-method": "off",
+    "@typescript-eslint/no-unused-vars": ["warn", {
+      "vars": "all",
+      "args": "after-used",
+      "ignoreRestSiblings": false,
+      "varsIgnorePattern": "Ref"
+    }]
   }
 }
diff --git a/src/api.ts b/src/api.ts
diff --git a/src/components/useClickAway/stories/UseClickAwayDemo.vue b/src/components/useClickAway/stories/UseClickAwayDemo.vue
@@ -25,7 +25,7 @@
 
 <script lang="ts">
 import Vue from 'vue'
-import { ref } from '@src/api'
+import { ref } from '@vue/composition-api'
 import { useClickAway } from '@src/vue-use-kit'
 
 export default Vue.extend({
diff --git a/src/components/useClickAway/stories/useClickAway.md b/src/components/useClickAway/stories/useClickAway.md
@@ -30,7 +30,7 @@ function useClickAway(
 
 <script lang="ts">
   import Vue from 'vue'
-  import { ref } from '@src/api'
+  import { ref } from '@vue/composition-api'
   import { useClickAway } from 'vue-use-kit'
 
   export default Vue.extend({
diff --git a/src/components/useClickAway/useClickAway.spec.ts b/src/components/useClickAway/useClickAway.spec.ts
@@ -1,5 +1,5 @@
 import { mount } from '@src/helpers/test'
-import { ref } from '@src/api'
+import { ref } from '@vue/composition-api'
 import { useClickAway } from '@src/vue-use-kit'
 
 afterEach(() => {
diff --git a/src/components/useClickAway/useClickAway.ts b/src/components/useClickAway/useClickAway.ts
@@ -1,4 +1,4 @@
-import { onMounted, onUnmounted, Ref } from '@src/api'
+import { onMounted, onUnmounted, Ref } from '@vue/composition-api'
 
 const defaultEvents = ['mousedown', 'touchstart']
 
diff --git a/src/components/useFullscreen/stories/UseFullscreenDemo.vue b/src/components/useFullscreen/stories/UseFullscreenDemo.vue
@@ -37,7 +37,7 @@
 
 <script lang="ts">
 import Vue from 'vue'
-import { ref } from '@src/api'
+import { ref } from '@vue/composition-api'
 import { useFullscreen } from '@src/vue-use-kit'
 
 export default Vue.extend({
diff --git a/src/components/useFullscreen/stories/useFullscreen.md b/src/components/useFullscreen/stories/useFullscreen.md
@@ -37,7 +37,7 @@ function useFullscreen(
 
 <script lang="ts">
   import Vue from 'vue'
-  import { ref } from '@src/api'
+  import { ref } from '@vue/composition-api'
   import { useFullscreen } from 'vue-use-kit'
 
   export default Vue.extend({
diff --git a/src/components/useFullscreen/useFullscreen.spec.ts b/src/components/useFullscreen/useFullscreen.spec.ts
@@ -1,5 +1,5 @@
 import { mount } from '@src/helpers/test'
-import { ref } from '@src/api'
+import { ref } from '@vue/composition-api'
 import { useFullscreen } from '@src/vue-use-kit'
 
 // This feature is difficult to test therefore
diff --git a/src/components/useFullscreen/useFullscreen.ts b/src/components/useFullscreen/useFullscreen.ts
@@ -1,4 +1,4 @@
-import { ref, Ref, onUnmounted } from '@src/api'
+import { ref, onUnmounted, Ref } from '@vue/composition-api'
 
 export function useFullscreen(elRef: Ref<null | HTMLElement>) {
   const isFullscreen = ref(false)
diff --git a/src/components/useGeolocation/useGeolocation.spec.ts b/src/components/useGeolocation/useGeolocation.spec.ts
@@ -18,11 +18,11 @@ beforeEach(() => {
       })
     )
   )
-  const inst = ((navigator as any).geolocation = {
+  ;(navigator as any).geolocation = {
     watchPosition,
     clearWatch,
     getCurrentPosition
-  })
+  }
 })
 
 afterEach(() => {
diff --git a/src/components/useGeolocation/useGeolocation.ts b/src/components/useGeolocation/useGeolocation.ts
@@ -1,4 +1,4 @@
-import { ref, onMounted, onUnmounted, Ref } from '@src/api'
+import { ref, onMounted, onUnmounted, Ref } from '@vue/composition-api'
 
 export interface UseGeolocation {
   loading: boolean
diff --git a/src/components/useHover/stories/UseHoverDemo.vue b/src/components/useHover/stories/UseHoverDemo.vue
@@ -9,7 +9,7 @@
 
 <script lang="ts">
 import Vue from 'vue'
-import { ref } from '@src/api'
+import { ref } from '@vue/composition-api'
 import { useHover } from '@src/vue-use-kit'
 
 export default Vue.extend({
diff --git a/src/components/useHover/stories/useHover.md b/src/components/useHover/stories/useHover.md
@@ -28,7 +28,7 @@ function useHover(elRef: Ref<null | HTMLElement>): Ref<boolean>
 
 <script lang="ts">
   import Vue from 'vue'
-  import { ref } from '@src/api'
+  import { ref } from '@vue/composition-api'
   import { useHover } from 'vue-use-kit'
 
   export default Vue.extend({
diff --git a/src/components/useHover/useHover.spec.ts b/src/components/useHover/useHover.spec.ts
@@ -1,5 +1,5 @@
 import { mount } from '@src/helpers/test'
-import { ref } from '@src/api'
+import { ref } from '@vue/composition-api'
 import { useHover } from '@src/vue-use-kit'
 
 afterEach(() => {
diff --git a/src/components/useHover/useHover.ts b/src/components/useHover/useHover.ts
@@ -1,4 +1,4 @@
-import { ref, onMounted, onUnmounted, Ref } from '@src/api'
+import { ref, onMounted, onUnmounted, Ref } from '@vue/composition-api'
 
 export function useHover(elRef: Ref<null | HTMLElement>) {
   const isHovered = ref(false)
diff --git a/src/components/useIdle/stories/UseIdleDemo.vue b/src/components/useIdle/stories/UseIdleDemo.vue
@@ -31,7 +31,7 @@
 
 <script lang="ts">
 import Vue from 'vue'
-import { ref } from '@src/api'
+import { ref } from '@vue/composition-api'
 import { useIdle } from '@src/vue-use-kit'
 
 export default Vue.extend({
diff --git a/src/components/useIdle/useIdle.ts b/src/components/useIdle/useIdle.ts
@@ -1,5 +1,5 @@
 import { throttle } from 'throttle-debounce'
-import { ref, onMounted, onUnmounted } from '@src/api'
+import { ref, onMounted, onUnmounted, Ref } from '@vue/composition-api'
 
 export const idleEventsList = [
   'mousemove',
diff --git a/src/components/useIntersection/stories/UseIntersectionElementDemo.vue b/src/components/useIntersection/stories/UseIntersectionElementDemo.vue
@@ -22,7 +22,7 @@
 
 <script lang="ts">
 import Vue from 'vue'
-import { ref, watch } from '@src/api'
+import { ref, watch } from '@vue/composition-api'
 import { useIntersection } from '@src/vue-use-kit'
 export default Vue.extend({
   name: 'UseIntersectionElementDemo',
diff --git a/src/components/useIntersection/stories/useIntersection.md b/src/components/useIntersection/stories/useIntersection.md
@@ -43,7 +43,7 @@ First we have to define the intersection component, named `UseIntersectionElDemo
 
 <script lang="ts">
   import Vue from 'vue'
-  import { ref, watch } from '@src/api'
+  import { ref, watch } from '@vue/composition-api'
   import { useIntersection } from 'vue-use-kit'
 
   export default Vue.extend({
diff --git a/src/components/useIntersection/useIntersection.spec.ts b/src/components/useIntersection/useIntersection.spec.ts
@@ -1,5 +1,5 @@
 import { mount } from '@src/helpers/test'
-import { ref } from '@src/api'
+import { ref } from '@vue/composition-api'
 import { useIntersection } from '@src/vue-use-kit'
 
 let observe: any
diff --git a/src/components/useIntersection/useIntersection.ts b/src/components/useIntersection/useIntersection.ts
@@ -1,4 +1,4 @@
-import { ref, onMounted, onUnmounted, Ref } from '@src/api'
+import { ref, onMounted, onUnmounted, Ref } from '@vue/composition-api'
 
 const errorMsg =
   'IntersectionObserver is not supported, please install a polyfill'
diff --git a/src/components/useInterval/useInterval.ts b/src/components/useInterval/useInterval.ts
@@ -1,4 +1,4 @@
-import { ref } from '@src/api'
+import { ref, Ref } from '@vue/composition-api'
 import { useIntervalFn } from '@src/components/useIntervalFn'
 
 export function useInterval(ms = 0, runOnMount = true) {
diff --git a/src/components/useIntervalFn/stories/UseIntervalFnDemo.vue b/src/components/useIntervalFn/stories/UseIntervalFnDemo.vue
@@ -27,7 +27,7 @@
 
 <script lang="ts">
 import Vue from 'vue'
-import { ref } from '@src/api'
+import { ref } from '@vue/composition-api'
 import { useIntervalFn } from '@src/vue-use-kit'
 
 export default Vue.extend({
diff --git a/src/components/useIntervalFn/stories/useIntervalFn.md b/src/components/useIntervalFn/stories/useIntervalFn.md
@@ -42,7 +42,7 @@ function useIntervalFn(
 
 <script lang="ts">
   import Vue from 'vue'
-  import { ref } from '@src/api'
+  import { ref } from '@vue/composition-api'
   import { useIntervalFn } from 'vue-use-kit'
 
   export default Vue.extend({
diff --git a/src/components/useIntervalFn/useIntervalFn.spec.ts b/src/components/useIntervalFn/useIntervalFn.spec.ts
@@ -1,5 +1,5 @@
 import { mount } from '@src/helpers/test'
-import { ref } from '@src/api'
+import { ref } from '@vue/composition-api'
 import { useIntervalFn } from '@src/vue-use-kit'
 
 beforeEach(() => {
diff --git a/src/components/useIntervalFn/useIntervalFn.ts b/src/components/useIntervalFn/useIntervalFn.ts
@@ -1,4 +1,4 @@
-import { onMounted, onUnmounted, ref } from '@src/api'
+import { onMounted, onUnmounted, ref, Ref } from '@vue/composition-api'
 
 export function useIntervalFn(callback: Function, ms = 0, runOnMount = true) {
   const isRunning = ref(false)
diff --git a/src/components/useLocation/useLocation.ts b/src/components/useLocation/useLocation.ts
@@ -1,4 +1,4 @@
-import { ref, onMounted, onUnmounted, Ref } from '@src/api'
+import { ref, onMounted, onUnmounted, Ref } from '@vue/composition-api'
 import { patchHistoryMethodsOnce } from '@src/utils'
 
 export interface UseLocationState {
diff --git a/src/components/useMedia/stories/UseMediaAdvancedDemo.vue b/src/components/useMedia/stories/UseMediaAdvancedDemo.vue
@@ -37,7 +37,7 @@
 
 <script lang="ts">
 import Vue from 'vue'
-import { computed } from '@src/api'
+import { computed } from '@vue/composition-api'
 import { getQuery, useMedia } from '@src/vue-use-kit'
 
 // breakpoints
diff --git a/src/components/useMedia/useMedia.ts b/src/components/useMedia/useMedia.ts
@@ -1,4 +1,4 @@
-import { ref, onMounted, onUnmounted } from '@src/api'
+import { ref, onMounted, onUnmounted, Ref } from '@vue/composition-api'
 
 export function useMedia(query: string, defaultState = false) {
   let mql: MediaQueryList
diff --git a/src/components/useMouse/stories/UseMouseAdvancedDemo.vue b/src/components/useMouse/stories/UseMouseAdvancedDemo.vue
@@ -27,7 +27,7 @@
 
 <script lang="ts">
 import Vue from 'vue'
-import { ref, computed, onMounted, onUnmounted } from '@src/api'
+import { ref, computed, onMounted, onUnmounted } from '@vue/composition-api'
 import { useMouse } from '@src/vue-use-kit'
 
 const toInt = (n: number) => Math.round(n)
diff --git a/src/components/useMouse/useMouse.ts b/src/components/useMouse/useMouse.ts
@@ -1,4 +1,4 @@
-import { ref, onMounted, onUnmounted } from '@src/api'
+import { ref, onMounted, onUnmounted, Ref } from '@vue/composition-api'
 
 export function useMouse() {
   const docX = ref(0)
diff --git a/src/components/useMouseElement/stories/UseMouseElementDemo.vue b/src/components/useMouseElement/stories/UseMouseElementDemo.vue
@@ -49,7 +49,7 @@
 
 <script lang="ts">
 import Vue from 'vue'
-import { ref, computed, onMounted, onUnmounted } from '@src/api'
+import { ref, computed, onMounted, onUnmounted } from '@vue/composition-api'
 import { useMouseElement } from '@src/vue-use-kit'
 
 const toInt = (n: number) => Math.round(n)
diff --git a/src/components/useMouseElement/useMouseElement.spec.ts b/src/components/useMouseElement/useMouseElement.spec.ts
@@ -1,5 +1,5 @@
 import { mount } from '@src/helpers/test'
-import { ref } from '@src/api'
+import { ref } from '@vue/composition-api'
 import { useMouseElement } from '@src/vue-use-kit'
 
 afterEach(() => {
diff --git a/src/components/useMouseElement/useMouseElement.ts b/src/components/useMouseElement/useMouseElement.ts
@@ -1,4 +1,4 @@
-import { ref, onMounted, onUnmounted, Ref } from '@src/api'
+import { ref, onMounted, onUnmounted, Ref } from '@vue/composition-api'
 
 export function useMouseElement(elRef: Ref<null | HTMLElement>) {
   const docX = ref(0)
diff --git a/src/components/useRaf/stories/UseRafDemo.vue b/src/components/useRaf/stories/UseRafDemo.vue
@@ -37,7 +37,7 @@
 
 <script lang="ts">
 import Vue from 'vue'
-import { ref, computed } from '@src/api'
+import { ref, computed } from '@vue/composition-api'
 import { useRaf } from '@src/vue-use-kit'
 
 const pad = (n: number) => (n < 10 ? '0' + n : n)
diff --git a/src/components/useRaf/useRaf.ts b/src/components/useRaf/useRaf.ts
@@ -1,4 +1,4 @@
-import { ref } from '@src/api'
+import { ref, Ref } from '@vue/composition-api'
 import { TFps, useRafFn } from '@src/components/useRafFn'
 
 const fpsLimit = 60
diff --git a/src/components/useRafFn/stories/UseRafFnAdvancedDemo.vue b/src/components/useRafFn/stories/UseRafFnAdvancedDemo.vue
@@ -33,7 +33,7 @@
 
 <script lang="ts">
 import Vue from 'vue'
-import { ref, computed } from '@src/api'
+import { ref, computed } from '@vue/composition-api'
 import { useRafFn } from '@src/vue-use-kit'
 
 const spriteOpts = {
diff --git a/src/components/useRafFn/stories/UseRafFnDemo.vue b/src/components/useRafFn/stories/UseRafFnDemo.vue
@@ -52,7 +52,7 @@
 
 <script lang="ts">
 import Vue from 'vue'
-import { ref } from '@src/api'
+import { ref } from '@vue/composition-api'
 import { useRafFn } from '@src/vue-use-kit'
 
 export default Vue.extend({
diff --git a/src/components/useRafFn/stories/useRafFn.md b/src/components/useRafFn/stories/useRafFn.md
@@ -52,7 +52,7 @@ function useRafFn(
 
 <script lang="ts">
   import Vue from 'vue'
-  import { ref } from '@src/api'
+  import { ref } from '@vue/composition-api'
   import { useRafFn } from 'vue-use-kit'
 
   export default Vue.extend({
diff --git a/src/components/useRafFn/useRafFn.spec.ts b/src/components/useRafFn/useRafFn.spec.ts
@@ -1,5 +1,5 @@
 import { mount } from '@src/helpers/test'
-import { ref } from '@src/api'
+import { ref } from '@vue/composition-api'
 import { useRafFn } from '@src/vue-use-kit'
 
 let rafSpy: any = null
diff --git a/src/components/useRafFn/useRafFn.ts b/src/components/useRafFn/useRafFn.ts
@@ -1,4 +1,11 @@
-import { ref, isRef, computed, onMounted, onUnmounted, Ref } from '@src/api'
+import {
+  ref,
+  isRef,
+  computed,
+  onMounted,
+  onUnmounted,
+  Ref
+} from '@vue/composition-api'
 
 export type TFps = number | Ref<number>
 
diff --git a/src/components/useSampleComponent/useSampleComponent.ts b/src/components/useSampleComponent/useSampleComponent.ts
@@ -1,4 +1,4 @@
-import { ref, onMounted, onUnmounted } from '@src/api'
+import { ref, onMounted, onUnmounted, Ref } from '@vue/composition-api'
 
 export function useSampleComponent() {
   const isMounted = ref(false)
diff --git a/src/components/useSearchParams/stories/UseSearchParamsDemo.vue b/src/components/useSearchParams/stories/UseSearchParamsDemo.vue
@@ -37,7 +37,7 @@
 
 <script lang="ts">
 import Vue from 'vue'
-import { ref, watch } from '@src/api'
+import { ref, watch } from '@vue/composition-api'
 import { useSearchParams } from '@src/vue-use-kit'
 import Field from './Field.vue'
 
diff --git a/src/components/useSearchParams/useSearchParams.ts b/src/components/useSearchParams/useSearchParams.ts
@@ -1,4 +1,5 @@
-import { ref, onMounted, onUnmounted } from '@src/api'
+import { ref, onMounted, onUnmounted, Ref } from '@vue/composition-api'
+import { UnwrapRef } from '@vue/composition-api/dist/reactivity'
 import { patchHistoryMethodsOnce, normalizeEntriesData } from '@src/utils'
 
 const normalizeParams = (urlParamsObj: { [key: string]: string }) => (
diff --git a/src/components/useTimeout/stories/UseTimeoutDemo.vue b/src/components/useTimeout/stories/UseTimeoutDemo.vue
@@ -29,7 +29,7 @@
 
 <script lang="ts">
 import Vue from 'vue'
-import { computed, ref } from '@src/api'
+import { computed, ref } from '@vue/composition-api'
 import { useTimeout } from '@src/vue-use-kit'
 
 export default Vue.extend({
diff --git a/src/components/useTimeout/useTimeout.spec.ts b/src/components/useTimeout/useTimeout.spec.ts
@@ -1,5 +1,5 @@
 import { mount } from '@src/helpers/test'
-import { computed } from '@src/api'
+import { computed } from '@vue/composition-api'
 import { useTimeout } from '@src/vue-use-kit'
 
 beforeEach(() => {
diff --git a/src/components/useTimeout/useTimeout.ts b/src/components/useTimeout/useTimeout.ts
@@ -1,3 +1,4 @@
+import { Ref } from '@vue/composition-api'
 import { useTimeoutFn } from '@src/components/useTimeoutFn'
 
 const noop = () => null
diff --git a/src/components/useTimeoutFn/stories/UseTimeoutFnDemo.vue b/src/components/useTimeoutFn/stories/UseTimeoutFnDemo.vue
@@ -33,7 +33,7 @@
 
 <script lang="ts">
 import Vue from 'vue'
-import { ref, watch, computed } from '@src/api'
+import { ref, watch, computed } from '@vue/composition-api'
 import { useTimeoutFn } from '@src/vue-use-kit'
 
 export default Vue.extend({
diff --git a/src/components/useTimeoutFn/stories/useTimeoutFn.md b/src/components/useTimeoutFn/stories/useTimeoutFn.md
@@ -46,7 +46,7 @@ function useTimeoutFn(
 
 <script lang="ts">
   import Vue from 'vue'
-  import { ref } from '@src/api'
+  import { ref } from '@vue/composition-api'
   import { useTimeoutFn } from 'vue-use-kit'
 
   export default Vue.extend({
diff --git a/src/components/useTimeoutFn/useTimeoutFn.spec.ts b/src/components/useTimeoutFn/useTimeoutFn.spec.ts
diff --git a/src/components/useTimeoutFn/useTimeoutFn.ts b/src/components/useTimeoutFn/useTimeoutFn.ts
diff --git a/src/helpers/test.ts b/src/helpers/test.ts

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,12 @@`
`14`	`14`	`"prettier/prettier": "error",`
`15`	`15`	`"@typescript-eslint/explicit-function-return-type": "off",`
`16`	`16`	`"@typescript-eslint/no-explicit-any": "off",`
`17`		`- "@typescript-eslint/unbound-method": "off"`
	`17`	`+ "@typescript-eslint/unbound-method": "off",`
	`18`	`+ "@typescript-eslint/no-unused-vars": ["warn", {`
	`19`	`+ "vars": "all",`
	`20`	`+ "args": "after-used",`
	`21`	`+ "ignoreRestSiblings": false,`
	`22`	`+ "varsIgnorePattern": "Ref"`
	`23`	`+ }]`
`18`	`24`	`}`
`19`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { onMounted, onUnmounted, Ref } from '@src/api'`
	`1`	`+import { onMounted, onUnmounted, Ref } from '@vue/composition-api'`
`2`	`2`
`3`	`3`	`const defaultEvents = ['mousedown', 'touchstart']`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { ref, Ref, onUnmounted } from '@src/api'`
	`1`	`+import { ref, onUnmounted, Ref } from '@vue/composition-api'`
`2`	`2`
`3`	`3`	`export function useFullscreen(elRef: Ref<null \| HTMLElement>) {`
`4`	`4`	`const isFullscreen = ref(false)`