Merge pull request #53 from takker99/jsr

feat: Ready for publishing to JSR

Author: takker99

.github/workflows/ci.yml

@@ -1,20 +1,18 @@
 name: ci
 
+env:
+  DENO_VERSION: 1.x
+
 on: [push, pull_request]
 
 jobs:
   test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@master
-      - uses: denoland/setup-deno@main
+      - name: Install Deno
+        uses: denoland/setup-deno@v1
         with:
-          deno-version: "1.29.1"
-      - name: Check fmt
-        run: deno fmt --check
-      - name: Run lint
-        run: deno lint
-      - name: Run type check
-        run: deno check rest.ts userscript.ts
-      - name: Run test
-        run: deno test
+          deno-version: ${{ env.DENO_VERSION }}
+      - name: Check fmt & lint & type check & test
+        run: deno task check:dry

.github/workflows/publish.yml

@@ -0,0 +1,27 @@
+# cf. https://jsr.io/@core/unknownutil/3.18.1/.github/workflows/jsr.yml
+name: publish
+
+env:
+  DENO_VERSION: 1.x
+
+on:
+  push:
+    tags:
+      - '*'
+
+permissions:
+  contents: read
+  id-token: write # The OIDC ID token is used for authentication with JSR.
+
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Deno
+        uses: denoland/setup-deno@v1
+        with:
+          deno-version: ${{ env.DENO_VERSION }}
+      - name: Publish on tag
+        run: deno task publish

README.md

@@ -1,10 +1,17 @@
-## types
+## @cosense/types
 
-scrapbox関連の型定義ファイル
+Type definitions for [cosense](https://cosen.se)
 
-### Document
+## Getting Started
 
-- [rest.ts](https://doc.deno.land/https://raw.githubusercontent.com/scrapbox-jp/types/0.3.6/rest.ts)
-  - REST API関連の型定義
-- [userscript.ts](https://doc.deno.land/https://raw.githubusercontent.com/scrapbox-jp/types/0.3.6/userscript.ts)
-  - `window.scrapbox`で使う型定義
+If you want to use type definitions for REST API, run
+
+```bash
+deno add jsr:@cosense/types/rest
+```
+
+If you want to use type definitions for UserScript, run
+
+```bash
+deno add jsr:@cosense/types/userscript
+```

blocks.test.ts

@@ -1,5 +1,5 @@
-import { assertType, IsExact } from "./deps/testing.ts";
-import { Line } from "./blocks.ts";
+import { assertType, type IsExact } from "@std/testing/types";
+import type { Line } from "./blocks.ts";
 
 // scrapbox.Page.lines の型定義が正しいか確認する
 // サンプルは https://scrapbox.io/villagepump/記法サンプル より拝借した

change.ts

@@ -1,4 +1,4 @@
-import { BasePage, LineId, StringLc } from "./base.ts";
+import type { BasePage, LineId, StringLc } from "./base.ts";
 
 /** ページの変更内容 */
 export type Change =

commit.ts

@@ -1,5 +1,5 @@
-import { CommitId, PageId, UnixTime, UserId } from "./base.ts";
-import { Change } from "./change.ts";
+import type { CommitId, PageId, UnixTime, UserId } from "./base.ts";
+import type { Change } from "./change.ts";
 
 /** Scrapboxのページの編集commit */
 export interface Commit {

deno.jsonc

@@ -0,0 +1,24 @@
+{
+  "name": "@cosense/types",
+  "version": "0.0.0",
+  "tasks": {
+    "check:dry": "deno fmt --check && deno lint && deno check --remote **/*.ts && deno test --parallel",
+    "check": "deno fmt && deno lint && deno check --remote **/*.ts && deno test --parallel",
+    "check:publish": "deno task check && deno publish --dry-run --allow-dirty",
+    "publish": "deno run --allow-env --allow-run=deno --allow-read --allow-write=deno.jsonc jsr:@david/[email protected]"
+  },
+  "imports": {
+    "@std/testing/types": "jsr:@std/testing@0/types"
+  },
+  "exports": {
+    "./rest": "./rest.ts",
+    "./userscript": "./userscript.ts"
+  },
+  "compilerOptions": {
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ]
+  }
+}