improve CI

Author: YieldRay

.github/workflows/ci.yml

@@ -14,12 +14,10 @@ jobs:
             fail-fast: false
             matrix:
                 deno:
-                    - v1.x
-                    - canary
+                    - v2.x
                 os:
                     - ubuntu-22.04
                     - windows-2022
-                    - macOS-12
 
         steps:
             - name: Clone repository
@@ -28,11 +26,11 @@ jobs:
                   submodules: true
 
             - name: Set up Deno
-              uses: denoland/setup-deno@v1
+              uses: denoland/setup-deno@v2
               with:
                   deno-version: ${{ matrix.deno }}
 
-            - name: Run tests canary
+            - name: Run tests
               run: deno task test
 
             - name: Generate lcov
@@ -56,12 +54,25 @@ jobs:
                   persist-credentials: false
 
             - name: Set up Deno
-              uses: denoland/setup-deno@v1
-              with:
-                  deno-version: canary
+              uses: denoland/setup-deno@v2
 
             - name: Format
               run: deno fmt --check
 
             - name: Lint
               run: deno task lint
+
+            - name: Build for NPM
+              run: deno task build
+
+            - name: Publish (dry run)
+              run: deno publish --allow-dirty --dry-run
+
+            - name: Set up Node
+              uses: actions/setup-node@v4
+              with:
+                  node-version: '22.x'
+                  registry-url: 'https://registry.npmjs.org'
+
+            - name: NPM (dry run)
+              run: npm publish --dry-run

.github/workflows/publish.yml

@@ -3,8 +3,6 @@ name: publish
 on:
     push:
         branches: [main]
-    release:
-        types: [published]
 
 jobs:
     publish:
@@ -20,37 +18,32 @@ jobs:
               uses: actions/checkout@v4
 
             - name: Set up Deno
-              uses: denoland/setup-deno@v1
+              uses: denoland/setup-deno@v2
 
             - name: Format
               run: deno fmt
 
             - name: Type check
               run: deno task test
 
-            - name: Publish (dry run)
-              if: github.event_name == 'push'
-              run: deno publish --allow-dirty --dry-run
+            - name: Build for NPM
+              run: deno task build
 
             - name: Publish (real)
-              if: github.event_name == 'release'
               run: deno publish --allow-dirty
 
-            - name: Build for NPM
-              run: deno task build
-
-            - name: Set up Node
-              uses: actions/setup-node@v4
+            - name: NPM (real)
+              id: publish
+              uses: JS-DevTools/npm-publish@v3
               with:
-                  node-version: '20.x'
-                  registry-url: 'https://registry.npmjs.org'
-
-            - name: NPM (dry run)
-              if: github.event_name == 'push'
-              run: npm publish --dry-run
+                  token: ${{secrets.NPM_TOKEN}}
+                  access: public
+                  provenance: true
 
-            - name: NPM (real)
-              if: github.event_name == 'release'
-              run: npm publish --provenance --access public
-              env:
-                  NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+            - name: Release on GitHub
+              if: ${{ steps.publish.outputs.type }}
+              uses: softprops/action-gh-release@v1
+              with:
+                  tag_name: v${{ steps.publish.outputs.version }}
+                  draft: false
+                  generate_release_notes: true

README.md

@@ -23,7 +23,7 @@ npm install @yieldray/json-rpc-ts
 For Deno
 
 ```sh
-deno add @yieldray/json-rpc-ts
+deno add jsr:@yieldray/json-rpc-ts
 ```
 
 # Examples

build.ts

@@ -1,5 +1,3 @@
-import { execSync } from 'node:child_process'
-
 const pkg = JSON.parse(Deno.readTextFileSync('./deno.json'))
 
 try {
@@ -45,5 +43,11 @@ Deno.writeTextFileSync('./package.json', JSON.stringify(packageJson, null, 4))
 console.log('New package.json created.')
 console.log(packageJson)
 
-console.log('Building package using unbuild...')
-execSync('npx -y [email protected]', { stdio: ['ignore', 'inherit', 'inherit'] })
+const builderName = '[email protected]'
+console.log(`Building package using ${builderName}...`)
+new Deno.Command('npx', {
+    args: ['-y', builderName],
+    stdin: 'null',
+    stdout: 'inherit',
+    stderr: 'inherit',
+}).spawn()

deno.json

@@ -20,7 +20,7 @@
         "useUnknownInCatchVariables": true,
         "noImplicitOverride": true
     },
-    "imports": { "@std/assert": "jsr:@std/assert@^1.0.6" },
+    "imports": { "@std/assert": "jsr:@std/assert@^1.0.13" },
     "tasks": {
         "lint": "deno lint",
         "fmt": "deno fmt",

deno.lock

@@ -52,6 +52,9 @@ export class JSONRPCClient<
         this.idGenerator = idGenerator || selfAddIdGenerator()
     }
 
+    /**
+     * Creates a JSON-RPC request object with an automatically generated ID.
+     */
     public createRequest<T extends keyof Methods>(
         method: T extends string ? T : never,
         params: Parameters<Methods[T]>[0],

src/client.ts

@@ -36,7 +36,7 @@ export class JSONRPCError extends Error implements JSONRPCErrorInterface {
 }
 
 /**
- * This ONLY check if `x` is `JSONRPCErrorInterface`
+ * This function ONLY check that if `x` is `JSONRPCErrorInterface`
  *
  * Because it'a shared method between client and server, but `JSONRPCError` is server side only
  */

src/dto/errors.ts

@@ -3,6 +3,9 @@ export type JSONRPCID =
     | number // SHOULD NOT contain fractional parts
     | null // unknown id
 
+/**
+ * Creates a generator that yields incrementing numeric IDs starting from 1.
+ */
 export function* selfAddIdGenerator(): Generator<number, void, unknown> {
     let count = 0
     for (;;) {
@@ -24,6 +27,12 @@ export function getIDFromGenerator(g: IDGenerator): JSONRPCID {
     }
 }
 
+/**
+ * Checks if the given value is a valid JSON-RPC ID.
+ * A valid JSON-RPC ID can be a string, a number (without fractional parts), or null.
+ */
 export function isJSONRPCID(x: unknown): x is JSONRPCID {
-    return typeof x === 'string' || typeof x === 'number' || x === null
+    return typeof x === 'string' ||
+        (typeof x === 'number' && Number.isInteger(x)) ||
+        x === null
 }

src/id.ts

@@ -31,7 +31,7 @@ export interface JSONRPCMethods {
 }
 
 /**
- * Represent any json rpc method, any detailed method should extend it
+ * Represents any JSON-RPC method. Detailed methods should extend this type.
  */
 export type JSONRPCMethod<Params, Result> = (
     params: Params,

src/types.ts

@@ -14,6 +14,7 @@
       "strict": true,
       "target": "esnext",
       "useDefineForClassFields": true,
-      "allowImportingTsExtensions": true
+      "allowImportingTsExtensions": true,
+      "noEmit": true
     }
   }