fix: remove manual types. add rollup plugin. update docs

guastallaigor · Jun 5, 2021 · a8e6f21 · a8e6f21
1 parent df2dbd2
commit a8e6f21
Show file tree

Hide file tree

Showing 8 changed files with 69 additions and 260 deletions.
diff --git a/docs/pages/en/1.getting-started/1.installation.md b/docs/pages/en/1.getting-started/1.installation.md
@@ -43,18 +43,6 @@ You can now start using [`<vue-testimonials>`](/component/vue-testimonials) in y
 Remember that Vue Testimonials only supports Vue 3 (and Vite) projects!
 :::
 
-## TypeScript
-
-If you're using TypeScript, you may want to add additional types in your "types" array at `tsconfig.json`.
-
-```json [tsconfig.json]
-{
-  "compilerOptions": {
-    "types": ["vue-testimonials", "vite/client"]
-  }
-}
-```
-
 ## Upgrading
 
 :::alert{type="warning"}

diff --git a/lib/index.d.ts b/lib/index.d.ts
diff --git a/lib/index.ts b/lib/index.ts
@@ -3,24 +3,24 @@ import VueTestimonials from './component/VueTestimonials.vue'
 
 let installed = false
 
-function installFunction(Vue: App): void {
+function install(Vue: App): void {
   if (installed) return
   installed = true
   Vue.component(VueTestimonials.name, VueTestimonials)
 }
 
-let GlobalVue = null
+let GlobalVue: any
 
-const plugin = { install: installFunction }
+const plugin = { install }
 
-if (typeof window !== 'undefined') {
-  GlobalVue = (window as any).Vue
-} else if (typeof global !== 'undefined') {
-  GlobalVue = (global as any).Vue
+if (window && 'Vue' in window) {
+  GlobalVue = window['Vue']
+} else if (global && 'Vue' in global) {
+  GlobalVue = global['Vue']
 }
 
-if (GlobalVue) {
+if (GlobalVue && typeof GlobalVue.use === 'function') {
   GlobalVue.use(plugin)
 }
 
-export default { install: installFunction }
+export default { install }
diff --git a/lib/local-types/index.d.ts b/lib/local-types/index.d.ts
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "vue-testimonials",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "Vue Testimonials is a Vue 3 testimonials component made with Vite and TypeScript",
   "homepage": "https://github.com/guastallaigor/vue-testimonials#readme",
   "author": {
@@ -37,7 +37,7 @@
   ],
   "scripts": {
     "dev": "vite",
-    "build": "vue-tsc --noEmit && vite build && cpx 'lib/index.d.ts' 'dist'",
+    "build": "vue-tsc --noEmit && vite build",
     "serve": "vite preview",
     "lint:eslint": "eslint lib/**/*.{ts,vue}",
     "lint:prettier": "prettier -w -u lib/**/*.{ts,vue}",
@@ -67,6 +67,7 @@
     "eslint-plugin-vue": "^7.10.0",
     "husky": "^6.0.0",
     "prettier": "^2.3.0",
+    "rollup-plugin-typescript2": "^0.30.0",
     "typescript": "^4.1.3",
     "vite": "^2.3.5",
     "vite-svg-loader": "^2.0.2",

diff --git a/tsconfig.json b/tsconfig.json
@@ -9,6 +9,7 @@
     "sourceMap": true,
     "resolveJsonModule": true,
     "skipLibCheck": true,
+    "noImplicitAny": false,
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
     "experimentalDecorators": true,

diff --git a/vite.config.ts b/vite.config.ts
@@ -1,6 +1,7 @@
 import type { UserConfig } from 'vite'
 import svgLoader from 'vite-svg-loader'
 import vue from '@vitejs/plugin-vue'
+import typescript from 'rollup-plugin-typescript2'
 const path = require('path')
 
 const config: UserConfig = {
@@ -12,7 +13,7 @@ const config: UserConfig = {
       },
     ],
   },
-  plugins: [vue(), svgLoader()],
+  plugins: [vue(), svgLoader(), typescript()],
   build: {
     lib: {
       entry: path.resolve(__dirname, 'lib/index.ts'),