add coverage

Author: YieldRay

.github/workflows/ci.yml

@@ -0,0 +1,67 @@
+name: ci
+
+on:
+    push:
+        branches: [main]
+    pull_request:
+        branches: [main]
+
+jobs:
+    test:
+        runs-on: ${{ matrix.os }}
+        timeout-minutes: 30
+        strategy:
+            fail-fast: false
+            matrix:
+                deno:
+                    - v1.x
+                    - canary
+                os:
+                    - ubuntu-22.04
+                    - windows-2022
+                    - macOS-12
+
+        steps:
+            - name: Clone repository
+              uses: actions/checkout@v4
+              with:
+                  submodules: true
+
+            - name: Set up Deno
+              uses: denoland/setup-deno@v1
+              with:
+                  deno-version: ${{ matrix.deno }}
+
+            - name: Run tests canary
+              run: deno task test
+
+            - name: Generate lcov
+              run: deno task cov:gen
+
+            - name: Upload coverage
+              uses: codecov/codecov-action@v3
+              env:
+                  CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+              with:
+                  name: ${{ matrix.os }}-${{ matrix.deno }}
+                  files: cov.lcov
+
+    lint:
+        runs-on: ubuntu-22.04
+        steps:
+            - name: Clone repository
+              uses: actions/checkout@v4
+              with:
+                  submodules: false
+                  persist-credentials: false
+
+            - name: Set up Deno
+              uses: denoland/setup-deno@v1
+              with:
+                  deno-version: canary
+
+            - name: Format
+              run: deno fmt --check
+
+            - name: Lint
+              run: deno task lint

.gitignore

@@ -1 +1,3 @@
 docs/
+coverage/
+cov.lcov

README.md

@@ -1,8 +1,9 @@
 # json-rpc-ts
 
 [![deno.land/x](https://shield.deno.dev/x/json_rpc_ts)](https://deno.land/x/json_rpc_ts)
+[![ci](https://github.com/yieldray/json-rpc-ts/actions/workflows/ci.yml/badge.svg)](https://github.com/yieldray/json-rpc-ts/actions/workflows/ci.yml)
 
-A strictly typed json-rpc(2.0) implemention, zero dependency, minimal abstraction, with simple api
+A strictly typed json-rpc(2.0) implementation, zero dependency, minimal abstraction, with simple api
 
 > Specification <https://www.jsonrpc.org/specification>
 
@@ -14,19 +15,29 @@ const methodSet = {
     minus: ([a, b]: [number, number]) => a - b,
 }
 
+// initialize all methods with the constructor
 const server = new JSONRPCServer(methodSet)
 
+// or add methods manually
+const server = new JSONRPCServer<typeof methodSet>()
+server.setMethod('upper', methodSet.upper)
+server.setMethod('lower', methodSet.lower)
+server.setMethod('plus', methodSet.plus)
+server.setMethod('minus', methodSet.minus)
+
+// (optional) provide a generic parameter to enable ts check
 const client = new JSONRPCClient<typeof methodSet>((json) =>
     server.process(json)
 )
 
+// request, Notification and batch are always async
 assertEquals(await client.request('upper', 'hello'), 'HELLO')
 
 assertEquals(
     await client.batch(
         client.createRequest('upper', 'nihao'),
-        // notifaction does not have response, even when response errors
-        client.createNotifaction('upper'),
+        // Notification does not have response, even when response errors
+        client.createNotification('upper'),
         client.createRequest('upper', 'shijie'),
         client.createRequest('plus', [1, 1]),
     ),
@@ -85,3 +96,13 @@ const httpServer = Deno.serve(
     },
 )
 ```
+
+# build for JavaScript
+
+To use this library without typescript, you have to build it to javascript.
+
+```sh
+git clone https://github.com/YieldRay/json-rpc-ts.git
+cd json-rpc-ts
+esbuild --bundle src/index.ts --outdir=dist --format=esm
+```

deno.json

@@ -1,17 +1,38 @@
 {
+    "compilerOptions": {
+        "strict": true,
+        "useUnknownInCatchVariables": true,
+        "noImplicitOverride": true
+    },
     "imports": {
         "std/": "https://deno.land/[email protected]/"
     },
     "tasks": {
-        "docs": "deno doc --html --name=json-rpc-ts --output=./docs/ ./src/index.ts"
+        "lint": "deno lint",
+        "fmt": "deno fmt",
+        "docs": "deno doc --html --name=json-rpc-ts --output=./docs/ ./mod.ts",
+        "test": "deno test --parallel --coverage --trace-ops",
+        "cov:gen": "deno coverage coverage --lcov --output=cov.lcov",
+        "cov:view": "deno coverage --html coverage",
+        "cov:clean": "rm -rf ./coverage/ cov.lcov"
     },
     "fmt": {
         "lineWidth": 80,
         "semiColons": false,
         "indentWidth": 4,
         "singleQuote": true,
         "proseWrap": "preserve",
-        "include": ["*"],
-        "exclude": []
-    }
+        "include": [
+            "src",
+            ".github",
+            "deno.json",
+            "README.md",
+            "mod.ts"
+        ]
+    },
+    "exclude": [
+        ".git",
+        "docs",
+        "coverage"
+    ]
 }

mod.ts

@@ -1 +1 @@
-export * from "./src/index.ts"
+export * from './src/index.ts'