Set up linting with Biome and swap to pnpm (#27)

Also adds an action to run the checks in CI.

.changes/config.json

@@ -4,9 +4,7 @@
     "javascript": {
       "version": true,
       "getPublishedVersion": "npm view ${ pkgFile.pkg.name } version",
-      "publish": [
-        "npm publish --access public"
-      ],
+      "publish": ["pnpm publish --access public"],
       "postpublish": [
         "git tag ${ pkg.pkg }-v${ pkgFile.versionMajor } -f",
         "git tag ${ pkg.pkg }-v${ pkgFile.versionMajor }.${ pkgFile.versionMinor } -f",
@@ -16,12 +14,8 @@
     "rust": {
       "version": true,
       "getPublishedVersion": "cargo search ${ pkg.pkg } --limit 1 | sed -nE 's/^[^\"]*\"//; s/\".*//1p'",
-      "prepublish": [
-        "cargo generate-lockfile"
-      ],
-      "publish": [
-        "cargo publish"
-      ],
+      "prepublish": ["cargo generate-lockfile"],
+      "publish": ["cargo publish"],
       "postpublish": [
         "git tag ${ pkg.pkg }-v${ pkgFile.versionMajor } -f",
         "git tag ${ pkg.pkg }-v${ pkgFile.versionMajor }.${ pkgFile.versionMinor } -f",
@@ -41,9 +35,7 @@
     "qubit": {
       "path": ".",
       "manager": "rust",
-      "dependencies": [
-        "qubit-macros"
-      ]
+      "dependencies": ["qubit-macros"]
     }
   }
 }

.github/workflows/checks.yml

@@ -0,0 +1,66 @@
+name: checks
+
+on: push
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: corepack enable pnpm
+      - uses: actions/setup-node@v4
+      - run: pnpm i
+      - run: pnpm lint --error-on-warnings
+
+  typecheck:
+    strategy:
+      fail-fast: false
+      matrix:
+        dir:
+          - packages/client
+          - examples/authentication/auth-demo
+          - examples/chaos
+          - examples/chat-room-react
+          - examples/counter
+          - examples/hello-world
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: corepack enable pnpm
+      - uses: actions/setup-node@v4
+        with:
+          cache: pnpm
+          cache-dependency-path: '**/pnpm-lock.yaml'
+      - name: Build client package
+        run: pnpm i && pnpm build
+        working-directory: packages/client
+        if: ${{ matrix.dir != 'packages/client' }}
+      - run: pnpm i
+        working-directory: ${{ matrix.dir }}
+      - run: pnpm tsc
+        working-directory: ${{ matrix.dir }}
+
+  clippy:
+    strategy:
+      fail-fast: false
+      matrix:
+        dir:
+          - '.'
+          - examples/authentication
+          - examples/chaos
+          - examples/chat-room-react/src-rust
+          - examples/counter
+          - examples/hello-world
+
+    env:
+      RUSTFLAGS: "-Dwarnings" # Fail on warnings
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: cargo clippy
+        working-directory: ${{ matrix.dir }}

.github/workflows/covector-status.yml

@@ -1,16 +1,17 @@
 name: covector status
-on: [pull_request]
+
+on: pull_request
 
 jobs:
   covector:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0 # required for use of git history
       - name: covector status
         uses: jbolda/covector/packages/[email protected]
         id: covector
         with:
-          command: 'status'
+          command: status

.github/workflows/covector-version-or-publish.yml

@@ -15,12 +15,14 @@ jobs:
       successfulPublish: ${{ steps.covector.outputs.successfulPublish }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0 # required for use of git history
-      - uses: actions/setup-node@v3
+      - run: corepack enable pnpm
+      - uses: actions/setup-node@v4
         with:
-          node-version: 14
+          cache: pnpm
+          cache-dependency-path: '**/pnpm-lock.yaml'
           registry-url: 'https://registry.npmjs.org'
       - name: cargo login
         run: cargo login ${{ secrets.CRATE_TOKEN }}

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["rust-lang.rust-analyzer", "biomejs.biome"]
+}

.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "biomejs.biome",
+  "editor.codeActionsOnSave": {
+    "source.organizeImports.biome": "explicit"
+  },
+  "rust-analyzer.check.command": "clippy",
+  "[rust]": {
+    "editor.defaultFormatter": "rust-lang.rust-analyzer",
+    "editor.formatOnSave": true
+  }
+}

README.md

@@ -4,6 +4,7 @@
     <a href="https://crates.io/crates/qubit"><img src="https://img.shields.io/crates/v/qubit" alt="crates.io" /></a>
     <a href="https://docs.rs/qubit/latest/qubit"><img src="https://img.shields.io/docsrs/qubit" alt="docs.rs" /></a>
     <a href="https://www.npmjs.com/package/@qubit-rs/client"><img src="https://img.shields.io/npm/v/%40qubit-rs%2Fclient" alt="npm" /></a>
+    <a href="https://github.com/andogq/qubit/actions/workflows/checks.yml"><img src="https://github.com/andogq/qubit/actions/workflows/checks.yml/badge.svg" alt="checks" /></a>
 </div>
 
 Tired of wrestling with RPC boilerplate? Qubit simplifies communication between your Rust services

biome.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true,
+    "defaultBranch": "main"
+  },
+  "files": {
+    "include": ["*.ts", "*.tsx", "*.json"],
+    "ignore": ["bindings.ts", "cookie-auth.ts", "mutable-ctx.ts"]
+  },
+  "organizeImports": {
+    "enabled": true
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "correctness": {
+        "noUnusedImports": "warn",
+        "noUnusedVariables": "warn"
+      }
+    }
+  },
+  "formatter": {
+    "indentStyle": "space",
+    "lineWidth": 120
+  },
+  "overrides": [
+    {
+      "include": ["packages/client/**/*.ts"],
+      "linter": {
+        "rules": {
+          "suspicious": {
+            "noExplicitAny": "warn"
+          }
+        }
+      }
+    }
+  ]
+}

examples/authentication/README.md

@@ -12,6 +12,7 @@ In another terminal, install TypeScript dependencies, and run the client!
 
 ```sh
 cd auth-demo
-npm i
-npm run dev
+corepack enable # if not enabled
+pnpm i
+pnpm dev
 ```