feat: JSR support (#166)

webview · Mar 3, 2024 · f60700d · f60700d
1 parent 83c5ff0
commit f60700d
Show file tree

Hide file tree

Showing 11 changed files with 91 additions and 29 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,2 @@
+open_collective: denosaurs
+github: denosaurs
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -10,13 +10,6 @@ jobs:
       - name: Checkout sources
         uses: actions/checkout@v2
 
-      - name: Install stable toolchain
-        uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-          override: true
-
       - name: Install stable deno
         uses: denoland/setup-deno@v1
         with:

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,17 @@
+name: Publish
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: denoland/setup-deno@v1
+      - run: deno publish
diff --git a/README.md b/README.md
@@ -22,10 +22,26 @@ applications**.
 
 ![Example Image](images/webview_deno.png)
 
+## Installation
+
+Webview is published to [jsr.io](https://jsr.io/@webview/webview) and
+[deno.land](https://deno.land/x/webview). The recommended way to use it is to
+use JSR:
+
+```bash
+deno add @webview/webview
+```
+
+or without the CLI:
+
+```typescript
+import { Webview } from "jsr:@webview/webview";
+```
+
 ## Example
 
 ```typescript
-import { Webview } from "https://deno.land/x/webview/mod.ts";
+import { Webview } from "@webview/webview";
 
 const html = `
   <html>

diff --git a/deno.json b/deno.json
@@ -1,19 +1,21 @@
 {
+  "name": "@webview/webview",
+  "version": "0.8.0",
+  "exports": "./mod.ts",
+  "lock": false,
   "tasks": {
-    "check": "deno check --unstable mod.ts",
-    "fmt": "deno fmt --unstable",
-    "fmt:check": "deno fmt --unstable --check",
-    "lint": "deno lint --unstable",
-    "test:doc": "deno test -A --unstable --doc",
-    "build": "deno run -A --unstable script/build.ts",
-    "run": "deno task build && export PLUGIN_URL=\"./build/\" && deno run -A --unstable",
-    "run:fast": "export PLUGIN_URL=\"./build/\" && deno run -A --unstable"
+    "check": "deno check mod.ts",
+    "fmt": "deno fmt",
+    "fmt:check": "deno fmt --check",
+    "lint": "deno lint",
+    "test:doc": "deno test -A --unstable-ffi --doc --import-map test_import_map.json",
+    "build": "deno run -A script/build.ts",
+    "run": "deno task build && export PLUGIN_URL=\"./build/\" && deno run -A --unstable-ffi",
+    "run:fast": "export PLUGIN_URL=\"./build/\" && deno run -A --unstable-ffi"
   },
+  "unstable": ["ffi"],
   "fmt": {
-    "files": {
-      "exclude": [
-        "webview/"
-      ]
-    }
-  }
+    "exclude": ["webview/"]
+  },
+  "imports": { "@denosaurs/plug": "jsr:@denosaurs/plug@^1.0.5" }
 }
diff --git a/deps.ts b/deps.ts
diff --git a/mod.ts b/mod.ts
@@ -1,2 +1,27 @@
+/**
+ * Webview is a tiny cross-platform library to make web-based GUIs for desktop
+ * applications.
+ *
+ * @example
+ * ```
+ * import { Webview } from "@webview/webview";
+ *
+ * const html = `
+ *   <html>
+ *   <body>
+ *     <h1>Hello from deno v${Deno.version.deno}</h1>
+ *   </body>
+ *   </html>
+ * `;
+ *
+ * const webview = new Webview();
+ *
+ * webview.navigate(`data:text/html,${encodeURIComponent(html)}`);
+ * webview.run();
+ * ```
+ *
+ * @module
+ */
+
 export * from "./src/webview.ts";
 export { preload, unload } from "./src/ffi.ts";
diff --git a/script/build.ts b/script/build.ts
@@ -1,4 +1,4 @@
-import { ensureDir } from "https://deno.land/std@0.197.0/fs/ensure_dir.ts";
+import { ensureDir } from "jsr:@std/fs@0.218/ensure_dir";
 
 const decoder = new TextDecoder();
 const architectures = [["x86_64", "x86_64"], ["aarch64", "arm64"]] as const;

diff --git a/src/ffi.ts b/src/ffi.ts
@@ -1,7 +1,9 @@
-import { dlopen, download } from "../deps.ts";
+import { version } from "../deno.json" with { type: "json" };
+
+import { dlopen, download } from "@denosaurs/plug";
 import { Webview } from "./webview.ts";
 
-const version = "0.7.3";
+
 const cache = Deno.env.get("PLUGIN_URL") === undefined ? "use" : "reloadAll";
 const url = Deno.env.get("PLUGIN_URL") ??
   `https://github.com/webview/webview_deno/releases/download/${version}/`;

diff --git a/src/webview.ts b/src/webview.ts
@@ -61,7 +61,7 @@ export interface Size {
  * ```
  */
 export class Webview {
-  #handle: Deno.PointerValue | null = null;
+  #handle: Deno.PointerValue = null;
   #callbacks: Map<
     string,
     Deno.UnsafeCallback<{
@@ -74,7 +74,7 @@ export class Webview {
    *
    * An unsafe pointer to the webview
    */
-  get unsafeHandle() {
+  get unsafeHandle(): Deno.PointerValue {
     return this.#handle;
   }
 
@@ -85,7 +85,7 @@ export class Webview {
    * backend the pointer is `NSWindow` pointer, when using Win32 backend the
    * pointer is `HWND` pointer.
    */
-  get unsafeWindowHandle() {
+  get unsafeWindowHandle(): Deno.PointerValue {
     return lib.symbols.webview_get_window(this.#handle);
   }
 

diff --git a/test_import_map.json b/test_import_map.json
@@ -0,0 +1,6 @@
+{
+  "imports": {
+    "@webview/webview": "./mod.ts",
+    "@denosaurs/plug": "jsr:@denosaurs/plug@^1.0.5"
+  }
+}