feature: Migrated to vite (#9)

Author: a-bugaj

.eslintrc.json

@@ -32,13 +32,6 @@
         ],
         "no-nested-ternary": "warn",
         "@typescript-eslint/no-shadow": "off",
-        "@typescript-eslint/naming-convention": [
-            "error",
-            {
-                "selector": "enum",
-                "format": ["UPPER_CASE"]
-            }
-        ],
         "no-useless-catch": "error",
         "no-underscore-dangle": "off",
         "@typescript-eslint/no-invalid-void-type": "off"

README.md

@@ -13,6 +13,7 @@ $ npm install awesome-pubsub-js
 ```
 
 ### yarn
+
 ```shell
 $ yarn add awesome-pubsub-js
 ```
@@ -26,7 +27,7 @@ Do you want to know more? Go to the [Documentation](#API) section
 ```js
 import PubSub from "awesome-pubsub-js";
 
-const pubSub = PubSub();
+const pubSub = new PubSub();
 
 pubSub.subscribe("event.example", (data) => {
     // data = { name: "John", email: "john@gmail.com" }
@@ -37,20 +38,19 @@ pubSub.publish("event.example", { name: "John", email: "john@gmail.com" });
 ```
 
 ### API
+
 **List of all available methods:**
 
 Each of the following methods takes one or two arguments
 
 - Subscribe
 
-
-| Method name | Payload | Return value |
-| ------ | ------ | ------ |
-| subscribe | ```pubSub.subscribe("eventName", (data) => {});```| HashKey (string) - is needed for use in the 'unsubscribe' method |
-| unsubscribe | ```pubSub.unsubscribe('hashKey')``` <br /> hashKey (string) is always returned from the subscribe method | true - when the event has been successfully unsubscribed <br /> false - when the event does not exists | 
-| publish | ```pubSub.publish('eventName', any)``` <br /> any = literally anything you want to pass :) <br /> If you don't pass anything, the default value will be undefined | true - when the event has published successfully <br /> false - when the event has not been published (e.g. due to the lack of a registered subscriber) | 
-| getAllSubscribers |  - | returns the current subscription list |
-
+| Method name       | Payload                                                                                                                                                       | Return value                                                                                                                                            |
+| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| subscribe         | `pubSub.subscribe("eventName", (data) => {});`                                                                                                                | HashKey (string) - is needed for use in the 'unsubscribe' method                                                                                        |
+| unsubscribe       | `pubSub.unsubscribe('hashKey')` <br /> hashKey (string) is always returned from the subscribe method                                                          | true - when the event has been successfully unsubscribed <br /> false - when the event does not exists                                                  |
+| publish           | `pubSub.publish('eventName', any)` <br /> any = literally anything you want to pass :) <br /> If you don't pass anything, the default value will be undefined | true - when the event has published successfully <br /> false - when the event has not been published (e.g. due to the lack of a registered subscriber) |
+| getAllSubscribers | -                                                                                                                                                             | returns the current subscription list                                                                                                                   |
 
 ### Roadmap:
 
@@ -59,4 +59,3 @@ Each of the following methods takes one or two arguments
 - [x] getAllSubscribers method
 - [ ] Wildcard support
 - [ ] Logger
-    

__tests__/pubSub.test.ts

@@ -1,14 +1,13 @@
-/* eslint-disable @typescript-eslint/ban-ts-comment */
-import PubSub, { PubSubInterface } from "../lib";
+import PubSub from "../lib";
 
 // eslint-disable-next-line @typescript-eslint/no-empty-function
 const noop = (): void => {};
 
 describe("PubSub -> Default Instance", () => {
-    let pubSub: PubSubInterface;
+    let pubSub: PubSub;
 
     beforeEach(() => {
-        pubSub = PubSub();
+        pubSub = new PubSub();
     });
 
     it("Should create an instance of pubsub with an empty subscription list", () => {
@@ -17,10 +16,10 @@ describe("PubSub -> Default Instance", () => {
 });
 
 describe("PubSub -> Subscribe Method", () => {
-    let pubSub: PubSubInterface;
+    let pubSub: PubSub;
 
     beforeEach(() => {
-        pubSub = PubSub();
+        pubSub = new PubSub();
     });
 
     it("Should add event to the subscriptions list, with generated hash key and forwarded callback ", () => {
@@ -82,10 +81,10 @@ describe("PubSub -> Subscribe Method", () => {
 });
 
 describe("PubSub -> Unsubscribe Method", () => {
-    let pubSub: PubSubInterface;
+    let pubSub: PubSub;
 
     beforeEach(() => {
-        pubSub = PubSub();
+        pubSub = new PubSub();
     });
 
     it("Should remove event from the subscribers array", () => {
@@ -186,14 +185,14 @@ describe("PubSub -> Unsubscribe Method", () => {
 });
 
 describe("PubSub -> Publish method", () => {
-    let pubSub: PubSubInterface;
+    let pubSub: PubSub;
     const data = {
         name: "John",
         age: 50,
     };
 
     beforeEach(() => {
-        pubSub = PubSub();
+        pubSub = new PubSub();
     });
 
     it("Should publish event with payload", () => {

__tests__/pubSub.typings.test.ts

@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 import PubSub from "../lib";
 
 enum Event {
@@ -8,7 +9,7 @@ interface Data {
     name: string;
 }
 
-const pubSub = PubSub();
+const pubSub = new PubSub();
 
 // publish method
 pubSub.publish<Event, Data>(Event.Random, { name: "John" });
@@ -19,13 +20,9 @@ pubSub.publish("event.without.types", []);
 
 // subscribe method
 pubSub.subscribe<Event, Data>(Event.Random, (data) => {
-    data.name;
+    console.log(data.name);
 });
 
 pubSub.subscribe<Event>(Event.Random, () => {
     // empty payload
 });
-
-pubSub.subscribe<Event.Random, Data>(Event.Random, (data) => {
-    data.name;
-});

lib/pubSub.ts

@@ -5,6 +5,7 @@ type Callback<D = unknown> = (data?: D) => void;
 interface Subscribers {
     eventName: string;
     hashKey: HashKey;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     callback: Callback<any>;
 }
 
@@ -15,9 +16,9 @@ export class PubSub {
         this.subscribers = [];
     }
 
-    subscribe = <E extends string, D = (data?: unknown) => void>(
+    subscribe = <E extends string, D = undefined>(
         event: E,
-        callback: Callback<D>
+        callback: (data: D extends undefined ? void : D) => void
     ): HashKey => {
         const hashKey = randomHashKeyGenerator();
 

package.json

@@ -1,6 +1,7 @@
 {
     "name": "awesome-pubsub-js",
-    "version": "1.2.1",
+    "version": "2.0.0",
+    "type": "module",
     "description": "JavaScript implementation of the Publish/Subscribe pattern with TypeScript support.",
     "main": "dist/index.cjs.js",
     "types": "dist/index.d.ts",

tsconfig.json

@@ -25,7 +25,5 @@
         "noUnusedParameters": true,
         "noFallthroughCasesInSwitch": true,
         "noImplicitAny": true
-    },
-    "include": ["./lib/**/*"],
-    "exclude": ["./__tests__", "./webpack.config.ts"]
+    }
 }

vite.config.ts

@@ -1,7 +1,11 @@
 import { defineConfig } from "vite";
+import { fileURLToPath } from "url";
 import path from "path";
 import dts from "vite-plugin-dts";
 
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
 export default defineConfig({
     build: {
         lib: {