feat: branches check

src/checks/branches.js → src/checks/branches.ts

@@ -1,19 +1,21 @@
-export default function branches(branches) {
+import { Branch } from "@/models/github/branch";
+import { StatusCheck } from "@/types/checks";
+
+export default function branches(branches: Branch[]) {
   const min = 5;
   const max = 10;
 
-  let response = {
-    id: "branches",
-    href: "/repo/status",
+  const response: StatusCheck = {
     title: "Branches",
+    status: "unknown",
+    description: "-",
+    extra: "-",
   };
 
   if (!branches) {
     return {
       ...response,
-      status: "-",
       description: "No data available",
-      extra: "-",
     };
   }
 

src/checks/index.ts

@@ -26,7 +26,7 @@ export default function checks(data: Data) {
     issues(data.repo),
     defaultBranch(data.repo),
     goodFirstIssue(data.issues),
-    // branches(data.branches),
+    branches(data.branches),
     // release(data.release),
     readme(data.community),
     license(data.community),

src/lib/github/getAllApi.ts

@@ -2,18 +2,21 @@ import Data from "@/models/data";
 import getRepoApi from "./getRepoApi";
 import getIssuesApi from "./getIssuesApi";
 import getCommunityApi from "./getCommunityApi";
+import getBranchesApi from "./getBranchesApi";
 
 export default async function getAllApi(repoUrl: string): Promise<Data> {
   const calls = await Promise.all([
     getRepoApi(repoUrl),
     getIssuesApi(repoUrl),
     getCommunityApi(repoUrl),
+    getBranchesApi(repoUrl),
   ]);
 
   const data: Data = {
     repo: calls[0],
     issues: calls[1],
     community: calls[2],
+    branches: calls[3],
   };
 
   return data;

src/lib/github/getBranchesApi.ts

@@ -0,0 +1,16 @@
+import extractOwnerRepo from "./extractOwnerRepo";
+import { Branch } from "@/models/github/branch";
+
+export default async function getBranchesApi(repoUrl: string) {
+  const { owner, repo } = extractOwnerRepo(repoUrl);
+  const res = await fetch(
+    `https://api.github.com/repos/${owner}/${repo}/branches`,
+    {
+      next: { revalidate: 3600 },
+    }
+  );
+
+  const data: Branch[] = await res.json();
+
+  return data;
+}

src/models/data.ts

@@ -1,3 +1,4 @@
+import { Branch } from "./github/branch";
 import { Community } from "./github/community";
 import { Issue } from "./github/issue";
 import { Repo } from "./github/repo";
@@ -6,4 +7,5 @@ export default interface Data {
   repo: Repo;
   issues: Issue[];
   community: Community;
+  branches: Branch[];
 }

src/models/github/branch.ts

@@ -0,0 +1,19 @@
+// To parse this data:
+//
+//   import { Convert } from "./file";
+//
+//   const branch = Convert.toBranch(json);
+//
+// These functions will throw an error if the JSON doesn't
+// match the expected interface, even if the JSON is valid.
+
+export interface Branch {
+  name: string;
+  commit: Commit;
+  protected: boolean;
+}
+
+export interface Commit {
+  sha: string;
+  url: string;
+}