Version 0.0.2

Author: DapperBenji

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.0.2] - August 16, 2022
+- Added typescript declarations
+- Fixed some typescript errors
+- Updated readme
+
+## [0.0.1] - July 14, 2022
+- Initial release

README.md

@@ -1,4 +1,4 @@
-# vue3-sticky-directive
+# Vue3 Sticky Directive
 
 Vue3-sticky-directive is a powerful Vue 3 directive make element sticky. This is an implementation of the [vue-sticky-directive](https://github.com/mehwww/vue-sticky-directive) package for Vue 2.
 

index.d.ts

@@ -1,16 +1,19 @@
 {
   "name": "vue3-sticky-directive",
   "author": "DapperBenji <[email protected]>",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "type": "module",
-  "files": [
-    "dist"
-  ],
+  "files": ["dist"],
+  "main": "./dist/index.umd.cjs",
+  "module": "./dist/index.js",
   "exports": {
-    ".": "./dist/index.es.js"
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.umd.cjs"
+    }
   },
   "license": "MIT",
-  "types": "./index.d.ts",
+  "types": "./dist/index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/DapperBenji/vue3-sticky-directive.git"
@@ -29,8 +32,11 @@
     "vue": "3.2.37"
   },
   "devDependencies": {
+    "@types/node": "^18.7.5",
     "@vitejs/plugin-vue": "3.0.0",
-    "typescript": "^4.6.4",
+    "rollup-plugin-typescript2": "^0.32.1",
+    "tslib": "^2.4.0",
+    "typescript": "^4.7.4",
     "vite": "3.0.0",
     "vue-tsc": "0.38.4"
   }

package-lock.json

@@ -1,15 +1,10 @@
-import { App } from 'vue'
+import type { App, Plugin } from 'vue'
 import Sticky from './sticky'
 
-const install = (app: App) => {
-  app.directive('Sticky', Sticky)
-}
-
-/* @ts-ignore */
-Sticky.install = install
-
-export default {
-   install: (app: App) => {
+export const StickyPlugin: Plugin = {
+   install(app: App) {
       app.directive('Sticky', Sticky)
    }
 }
+
+export default StickyPlugin

package.json

@@ -15,5 +15,6 @@
     "skipLibCheck": true
   },
   "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"],
-  "references": [{ "path": "./tsconfig.node.json" }]
+  "references": [{ "path": "./tsconfig.node.json" }],
+  "types": ["node"]
 }

src/index.ts

@@ -1,15 +1,16 @@
-import path from 'path'
+import { resolve } from 'path'
 import { defineConfig } from 'vite'
 import vue from '@vitejs/plugin-vue'
+import typescript from 'rollup-plugin-typescript2'
 
-// https://vitejs.dev/config/
 export default defineConfig({
    build: {
+      minify: true,
       lib: {
-         entry: path.resolve(__dirname, 'src/index.ts'),
+         entry: resolve(__dirname, 'src/index.ts'),
          name: 'vue3-sticky-directive',
          formats: ['es', 'cjs'],
-         fileName: (format) => `index.${format}.js`
+         fileName: (format) => (format === 'es' ? 'index.js' : 'index.umd.cjs')
       },
       rollupOptions: {
          external: ['vue'],
@@ -21,6 +22,22 @@ export default defineConfig({
       }
    },
    plugins: [
-      vue()
+      vue(),
+      typescript({
+         check: false,
+         tsconfig: 'tsconfig.json',
+         include: [
+            'src/index.ts',
+            'src/sticky.ts'
+         ],
+         tsconfigOverride: {
+            compilerOptions: {
+               declaration: true
+            }
+         },
+         exclude: [
+            'vite.config.ts'
+         ]
+      })
    ]
 })