astro-relatinator 1.0.0

package/README.md

@@ -0,0 +1,5 @@
+## Astro Integration for Relatinator
+
+An Astro integration for the [humble library for finding related posts and content](https://github.com/DBozhinovski/relatinator/tree/master/packages/relatinator).
+
+## Installation

package/integration.ts

@@ -0,0 +1,75 @@
+import type { AstroIntegration } from "astro";
+import path from "node:path";
+import { train, tfIdf } from "relatinator";
+import { glob } from "glob";
+import matter from "gray-matter";
+import fs from "node:fs/promises";
+import { TfIdfDocument } from "natural";
+import { Document } from "relatinator";
+
+async function trainModel(paths: string[]) {
+  const documents: Document[] = [];
+
+  if (tfIdf.documents) {
+    if ((tfIdf.documents as unknown as TfIdfDocument[]).length > 0) {
+      (tfIdf.documents as unknown as TfIdfDocument[]) = [];
+      (tfIdf.documents as unknown as TfIdfDocument[]).length = -1;
+    }
+  }
+
+  for (const path of paths) {
+    const markdownFiles = await glob(`${path}/**/*.{md,mdx}`);
+
+    for (const file of markdownFiles) {
+      const content = await fs.readFile(file, "utf-8");
+      const parsed = matter(content);
+      const idArr = file.split("/");
+      const id = idArr[idArr.length - 1];
+
+      documents.push({
+        id,
+        content: `${parsed.data.title} ${
+          parsed.data.description
+        } ${parsed.data.tags.join(" ")} ${parsed.content}`,
+      });
+    }
+  }
+
+  train(documents);
+}
+
+const relatinatorIntegration = ({
+  paths,
+}: {
+  paths: string[];
+}): AstroIntegration => {
+  return {
+    name: "astro-relatinator",
+    hooks: {
+      "astro:server:setup": async ({ server, logger }) => {
+        logger.info("relatinator server:setup");
+
+        logger.info("Training TF-IDF on existing data...");
+        await trainModel(paths);
+        logger.info("Initial training done.");
+
+        server.watcher.on("all", async (eventName, filePath) => {
+          if (!["add", "change"].includes(eventName)) {
+            return;
+          }
+
+          if (path.extname(filePath).includes("md")) {
+            logger.info(
+              `Markdown file changed: ${filePath}; Re-training TF-IDF...`
+            );
+            await trainModel(paths);
+          } else {
+            return;
+          }
+        });
+      },
+    },
+  };
+};
+
+export default relatinatorIntegration;

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "astro-relatinator",
+  "version": "1.0.0",
+  "description": "Find related content in your Astro website or app",
+  "author": "Darko Bozhinovski <dbozhinovski@gmail.com>",
+  "license": "MIT",
+  "keywords": [
+    "astro",
+    "related-content",
+    "tfidf",
+    "relatinator",
+    "related",
+    "words",
+    "posts",
+    "articles",
+    "static"
+  ],
+  "files": [
+    "integration.ts"
+  ],
+  "exports": {
+    ".": "./integration.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DBozhinovski/relatinator"
+  },
+  "type": "module",
+  "devDependencies": {
+    "@types/node": "^20.10.4",
+    "astro": "3",
+    "husky": "^8.0.3",
+    "natural": "^6.10.3"
+  },
+  "dependencies": {
+    "glob": "^10.3.10",
+    "relatinator": "^1.1.0"
+  },
+  "peerDependencies": {
+    "astro": "3"
+  }
+}