publish to npm

Author: YieldRay

.github/workflows/publish.yml

@@ -0,0 +1,48 @@
+name: publish
+
+on:
+    push:
+        branches: [main]
+    release:
+        types: [published]
+
+jobs:
+    publish:
+        runs-on: ubuntu-22.04
+        timeout-minutes: 30
+
+        permissions:
+            contents: read
+            id-token: write
+
+        steps:
+            - name: Clone repository
+              uses: actions/checkout@v4
+
+            - name: Set up Deno
+              uses: denoland/setup-deno@v1
+
+            - 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: Publish (real)
+              if: github.event_name == 'release'
+              run: deno publish --allow-dirty
+
+            - name: Build for NPM
+              run: deno run -A build.ts
+
+            - name: NPM (dry run)
+              if: github.event_name == 'push'
+              run: npm publish --dry-run
+
+            - name: NPM (real)
+              if: github.event_name == 'release'
+              run: npm publish --provenance --access public

.gitignore

@@ -1,3 +1,6 @@
 docs/
 coverage/
 cov.lcov
+node_modules/
+dist/
+package.json

README.md

@@ -1,13 +1,33 @@
 # json-rpc-ts
 
 [![deno.land/x](https://shield.deno.dev/x/json_rpc_ts)](https://deno.land/x/json_rpc_ts)
+[![JSR](https://jsr.io/badges/@yieldray/json-rpc-ts)](https://jsr.io/@yieldray/json-rpc-ts)
+[![npm](https://img.shields.io/npm/v/@yieldray/json-rpc-ts)](https://www.npmjs.com/package/@yieldray/json-rpc-ts)
 [![codecov](https://codecov.io/gh/YieldRay/json-rpc-ts/graph/badge.svg?token=BabjRkI8jk)](https://codecov.io/gh/YieldRay/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) implementation, zero dependency, minimal abstraction, with simple api
 
 > Specification <https://www.jsonrpc.org/specification>
 
+# Installation
+
+For Node.js
+
+```sh
+npx jsr add @yieldray/json-rpc-ts # recommended
+# or
+npm install @yieldray/json-rpc-ts
+```
+
+For Deno
+
+```sh
+deno add @yieldray/json-rpc-ts
+```
+
+# Examples
+
 Example to use the client
 
 ```ts
@@ -60,13 +80,3 @@ 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
-```

build.ts

@@ -0,0 +1,37 @@
+import * as esbuild from 'npm:esbuild'
+
+console.log(
+    await esbuild.build({
+        entryPoints: ['src/index.ts'],
+        bundle: true,
+        outdir: 'dist',
+        format: 'esm',
+    }),
+)
+
+const pkg = JSON.parse(Deno.readTextFileSync('./deno.json'))
+
+if (Deno.statSync('./package.json').isFile) {
+    Deno.removeSync('./package.json')
+}
+
+const packageJson = {
+    name: pkg.name,
+    version: pkg.version,
+    main: 'dist/index.js',
+    files: ['dist'],
+    author: 'YieldRay',
+    license: 'MIT',
+    repository: {
+        type: 'git',
+        url: 'git+https://github.com/YieldRay/json-rpc-ts.git',
+    },
+    bugs: {
+        url: 'https://github.com/YieldRay/json-rpc-ts/issues',
+    },
+    homepage: 'https://github.com/YieldRay/json-rpc-ts#readme',
+}
+
+console.log(packageJson)
+
+Deno.writeTextFileSync('./package.json', JSON.stringify(packageJson, null, 4))

deno.json

@@ -1,6 +1,6 @@
 {
-    "name": "@ray/json-rpc-ts",
-    "version": "0.1.3",
+    "name": "@yieldray/json-rpc-ts",
+    "version": "0.2.0",
     "exports": "./mod.ts",
     "publish": {
         "include": [
@@ -21,7 +21,7 @@
         "noImplicitOverride": true
     },
     "imports": {
-        "std/": "https://deno.land/std@0.220.1/"
+        "std/": "https://deno.land/std@0.221.0/"
     },
     "tasks": {
         "lint": "deno lint",
@@ -30,7 +30,8 @@
         "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"
+        "cov:clean": "rm -rf ./coverage/ cov.lcov",
+        "build": "deno run -A build.ts"
     },
     "fmt": {
         "lineWidth": 80,
@@ -43,12 +44,13 @@
             ".github",
             "deno.json",
             "README.md",
-            "mod.ts"
+            "*.ts"
         ]
     },
     "exclude": [
         ".git",
         "docs",
-        "coverage"
+        "coverage",
+        "dist"
     ]
 }

deno.lock

@@ -3,10 +3,10 @@ import {
     assertInstanceOf,
     assertObjectMatch,
 } from 'std/assert/mod.ts'
-import { JSONRPCClient, JSONRPCClientParseError } from './client.ts'
-import { JSONRPCFulfilledResult } from './types.ts'
-import { JSONRPCRequest } from './dto/request.ts'
+import type { JSONRPCFulfilledResult } from './types.ts'
+import type { JSONRPCRequest } from './dto/request.ts'
 import { JSONRPCErrorResponse, JSONRPCSuccessResponse } from './dto/response.ts'
+import { JSONRPCClient, JSONRPCClientParseError } from './client.ts'
 import { JSONRPCError } from './dto/errors.ts'
 
 Deno.test('client', async () => {

src/client.test.ts

@@ -1,7 +1,10 @@
 import type { JSONRPCMethods, JSONRPCSettledResult } from './types.ts'
+import type {
+    JSONRPCErrorResponse,
+    JSONRPCSuccessResponse,
+} from './dto/response.ts'
 import { JSONRPCNotification, JSONRPCRequest } from './dto/request.ts'
-import { JSONRPCErrorResponse, JSONRPCSuccessResponse } from './dto/response.ts'
-import { isJSONRPCResponse, JSONRPCResponse } from './dto/response.ts'
+import { isJSONRPCResponse, type JSONRPCResponse } from './dto/response.ts'
 import { JSONRPCError } from './dto/errors.ts'
 import {
     getIDFromGenerator,

src/client.ts

@@ -1,6 +1,6 @@
 import type { JSONRPCValue, WithOptionalJSONRPCVersion } from '../types.ts'
 import { isJSONRPCID, type JSONRPCID } from '../id.ts'
-import { isJSONRPCError, JSONRPCErrorInterface } from './errors.ts'
+import { isJSONRPCError, type JSONRPCErrorInterface } from './errors.ts'
 
 export class JSONRPCSuccessResponse {
     public jsonrpc = '2.0' as const

src/dto/response.ts

@@ -7,12 +7,12 @@ import {
 } from './dto/errors.ts'
 import {
     isJSONRPCRequest,
-    JSONRPCNotification,
-    JSONRPCRequest,
+    type JSONRPCNotification,
+    type JSONRPCRequest,
 } from './dto/request.ts'
 import {
     JSONRPCErrorResponse,
-    JSONRPCResponse,
+    type JSONRPCResponse,
     JSONRPCSuccessResponse,
 } from './dto/response.ts'
 import { isJSONRPCID } from './id.ts'