feat(bun): add algolia script & github action

.env.sample

@@ -0,0 +1,3 @@
+APPID=
+APIKEY=
+INDEXNAME=

.github/workflows/algolia.yml

@@ -0,0 +1,25 @@
+name: algolia-index
+
+on:
+  push:
+    branches:
+      - "main"
+
+jobs:
+  algolia-index:
+    name: algolia-index
+    runs-on: ubuntu-latest
+    steps:
+      # ...
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v1
+
+      # run any `bun` or `bunx` command
+      - run: bun install
+      - name: create .env file
+        run: |
+          touch .env
+          echo APPID=${{ secrets.APPID }} >> .env
+          echo APIKEY=${{ secrets.APIKEY }} >> .env
+          echo INDEXNAME=${{ secrets.INDEXNAME }} >> .env
+      - run: bun run algolia

.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+.env
+.vscode

env.d.ts

@@ -0,0 +1,7 @@
+declare module "bun" {
+  interface Env {
+    APPID: string;
+    APIKEY: string;
+    INDEXNAME: string;
+  }
+}

package.json

@@ -0,0 +1,16 @@
+{
+  "name": "knowledge-base",
+  "type": "module",
+  "scripts": {
+    "algolia": "bun scripts/algolia.ts"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "@types/remarkable": "^2.0.8",
+    "algoliasearch": "^4.23.2",
+    "remarkable": "^2.0.1"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

scripts/algolia.ts

@@ -0,0 +1,15 @@
+import algoliasearch from "algoliasearch";
+import { list } from "./list";
+
+const urls = await list();
+
+const client = algoliasearch(Bun.env.APPID, Bun.env.APIKEY);
+
+const index = client.initIndex(Bun.env.INDEXNAME);
+
+const { objectIDs } = await index.replaceAllObjects(urls, {
+  safe: true,
+  autoGenerateObjectIDIfNotExist: true,
+});
+
+console.log(`got ${objectIDs.length} objectIDs for ${urls.length} items`);

scripts/list.ts

@@ -0,0 +1,38 @@
+import { $, Glob } from "bun";
+import { parse } from "./parse";
+import type { Item } from "./types";
+
+const clean = new RegExp(/(?:.\/)?(.*).md$/);
+
+const fileNameToTag = (fileName: string): string[] =>
+  clean
+    .exec(fileName)![1]
+    .replaceAll("_", "")
+    .replaceAll(" ", "-")
+    .replaceAll("\\", "/")
+    .toLowerCase()
+    .split("/");
+
+export const list = async (): Promise<Item[]> => {
+  const glob = new Glob("**/*.md");
+
+  const fileNames = (await Array.fromAsync(glob.scan("."))).filter(
+    (f) => !f.startsWith("node_modules") && !f.startsWith("README.md")
+  );
+
+  const urls = (
+    await Promise.all(
+      fileNames.map(
+        async (fileName) =>
+          await $`cat ${fileName}`
+            .text()
+            .then(parse)
+            .then((links) =>
+              links.map((link) => ({ ...link, tags: fileNameToTag(fileName) } as Item))
+            )
+      )
+    )
+  ).flatMap((x) => x);
+
+  return urls;
+};

scripts/parse.ts

@@ -0,0 +1,32 @@
+import { Remarkable } from "remarkable";
+import type { Token, LinkOpenToken, BlockContentToken, TextToken } from "remarkable/lib";
+import type { Link } from "./types";
+
+const md = new Remarkable("default", {});
+
+const isBlockContentToken = (token: Token): token is BlockContentToken => "children" in token;
+const isLinkOpenToken = (token: Token): token is LinkOpenToken => token.type === "link_open";
+const isTextToken = (token: Token): token is TextToken => token.type === "text";
+
+export const parse = (text: string) => {
+  const links: Link[] = [];
+  const tokens = md.parse(text, {});
+
+  tokens.forEach((token) => {
+    if (token.type !== "inline" || !isBlockContentToken(token)) return;
+    if (!Array.isArray(token.children)) return;
+    token.children.forEach((child, index) => {
+      if (isLinkOpenToken(child)) {
+        const url = child.href;
+        let text: string = url;
+        const nextChild = token.children![index + 1];
+        if (isTextToken(nextChild) && nextChild.content) {
+          text = nextChild.content;
+        }
+        links.push({ url, text });
+      }
+    });
+  });
+
+  return links;
+};

scripts/types.ts

@@ -0,0 +1,8 @@
+export interface Link {
+  url: string;
+  text: string;
+}
+
+export interface Item extends Link {
+  tags: string[];
+}

tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    // Enable latest features
+    "lib": ["ESNext"],
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noPropertyAccessFromIndexSignature": true
+  }
+}