@maci-protocol/website 0.0.0-ci.00107eb

package/src/scripts/utils.ts

@@ -0,0 +1,115 @@
+import fs from "fs";
+import path from "path";
+
+/**
+ * Allow to copy a directory from source to target
+ * @param source - the source directory
+ * @param target - the target directory
+ */
+export function copyDirectory(source: string, target: string): void {
+  if (!fs.existsSync(target)) {
+    fs.mkdirSync(target, { recursive: true });
+  }
+
+  if (!fs.existsSync(source)) {
+    return;
+  }
+
+  const files = fs.readdirSync(source);
+
+  files.forEach((file: string) => {
+    const sourcePath = path.join(source, file);
+    const targetPath = path.join(target, file);
+
+    if (fs.lstatSync(sourcePath).isDirectory()) {
+      copyDirectory(sourcePath, targetPath);
+    } else {
+      fs.copyFileSync(sourcePath, targetPath);
+    }
+  });
+}
+
+/**
+ * A function that forces the first letter to be capital,
+ * while the rest of the string must be lower case.
+ * @param str - the string being transformed
+ */
+export function fitFormat(str: string): string {
+  return `${str[0].toUpperCase()}${str.slice(1, str.length).toLowerCase()}`;
+}
+
+/**
+ * Sidebar Parameters
+ */
+interface SidebarProps {
+  title?: string;
+  description?: string;
+  label?: string;
+  position?: number;
+}
+
+/**
+ * A function to generate a sidebar string for a markdown file
+ * @param sidebarProps - including title, description, label, and position
+ */
+export function generateSidebarString({ title, description, label, position }: SidebarProps): string {
+  let ret = "---\n";
+
+  if (title) {
+    ret = `${ret}title: ${title}\n`;
+  }
+
+  if (description) {
+    ret = `${ret}description: ${description}\n`;
+  }
+
+  if (label) {
+    ret = `${ret}sidebar_label: ${label}\n`;
+  }
+
+  if (position) {
+    ret = `${ret}sidebar_position: ${position.toString()}\n`;
+  }
+
+  ret = `${ret}---\n`;
+
+  return ret;
+}
+
+/**
+ * Generate a table of contents for a directory
+ * @param dir - the directory to generate a table of contents for
+ * @returns a string with the table of contents
+ */
+export function generateToC(dir: string, prefix = ""): string {
+  const files = fs.readdirSync(dir);
+  let content = "";
+
+  files.forEach((file) => {
+    const filePath = path.join(dir, file);
+    const fileStat = fs.statSync(filePath);
+    if (fileStat.isDirectory()) {
+      content += generateToC(filePath, `${prefix}${file}/`);
+    } else if (file !== "index.md" && file !== "README.md" && file.endsWith(".md")) {
+      content += `- [${prefix}${file}](${prefix}${file})\n`;
+    }
+  });
+
+  return content;
+}
+
+/**
+ * A function that insert a index page
+ * @param dir - the directory to insert an index page
+ * @param sidebarProps - including title, description, label, and position
+ */
+export function insertIndexPage(
+  dir: string,
+  { title, description, label, position }: SidebarProps,
+  content?: string,
+): void {
+  fs.writeFileSync(
+    `${dir}/index.md`,
+    `${generateSidebarString({ title, description, label, position })}${content ?? ""}`,
+  );
+}

package/src/utils/getProjectsByFilter.ts

@@ -0,0 +1,40 @@
+import type Projects from "../content/projects.json";
+
+/**
+ * Filters projects based on hackathon and status criteria.
+ * @param projects An array of objects where each object represents a project.
+ * @param filter An object containing optional hackathon and status filter criteria.
+ * @returns An array of projects that match the given filter criteria.
+ */
+export function getProjectsByFilter(
+  projects: typeof Projects,
+  filter: { hackathon?: string; status?: string },
+): typeof Projects {
+  return projects.filter((project) => {
+    const hackathonMatch = !filter.hackathon || project.hackathon === filter.hackathon;
+    const statusMatch = !filter.status || project.status === filter.status;
+    return hackathonMatch && statusMatch;
+  });
+}
+
+/**
+ * Extracts unique hackathons from the projects list.
+ * @param projects An array of objects where each object represents a project.
+ * @returns An array of strings, where each string is a unique hackathon from across all projects.
+ */
+export function getUniqueHackathons(projects: typeof Projects): string[] {
+  const hackathons = projects
+    .map((project) => project.hackathon)
+    .filter((hackathon): hackathon is string => hackathon !== null && hackathon !== "");
+  return Array.from(new Set(hackathons));
+}
+
+/**
+ * Extracts unique statuses from the projects list.
+ * @param projects An array of objects where each object represents a project.
+ * @returns An array of strings, where each string is a unique status from across all projects.
+ */
+export function getUniqueStatuses(projects: typeof Projects): string[] {
+  const statuses = projects.map((project) => project.status);
+  return Array.from(new Set(statuses));
+}