feat: make username optional

Author: chenasraf

package.json

@@ -17,6 +17,7 @@
   "type": "module",
   "scripts": {
     "ci": "pnpm install --frozen-lockfile",
+    "dev": "rm -rf build && mkdir build && cp README.md package.json build/ && tsc --watch",
     "build": "tsc && cp README.md package.json build/",
     "test": "echo \"Error: no test specified\" && exit 0"
   },

src/loader.ts

@@ -28,6 +28,7 @@ async function reloadProjects(
     ...opts,
     lastUpdated,
   })
+
   await reloadOverrides(options)
   const projects = await getProjectsList(options)
 

src/parser.ts

@@ -18,10 +18,20 @@ export async function getProjectsList(
 ): Promise<GitHubProjectType[]> {
   logger.log(`Fetching projects list from GitHub (since: ${formatDate(options.lastUpdated)})`)
 
-  const repos = await fetchRepos(
-    `https://api.github.com/users/${options.username}/repos?per_page=100`,
-    options,
-  )
+  if (!options.username && (!options.orgs || options.orgs.length === 0)) {
+    logger.error('No username or orgs provided')
+    return []
+  }
+
+  const repos: GitHubRepositoryAPIResponse[] = []
+  if (options.username) {
+    repos.push(
+      ...(await fetchRepos(
+        `https://api.github.com/users/${options.username}/repos?per_page=100`,
+        options,
+      )),
+    )
+  }
   for (const org of options.orgs ?? []) {
     repos.push(
       ...(await fetchRepos(`https://api.github.com/orgs/${org}/repos?per_page=100`, options)),
@@ -89,7 +99,7 @@ export async function getProjectsList(
     )
     const readme = readmeResponse.ok ? await readmeResponse.text() : undefined
     project.readme = readme
-    logger.log(`Rendering README for ${repo.name}`)
+    logger.log(`Rendering README for ${repo.full_name}`)
     const { html } = await parseMarkdown(readme ?? '')
     project.readmeHtml = html
     projects.push(project)

src/types.ts

@@ -7,7 +7,7 @@ import { z } from 'zod'
 export const LinkSchema = z.object({
   title: z.string(),
   href: z.string(),
-  icon: z.string(),
+  icon: z.string().optional(),
 })
 
 /**
@@ -19,7 +19,7 @@ export type TLinkSchema = {
   /** The URL the link points to. */
   href: string
   /** The icon associated with the link. */
-  icon: string
+  icon?: string
 }
 
 /**
@@ -76,7 +76,7 @@ export type GitHubRepositoryAPIResponse = NonNullable<
  * Schema for loader options.
  */
 export const LoaderOptions = z.object({
-  username: z.string(),
+  username: z.string().optional(),
   debug: z.boolean(),
   orgs: z.array(z.string()).optional(),
   filter: z
@@ -93,12 +93,18 @@ export const LoaderOptions = z.object({
  * Schema for loader options.
  */
 export type LoaderOptionsType = {
-  /** The username from GitHub to fetch the repositories from. */
-  username: string
+  /**
+   * The username from GitHub to fetch the repositories from.
+   * At least one of `username`, `orgs` must be present in order to have any content to load.
+   */
+  username?: string
+  /**
+   * GitHub organizations to fetch projects from.
+   * At least one of `username`, `orgs` must be present in order to have any content to load.
+   */
+  orgs?: string[]
   /** Debug flag - if true, the loader will output debug information. */
   debug?: boolean
-  /** GitHub organizations to fetch projects from. */
-  orgs?: string[]
   /** A function to filter out projects. Filtered projects will not be parsed or saved in the collection. */
   // eslint-disable-next-line no-unused-vars
   filter?: (project: GitHubRepositoryAPIResponse) => boolean