Merge branch 'main' into remove-ResolvedFreshConfig

Author: iuioiua

.github/workflows/ci.yml

@@ -50,3 +50,6 @@ jobs:
 
       - name: Run tests
         run: deno task test
+
+      - name: Check docs
+        run: deno task check:docs

deno.json

@@ -22,6 +22,7 @@
     "build-www": "deno task --cwd=www build",
     "screenshot": "deno run -A www/utils/screenshot.ts",
     "check:types": "deno check src/**/*.ts src/**/*.tsx tests/**/*.ts tests/**/*.tsx update/**/*.ts plugin-tailwindcss/**/*.ts init/**/*.ts",
+    "check:docs": "deno run -A tools/check_docs.ts",
     "ok": "deno fmt --check && deno lint && deno task check:types && deno task test",
     "test:www": "deno test -A www/main_test.*",
     "release": "deno run -A tools/release.ts"
@@ -40,6 +41,8 @@
     "exclude": ["**/*_test.*", "src/__OLD/**", "*.todo"]
   },
   "imports": {
+    "@deno/doc": "jsr:@deno/doc@^0.172.0",
+    "@std/collections": "jsr:@std/collections@^1.0.11",
     "@std/http": "jsr:@std/http@^1.0.15",
     "fresh": "jsr:@fresh/core@^2.0.0-alpha.26",
     "preact": "npm:preact@^10.25.1",

deno.lock

@@ -1,8 +1,69 @@
 import { STATUS_TEXT } from "@std/http/status";
 
+/**
+ * Error that's thrown when a request fails. Correlates to a
+ * {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status | HTTP status}.
+ *
+ * @property status The HTTP status code.
+ *
+ * @example Basic usage
+ * ```ts
+ * import { App, HttpError } from "fresh";
+ * import { expect } from "@std/expect";
+ *
+ * const app = new App()
+ *   .get("/", () => new Response("ok"))
+ *   .get("/not-found", () => {
+ *      throw new HttpError(404, "Nothing here");
+ *    });
+ *
+ * const handler = await app.handler();
+ *
+ * try {
+ *   await handler(new Request("http://localhost/not-found"))
+ * } catch (error) {
+ *   expect(error).toBeInstanceOf(HttpError);
+ *   expect(error.status).toBe(404);
+ *   expect(error.message).toBe("Nothing here");
+ * }
+ * ```
+ */
 export class HttpError extends Error {
+  /**
+   * The HTTP status code.
+   *
+   * @example Basic usage
+   * ```ts
+   * import { App, HttpError } from "fresh";
+   * import { expect } from "@std/expect";
+   *
+   * const app = new App()
+   *   .get("/", () => new Response("ok"))
+   *   .get("/not-found", () => {
+   *      throw new HttpError(404, "Nothing here");
+   *    });
+   *
+   * const handler = await app.handler();
+   *
+   * try {
+   *   await handler(new Request("http://localhost/not-found"))
+   * } catch (error) {
+   *   expect(error).toBeInstanceOf(HttpError);
+   *   expect(error.status).toBe(404);
+   *   expect(error.message).toBe("Nothing here");
+   * }
+   * ```
+   */
   status: number;
 
+  /**
+   * Constructs a new instance.
+   *
+   * @param status The HTTP status code.
+   * @param message The error message. Defaults to the status text of the given
+   * status code.
+   * @param options Optional error options.
+   */
   constructor(
     status: keyof typeof STATUS_TEXT,
     message: string = STATUS_TEXT[status],

src/error.ts

@@ -0,0 +1,5 @@
+import { checkDocs } from "https://github.com/denoland/std/raw/refs/heads/main/_tools/check_docs.ts";
+
+await checkDocs([
+  import.meta.resolve("../src/error.ts"),
+]);