Twoslash

Author: dahlia

.vscode/settings.json

@@ -70,6 +70,7 @@
     "srvx",
     "Tailscale",
     "tsdown",
+    "twoslash",
     "unfollow",
     "unfollowed",
     "unfollowing",

CHANGES.md

@@ -6,7 +6,22 @@ Version 0.3.0
 
 To be released.
 
- -  Added `MemoryCachedRepository` class.
+ -  BotKit now supports Node.js alongside of Deno.  The minimum required
+    version of Node.js is 22.0.0.
+
+ -  Added `@fedify/botkit/repository` module that provides repository
+    implementations for BotKit.
+
+     -  Added `RepositoryGetMessagesOptions` interface.
+     -  Added `RepositoryGetFollowersOptions` interface.
+     -  Added `Uuid` type.
+     -  Added `KvKey` type.
+     -  Added `KvStore` type.
+     -  Added `KvStoreRepositoryPrefixes` interface.
+     -  Added `Announce` class.
+     -  Added `Create` class.
+     -  Added `MemoryCachedRepository` class.
+
  -  Upgraded Fedify to 1.6.1.
 
 

deno.json

@@ -14,6 +14,7 @@
     "./follow": "./src/follow.ts",
     "./message": "./src/message.ts",
     "./reaction": "./src/reaction.ts",
+    "./repository": "./src/repository.ts",
     "./session": "./src/session.ts",
     "./text": "./src/text.ts"
   },

deno.lock

@@ -1,7 +1,9 @@
+import { transformerTwoslash } from "@shikijs/vitepress-twoslash";
 import deflist from "markdown-it-deflist";
 import footnote from "markdown-it-footnote";
 import { jsrRef } from "markdown-it-jsr-ref";
 import process from "node:process";
+import { ModuleKind, ModuleResolutionKind } from "typescript";
 import { defineConfig } from "vitepress";
 import {
   groupIconMdPlugin,
@@ -153,6 +155,18 @@ export default defineConfig({
   ignoreDeadLinks: true,
 
   markdown: {
+    codeTransformers: [
+      transformerTwoslash({
+        twoslashOptions: {
+          compilerOptions: {
+            lib: ["dom", "dom.iterable", "esnext"],
+            types: ["dom", "dom.iterable", "esnext", "@types/deno", "node"],
+            moduleResolution: ModuleResolutionKind.Bundler,
+            module: ModuleKind.ESNext,
+          },
+        },
+      }),
+    ],
     config(md) {
       md.use(deflist);
       md.use(footnote);

docs/.vitepress/config.mts

@@ -1,6 +1,8 @@
 // https://vitepress.dev/guide/custom-theme
+import TwoslashFloatingVue from "@shikijs/vitepress-twoslash/client";
+import "@shikijs/vitepress-twoslash/style.css";
 import "virtual:group-icons.css";
-import type { Theme } from "vitepress";
+import type { EnhanceAppContext, Theme } from "vitepress";
 import DefaultTheme from "vitepress/theme";
 import { h } from "vue";
 import "./style.css";
@@ -12,7 +14,7 @@ export default {
       // https://vitepress.dev/guide/extending-default-theme#layout-slots
     });
   },
-  enhanceApp({ app, router, siteData }) {
-    // ...
+  enhanceApp({ app, router, siteData }: EnhanceAppContext) {
+    app.use(TwoslashFloatingVue);
   },
 } satisfies Theme;

docs/.vitepress/theme/index.ts

@@ -19,13 +19,13 @@ Instantiation
 
 You can instantiate a `Bot` instance by calling the `createBot()` function:
 
-~~~~ typescript
-import { createBot } from "@fedify/bot";
+~~~~ typescript twoslash
+import { createBot } from "@fedify/botkit";
 import { MemoryKvStore } from "@fedify/fedify";
 
 const bot = createBot<void>({
   username: "my_bot",
-  kv: new MemoryKvStore(kv),
+  kv: new MemoryKvStore(),
 });
 ~~~~
 
@@ -155,7 +155,8 @@ about the bot like the website URL, the source code repository URL, etc. here.
 Note that the property names should be human-readable and property values are of
 the `Text` type (see also the [*Text* chapter](./text.md)):
 
-~~~~ typescript
+~~~~ typescript twoslash
+// @noErrors: 2345
 import { createBot, link, mention } from "@fedify/botkit";
 
 const bot = createBot<void>({
@@ -239,7 +240,8 @@ It consists of the following properties:
 :   The version of the bot software.  It should be a `SemVer` object.
     You can create a `SemVer` object using the `parseSemVer()` function:
 
-    ~~~~ typescript
+    ~~~~ typescript twoslash
+    // @noErrors: 2345
     import { createBot, parseSemVer } from "@fedify/botkit";
 
     const bot = createBot<void>({
@@ -332,8 +334,9 @@ or [srvx] on Node.js.
 For example, if you have a `Bot` object named `bot`, and `export` it as
 a default export:
 
-~~~~ typescript [bot.ts]
-import { createBot } from "@fedify/bot";
+~~~~ typescript [bot.ts] twoslash
+// @noErrors: 2345
+import { createBot } from "@fedify/botkit";
 
 const bot = createBot<void>({
   // Omitted other options for brevity
@@ -386,14 +389,18 @@ yarn add srvx
 
 Then, import [`serve()`] function from `srvx` module:
 
-~~~~ typescript [bot.ts]
+~~~~ typescript [bot.ts] twoslash
 import { serve } from "srvx";
 ~~~~
 
 Finally, you can run the bot using the [`serve()`] function at the end of
 the *bot.ts* file:
 
-~~~~ typescript [bot.ts]
+~~~~ typescript [bot.ts] twoslash
+import type { Bot } from "@fedify/botkit";
+import { serve } from "srvx";
+const bot = {} as unknown as Bot<void>;
+// ---cut-before---
 const server = serve({
   ...bot,
   port: 8000,
@@ -426,8 +433,11 @@ It is recommended to have an environment variable to control
 the [`behindProxy`](#createbotoptions-behindproxy) option so that you can
 easily switch between local development and production:
 
-~~~~ typescript [bot.ts] {3-4,8}
-import { createBot } from "@fedify/bot";
+::: code-group
+
+~~~~ typescript [Deno] {3-4,8} twoslash
+// @noErrors: 2345
+import { createBot } from "@fedify/botkit";
 
 const BEHIND_PROXY =
   Deno.env.get("BEHIND_PROXY")?.trim()?.toLowerCase() === "true";
@@ -438,6 +448,21 @@ const bot = createBot<void>({
 });
 ~~~~
 
+~~~~ typescript [Node.js] {3-4,8} twoslash
+// @noErrors: 2345
+import { createBot } from "@fedify/botkit";
+
+const BEHIND_PROXY =
+  process.env.BEHIND_PROXY?.trim()?.toLowerCase() === "true";
+
+const bot = createBot<void>({
+  // Omitted other options for brevity
+  behindProxy: BEHIND_PROXY,
+});
+~~~~
+
+:::
+
 Then, you can use the following command to run the bot with the `BEHIND_PROXY`
 environment variable set to `true`: