fix: Add deno to the package.json export conditions. (#1004)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: Jason3S

.github/workflows/autofix.yml

@@ -27,6 +27,9 @@ jobs:
       - name: Build
         run: pnpm run build
 
+      - name: Build Readme
+        run: pnpm run build:readme
+
       - name: Fix Lint
         run: |
           pnpm run lint:fix

README.md

@@ -25,34 +25,50 @@ For the occasional request, this is the easiest way, but the Worker startup and
 
 ### Find the words in some text
 
-```typescript
+<!--- @@inject: ./examples/example-words.js --->
+
+```js
 import { workerMatchAll } from 'regexp-worker';
 //...
 const response = await workerMatchAll('Good Morning', /\b\w+/g);
 console.log(response.matches.map((m) => m[0]));
 ```
 
+<!--- @@inject-end: ./examples/example-words.js --->
+
 Result:
 
+<!--- @@inject: ./examples/output/example-words.js.out.txt --->
+
 ```
 [ 'Good', 'Morning' ]
 ```
 
+<!--- @@inject-end: ./examples/output/example-words.js.out.txt --->
+
 ### Find the word breaks in some text
 
-```ts
+<!--- @@inject: ./examples/example-indexes.js --->
+
+```js
 import { workerMatchAll } from 'regexp-worker';
 
 const response = await workerMatchAll('Good Morning', /\b/g);
 console.log(response.matches.map((m) => m.index));
 ```
 
+<!--- @@inject-end: ./examples/example-indexes.js --->
+
 Result:
 
+<!--- @@inject-code: examples/output/example-indexes.js.out.txt --->
+
 ```
 [ 0, 4, 5, 12 ]
 ```
 
+<!--- @@inject-end: examples/output/example-indexes.js.out.txt --->
+
 ### Format of the response
 
 ```ts
@@ -117,3 +133,59 @@ class TimeoutError extends Error {
     elapsedTimeMs: number;
 }
 ```
+
+## Deno
+
+Deno uses the Web Worker interface instead of `node:worker_threads`.
+To make things easier, this library has been published to [jsr.io](https://jsr.io/@streetsidesoftware/regexp-worker) in addition to
+adding a deno export to `package.json`.
+
+**Example Using Deno:**
+
+<!--- @@inject: ./examples/example.deno.ts --->
+
+````ts
+/**
+ * @file example.deno.ts
+ * @description Example of using the `@streetsidesoftware/regexp-worker` package in Deno
+ * to extract email addresses from a sample text using a Worker.
+ *
+ * Install:
+ * ```sh
+ * deno add jsr:@streetsidesoftware/regexp-worker
+ * deno example.deno.ts # run this file.
+ * ```
+ */
+
+import { createRegExpWorker } from '@streetsidesoftware/regexp-worker';
+
+const sampleText = `
+This is a sample text with some email addresses:
+- [email protected]
+- [email protected]
+`;
+
+const regexpEmail = /([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,})/g;
+
+export async function getEmails(text: string): Promise<string[]> {
+    await using worker = await createRegExpWorker();
+
+    const result = await worker.matchAll(text, regexpEmail);
+    return result.matches.map((match) => match[0]);
+}
+
+export async function run() {
+    const emails = await getEmails(sampleText);
+    console.log('Extracted emails:', emails);
+}
+
+if (import.meta.main) {
+    run();
+}
+````
+
+<!--- @@inject-end: ./examples/example.deno.ts --->
+
+## Bun
+
+Bun does not currently work. It does not fully support `node:worker_threads` and the Web Worker API fails to communicate. Further investigation would be needed.

examples/example-words.js

@@ -1,4 +1,4 @@
 import { workerMatchAll } from 'regexp-worker';
-
+//...
 const response = await workerMatchAll('Good Morning', /\b\w+/g);
 console.log(response.matches.map((m) => m[0]));

examples/example.deno.ts

@@ -0,0 +1,37 @@
+/**
+ * @file example.deno.ts
+ * @description Example of using the `@streetsidesoftware/regexp-worker` package in Deno
+ * to extract email addresses from a sample text using a Worker.
+ *
+ * Install:
+ * ```sh
+ * deno add jsr:@streetsidesoftware/regexp-worker
+ * deno example.deno.ts # run this file.
+ * ```
+ */
+
+import { createRegExpWorker } from '@streetsidesoftware/regexp-worker';
+
+const sampleText = `
+This is a sample text with some email addresses:
+- [email protected]
+- [email protected]
+`;
+
+const regexpEmail = /([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,})/g;
+
+export async function getEmails(text: string): Promise<string[]> {
+    await using worker = await createRegExpWorker();
+
+    const result = await worker.matchAll(text, regexpEmail);
+    return result.matches.map((match) => match[0]);
+}
+
+export async function run() {
+    const emails = await getEmails(sampleText);
+    console.log('Extracted emails:', emails);
+}
+
+if (import.meta.main) {
+    run();
+}

examples/package.json

@@ -9,6 +9,7 @@
   },
   "license": "MIT",
   "dependencies": {
+    "@streetsidesoftware/regexp-worker": "jsr:^4.1.6",
     "regexp-worker": "workspace:*"
   }
 }

jsr.json

@@ -8,14 +8,7 @@
         "./node": "./src/index.mts"
     },
     "publish": {
-        "include": [
-            "LICENSE",
-            "README.md",
-            "src"
-        ],
-        "exclude": [
-            "**/*.test.ts",
-            "**/*.test.mts"
-        ]
+        "include": ["LICENSE", "README.md", "src"],
+        "exclude": ["**/*.test.ts", "**/*.test.mts"]
     }
 }

package.json

@@ -17,6 +17,7 @@
     "lint:fix": "pnpm run lint:fix:eslint && pnpm run lint:fix:prettier",
     "lint:fix:eslint": "eslint . --fix",
     "lint:fix:prettier": "prettier --write .",
+    "build:readme": "inject-markdown README.md",
     "build": "pnpm run build:worker && pnpm run build:code",
     "build:worker": "tsdown -c worker.tsdown.config.ts && node scripts/build-worker.js",
     "build:code": "pnpm run compile && tsdown -c tsdown.config.ts",
@@ -36,6 +37,7 @@
   "exports": {
     ".": {
       "browser": "./dist/browser.js",
+      "deno": "./dist/browser.js",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     }
@@ -77,6 +79,7 @@
     "eslint": "^9.30.0",
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "globals": "^16.2.0",
+    "inject-markdown": "^3.1.4",
     "lorem-ipsum": "^2.0.8",
     "prettier": "^3.6.2",
     "shx": "^0.4.0",