BREAKING: use Deno tooling

.github/workflows/codeql-analysis.yml

@@ -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/docs.yml

@@ -8,22 +8,14 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repository and submodules
+      - name: Checkout repository
         uses: actions/checkout@v3
+      - name: Setup Deno 2.x
+        uses: denoland/setup-deno@v2
         with:
-          submodules: recursive
-      - uses: pnpm/[email protected]
-      - name: Use Node.js LTS
-        uses: actions/setup-node@v3
-        with:
-          node-version: 22
-          cache: "pnpm"
-      - name: Install packages
-        run: pnpm install
-
+          deno-version: 2.x
       - name: Build
-        run: pnpm run docs
-
+        run: deno task docs
       - name: Deploy
         uses: JamesIves/[email protected]
         with:

.github/workflows/lint.yml

@@ -10,22 +10,15 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repository and submodules
+      - name: Checkout repository
         uses: actions/checkout@v3
+      - name: Setup Deno 2.x
+        uses: denoland/setup-deno@v2
         with:
-          submodules: recursive
-      - uses: pnpm/[email protected]
-      - name: Use Node.js LTS
-        uses: actions/setup-node@v3
-        with:
-          node-version: 22
-          cache: "pnpm"
-      - name: Install packages
-        run: pnpm install
-
+          deno-version: 2.x
       - name: Typecheck
-        run: pnpm typecheck
+        run: deno check src/
       - name: Code Formatting
-        run: pnpm fmt:check
+        run: deno fmt --check
       - name: Lint
-        run: pnpm lint
+        run: deno lint

.github/workflows/npmPublish.ts

@@ -0,0 +1,64 @@
+import { build, emptyDir } from "jsr:@deno/dnt";
+import pkg from "../../deno.json" with { type: "json" };
+import tsc from "../../tsconfig.json" with { type: "json" };
+
+await emptyDir("npm");
+
+await build({
+  entryPoints: ["src/index.ts"],
+  esModule: true,
+  outDir: "npm",
+  scriptModule: false,
+  shims: {},
+  skipNpmInstall: true,
+  skipSourceOutput: true,
+  test: false,
+  package: {
+    name: "revolt.js",
+    version: pkg.version,
+    type: "module",
+    module: "lib/index.js",
+    types: "lib/index.d.ts",
+    repository: {
+      type: "git",
+      url: "git+https://github.com/revoltchat/revolt.js.git",
+    },
+    author: "Paul Makles <insrt.uk>",
+    license: "MIT",
+    description: "Library for interacting with the Revolt API.",
+    dependencies: Object.fromEntries(
+      Object.values(pkg.imports).map((dep) => {
+        dep = dep.replace("npm:", "");
+
+        const lastAtIndex = dep.lastIndexOf("@");
+        return [dep.slice(0, lastAtIndex), dep.slice(lastAtIndex + 1)];
+      }),
+    ),
+    engines: {
+      node: ">=22.0.0",
+    },
+  },
+  compilerOptions: {
+    ...tsc.compilerOptions,
+    lib: ["ES2022", "DOM"],
+    target: "ES2022",
+  },
+  postBuild() {
+    Deno.renameSync("npm/esm", "npm/lib");
+    Deno.removeSync("npm/.npmignore");
+    Deno.copyFileSync("README.md", "npm/README.md");
+    Deno.copyFileSync("LICENSE", "npm/LICENSE");
+
+    const messageEmbedCode = Deno.readTextFileSync(
+      "npm/lib/classes/MessageEmbed.js",
+    ).replace(
+      'import * as dntShim from "../_dnt.shims.js";\n',
+      "",
+    ).replace("dntShim.dntGlobalThis", "globalThis");
+
+    Deno.writeTextFileSync("npm/lib/classes/MessageEmbed.js", messageEmbedCode);
+
+    Deno.removeSync("npm/lib/_dnt.shims.js");
+    Deno.removeSync("npm/lib/_dnt.shims.d.ts");
+  },
+});

.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+# publish to jsr and npm on release
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Setup Deno 2.x
+        uses: denoland/setup-deno@v2
+        with:
+          deno-version: 2.x
+      - name: Setup Node 22.x
+        uses: actions/setup-node@v2
+        with:
+          node-version: 22.x
+      - name: Publish to jsr
+        run: deno publish
+      - name: Build for npm
+        run: deno task npm
+      - name: Publish to npm
+        run: npm publish

.gitignore

@@ -1,15 +1,4 @@
-# build
-node_modules
-.env
-docs
-todo
-/lib
-
-# yarn
-.pnp.*
-.yarn/*
-!.yarn/patches
-!.yarn/plugins
-!.yarn/releases
-!.yarn/sdks
-!.yarn/versions
+/node_modules
+/.env
+/docs
+/npm

.vscode/extensions.json

@@ -1,3 +1,3 @@
 {
-  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
+  "recommendations": ["denoland.vscode-deno"]
 }

.vscode/settings.json

@@ -1,4 +1,7 @@
 {
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.formatOnSave": true
+  "editor.defaultFormatter": "denoland.vscode-deno",
+  "editor.formatOnSave": true,
+  "[github-actions-workflow]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
 }

README.md

@@ -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
 
@@ -11,8 +13,9 @@ import { Client } from "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) => {
@@ -23,32 +26,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.[..];
-```

deno.json

@@ -0,0 +1,28 @@
+{
+  "name": "@revolt/revoltjs",
+  "version": "7.1.0-rc.2",
+  "exports": "./src/index.ts",
+  "imports": {
+    "@vladfrangu/async_event_emitter": "npm:@vladfrangu/async_event_emitter@^2.4.6",
+    "revolt-api": "npm:[email protected]",
+    "ulid": "npm:ulid@^2.3.0"
+  },
+  "tasks": {
+    "docs": "deno run -A npm:typedoc --name revolt.js --readme README.md src/",
+    "npm": "deno run -A .github/workflows/npmPublish.ts"
+  },
+  "fmt": {
+    "indentWidth": 2,
+    "useTabs": false
+  },
+  "lint": {
+    "rules": {
+      "tags": ["recommended", "jsr"]
+    }
+  },
+  "publish": {
+    "exclude": [".github", ".vscode"]
+  },
+  "nodeModulesDir": "auto",
+  "lock": false
+}