BREAKING CHANGE: remove CJS build, polyfills, dependencies

This commit changes revolt.js so that there is no longer a CJS build.
CJS users of revolt.js can still import it using versions of Node.js
after nodejs/node#51977 was merged.

The dependencies on the isomorphic-ws and ws packages were also
removed. This does make the minimum supported version the latest
LTS, Node.js 22. In browsers and Deno, nothing should change.

The dependencies on Solid.js were also removed, making a breaking
change for users who used the reactivity from the Solid.js wrappers.

Import paths throughout the project were rewritten to import from
the original source files everywhere. Prettier, ESLint, and
Typescript were all updated to their latest versions as well.

Signed-off-by: Jersey <[email protected]>

Author: williamhorning

.eslintrc.json

@@ -13,12 +13,12 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ main ]
+    branches: [main]
   schedule:
-    - cron: '40 21 * * 6'
+    - cron: "40 21 * * 6"
 
 jobs:
   analyze:
@@ -32,40 +32,40 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: ["javascript"]
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
         # Learn more:
         # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
+      - name: Checkout repository
+        uses: actions/checkout@v2
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
 
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
 
-    #- run: |
-    #   make bootstrap
-    #   make release
+      #- run: |
+      #   make bootstrap
+      #   make release
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.github/workflows/codeql-analysis.yml

@@ -2,12 +2,7 @@
   "tabWidth": 2,
   "useTabs": false,
   "plugins": ["@trivago/prettier-plugin-sort-imports"],
-  "importOrder": [
-    "^solid",
-    "<THIRD_PARTY_MODULES>",
-    "^\\.\\.",
-    "^[./]"
-  ],
+  "importOrder": ["<THIRD_PARTY_MODULES>", "^\\.\\.", "^[./]"],
   "importOrderSeparation": true,
   "importOrderSortSpecifiers": true
 }

.prettierrc

@@ -1,8 +1,10 @@
 # revolt.js
 
-![revolt.js](https://img.shields.io/npm/v/revolt.js) ![revolt-api](https://img.shields.io/npm/v/revolt-api?label=Revolt%20API)
+![revolt.js](https://img.shields.io/npm/v/revolt.js)
+![revolt-api](https://img.shields.io/npm/v/revolt-api?label=Revolt%20API)
 
-**revolt.js** is a JavaScript library for interacting with the entire Revolt API.
+**revolt.js** is a JavaScript library for interacting with the entire Revolt
+API.
 
 ## Example Usage
 
@@ -14,8 +16,9 @@ const { Client } = require("revolt.js");
 
 let client = new Client();
 
-client.on("ready", async () =>
-  console.info(`Logged in as ${client.user.username}!`)
+client.on(
+  "ready",
+  async () => console.info(`Logged in as ${client.user.username}!`),
 );
 
 client.on("messageCreate", async (message) => {
@@ -26,32 +29,3 @@ client.on("messageCreate", async (message) => {
 
 client.loginBot("..");
 ```
-
-## Reactivity with Signals & Solid.js Primitives
-
-All objects have reactivity built-in and can be dropped straight into any Solid.js project.
-
-```tsx
-const client = new Client();
-// initialise the client
-
-function MyApp() {
-  return (
-    <h1>Your username is: {client.user?.username ?? "[logging in...]"}</h1>
-  );
-}
-```
-
-## Revolt API Types
-
-> [!WARNING]
-> It is advised you do not use this unless necessary. If you find somewhere that isn't covered by the library, please open an issue as this library aims to transform all objects.
-
-All `revolt-api` types are re-exported from this library under `API`.
-
-```typescript
-import { API } from "revolt.js";
-
-// API.Channel;
-// API.[..];
-```

README.md

@@ -0,0 +1,21 @@
+import eslint from "@eslint/js";
+import prettier from "eslint-plugin-prettier/recommended";
+import { defineConfig } from "eslint/config";
+import tseslint from "typescript-eslint";
+
+export default defineConfig([
+  eslint.configs.recommended,
+  tseslint.configs.recommended,
+  {
+    rules: {
+      "@typescript-eslint/no-unused-vars": [
+        "warn",
+        {
+          caughtErrors: "all",
+          varsIgnorePattern: "^_",
+        },
+      ],
+    },
+  },
+  prettier,
+]);

eslint.config.js

@@ -1,17 +1,14 @@
 {
   "name": "revolt.js",
   "version": "7.0.5",
-  "main": "lib/cjs/index.js",
-  "module": "lib/esm/index.js",
-  "types": "lib/esm/index.d.ts",
+  "type": "module",
+  "module": "lib/index.js",
+  "types": "lib/index.d.ts",
   "repository": "https://github.com/revoltchat/revolt.js",
   "author": "Paul Makles <insrt.uk>",
   "license": "MIT",
   "scripts": {
-    "build": "pnpm run build:esm && pnpm run build:cjs",
-    "build:esm": "tsc && cp package-esm.json lib/esm/package.json",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
-    "build:watch": "tsc-watch --onSuccess \"node .\"",
+    "build": "tsc",
     "lint": "eslint --ext .ts,.tsx src/",
     "lint:fix": "eslint --fix --ext .ts,.tsx src/",
     "typecheck": "tsc --noEmit",
@@ -26,32 +23,19 @@
   "description": "Library for interacting with the Revolt API.",
   "packageManager": "[email protected]",
   "dependencies": {
-    "@solid-primitives/map": "^0.4.11",
-    "@solid-primitives/set": "^0.4.11",
     "eventemitter3": "^5.0.1",
-    "isomorphic-ws": "^5.0.0",
-    "long": "^5.2.3",
     "revolt-api": "0.8.3",
-    "solid-js": "^1.8.15",
-    "ulid": "^2.3.0",
-    "ws": "^8.16.0"
+    "ulid": "^2.3.0"
   },
   "devDependencies": {
-    "@mxssfd/typedoc-theme": "^1.1.3",
-    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
-    "@types/node": "^18.19.24",
-    "@types/ws": "^8.5.10",
-    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@typescript-eslint/parser": "^5.62.0",
-    "dotenv": "^16.4.5",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^8.10.0",
-    "eslint-plugin-solid": "^0.12.1",
-    "eslint-plugin-spellcheck": "^0.0.20",
-    "prettier": "^2.8.8",
-    "tsc-watch": "^6.0.4",
-    "typed-emitter": "^2.1.0",
-    "typedoc": "^0.25.1",
-    "typescript": "^5.4.2"
+    "@mxssfd/typedoc-theme": "^1.1.7",
+    "@trivago/prettier-plugin-sort-imports": "^5.2.2",
+    "@types/node": "^22.13.10",
+    "eslint-plugin-prettier": "^5.2.3",
+    "eslint": "^9.22.0",
+    "prettier": "^3.5.3",
+    "typedoc": "^0.27.9",
+    "typescript-eslint": "^8.26.1",
+    "typescript": "^5.8.2"
   }
-}
+}