Modernize linting and formatting stack

.github/workflows/push-checks.yml

@@ -3,12 +3,12 @@ name: Push Checks
 on: [push, pull_request]
 
 jobs:
-  test-ubuntu:
+  lint-and-format:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [16.x, 15.x, 14.x]
+        node-version: [20.x, 18.x]
 
     steps:
       - uses: actions/checkout@v1
@@ -18,25 +18,11 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - name: npm install & test
         run: |
-          npm ci
-          npm test
+          corepack enable
+          yarn install
+          yarn lint
+          yarn ts:check
         env:
           CI: true
       - name: Codecov Action
         uses: codecov/codecov-action@v1
-
-  lint:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v1
-      - name: Use Node.js 16.x
-        uses: actions/setup-node@v1
-        with:
-          node-version: 16.x
-      - name: npm lint:check
-        run: |
-          npm ci
-          npm run lint:check
-        env:
-          CI: true

eslint.config.js

@@ -0,0 +1,46 @@
+import js from "@eslint/js";
+import typescript from "@typescript-eslint/eslint-plugin";
+import tsParser from "@typescript-eslint/parser";
+import prettier from "eslint-config-prettier";
+
+export default [
+  js.configs.recommended,
+  {
+    files: ["**/*.ts", "**/*.tsx"],
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        ecmaVersion: "latest",
+        sourceType: "module",
+        project: "./tsconfig.json",
+      },
+      globals: {
+        console: true,
+        Buffer: true,
+        setTimeout: true,
+      },
+    },
+    plugins: {
+      "@typescript-eslint": typescript,
+    },
+    rules: {
+      ...typescript.configs.recommended.rules,
+      "@typescript-eslint/no-explicit-any": "error",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        { argsIgnorePattern: "^_" },
+      ],
+    },
+  },
+  {
+    ignores: [
+      "node_modules/**",
+      "dist/**",
+      "coverage/**",
+      "*.js",
+      "*.cjs",
+      "*.mjs",
+    ],
+  },
+  prettier,
+];

package.json

@@ -6,7 +6,10 @@
   "typings": "dist/index.d.ts",
   "scripts": {
     "build": "tsc",
-    "lint": "tslint -p tsconfig.json",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write .",
+    "ts:check": "tsc --noEmit",
     "prepublishOnly": "yarn build",
     "benchmark": "yarn build && yarn node dist/benchmark/index.js",
     "benchmark:ws:server": "yarn build && yarn node dist/benchmark/ws/simple/server.js",
@@ -18,11 +21,17 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
+    "@eslint/js": "latest",
     "@faker-js/faker": "^9.2.0",
     "@types/node": "^22.9.0",
     "@types/ws": "^8",
+    "@typescript-eslint/eslint-plugin": "latest",
+    "@typescript-eslint/parser": "latest",
     "cbor-x": "^1.6.0",
+    "eslint": "latest",
+    "eslint-config-prettier": "latest",
     "msgpackr": "^1.11.2",
+    "prettier": "^3.4.2",
     "sializer": "0",
     "tinybench": "^3.0.6",
     "ts-proto": "^2.4.2",

src/ascii.ts

@@ -2,7 +2,7 @@ export const asciiToUint8Array = (
   str: string,
   strLength: number,
   buffer: Uint8Array,
-  offset: number
+  offset: number,
 ) => {
   for (let i = 0; i < strLength; i++) {
     buffer[offset + i] = str.charCodeAt(i);
@@ -19,14 +19,14 @@ const fns = new Array(66).fill(0).map((_, i) => {
     "buf",
     "length",
     "offset",
-    `return String.fromCharCode(${codes});`
+    `return String.fromCharCode(${codes});`,
   );
 });
 
 export const uint8ArrayToAscii = (
   buffer: Uint8Array,
   byteLength: number,
-  offset: number
+  offset: number,
 ) => {
   return fns[byteLength](buffer, byteLength, offset);
 };

src/benchmark/tests/sia.ts

@@ -1,6 +1,5 @@
-import { fiveThousandUsers } from "./common.js";
 import { Sia } from "../../index.js";
-import assert from "assert";
+import { fiveThousandUsers } from "./common.js";
 
 const sia = new Sia();
 

src/benchmark/ws/heavy/index.ts

@@ -61,7 +61,7 @@ const bench = new Bench({ name: "RPC", time: 10 * 1000 });
 const makeRpcCall = async (
   ws: WebSocket,
   ondata: (data: Buffer) => void,
-  payload: Uint8Array
+  payload: Uint8Array,
 ) =>
   new Promise((resolve) => {
     ws.send(payload, { binary: true });
@@ -76,29 +76,31 @@ const makeRpcCall = async (
 bench
   .add(
     "JSON",
-    async () => await makeRpcCall(clients.json, callbacks.json, payloads.json())
+    async () =>
+      await makeRpcCall(clients.json, callbacks.json, payloads.json()),
   )
   .addEventListener("complete", () => clients.json.close());
 
 bench
   .add(
     "Sia",
-    async () => await makeRpcCall(clients.sia, callbacks.sia, payloads.sia())
+    async () => await makeRpcCall(clients.sia, callbacks.sia, payloads.sia()),
   )
   .addEventListener("complete", () => clients.sia.close());
 
 bench
   .add(
     "CBOR",
-    async () => await makeRpcCall(clients.cbor, callbacks.cbor, payloads.cbor())
+    async () =>
+      await makeRpcCall(clients.cbor, callbacks.cbor, payloads.cbor()),
   )
   .addEventListener("complete", () => clients.cbor.close());
 
 bench
   .add(
     "MsgPack",
     async () =>
-      await makeRpcCall(clients.msgpack, callbacks.msgpack, payloads.msgpack())
+      await makeRpcCall(clients.msgpack, callbacks.msgpack, payloads.msgpack()),
   )
   .addEventListener("complete", () => clients.msgpack.close());