feat: improve and turn on readme display

for github only. added notes for enabling displaying readme for
other git servers in the future

src/lib/components/repo/utils.spec.ts

@@ -1,5 +1,5 @@
 import { describe, expect, test } from 'vitest'
-import { selectRepoFromCollection } from './utils'
+import { extractGithubDetails, selectRepoFromCollection } from './utils'
 import {
   collection_defaults,
   event_defaults,
@@ -159,3 +159,19 @@ describe('getSelectedRepo', () => {
     })
   })
 })
+
+describe('extractGithubDetails', () => {
+  ;[
+    'https://github.com/orgname/reponame.git',
+    'https://github.com/orgname/reponame',
+    'git@github.com:orgname/reponame',
+  ].forEach((clone) => {
+    describe(clone, () => {
+      test('returns correct org and repo', () => {
+        const res = extractGithubDetails(clone)
+        expect(res?.org).toEqual('orgname')
+        expect(res?.repo_name).toEqual('reponame')
+      })
+    })
+  })
+})

src/lib/components/repo/utils.ts

@@ -15,3 +15,21 @@ export const selectRepoFromCollection = (
     return b_ref - a_ref
   })[0]
 }
+
+export const extractGithubDetails = (
+  clone: string
+): { org: string; repo_name: string } | undefined => {
+  if (clone.indexOf('github.') > -1) {
+    const g_split = clone.split('github.')
+    if (g_split.length > 0) {
+      const final = g_split[1].replace(':', '/').split('/')
+      if (final.length > 2) {
+        return {
+          org: final[1],
+          repo_name: final[2].split('.')[0],
+        }
+      }
+    }
+  }
+  return undefined
+}

src/lib/stores/repo.ts

@@ -10,7 +10,10 @@ import {
   readme_defaults,
 } from '$lib/components/repo/type'
 import { ensureRepoCollection } from './repos'
-import { selectRepoFromCollection } from '$lib/components/repo/utils'
+import {
+  extractGithubDetails,
+  selectRepoFromCollection,
+} from '$lib/components/repo/utils'
 import { get } from 'svelte/store'
 
 export const selected_repo_collection: Writable<RepoCollection> = writable({
@@ -103,41 +106,28 @@ const ensureRepoReadme = async (
   }
   try {
     const github_details = extractGithubDetails(clone)
-    // feature stapled off
+    let res: Response
-    const feature_staple = false
+    if (github_details) {
-    if (github_details && feature_staple) {
+      try {
-      const res = await fetch(
+        res = await fetch(
-        // `/git_proxy/readme?clone=${encodeURIComponent(clone)}`
+          `https://raw.githubusercontent.com/${github_details.org}/${github_details.repo_name}/HEAD/README.md`
-        `https://raw.githubusercontent.com/${github_details.org}/${github_details.repo_name}/HEAD/README.md`
+        )
-      )
+        if (!res.ok) {
-      if (!res.ok) {
+          throw 'api request error'
-        throw 'api request error'
+        }
+      } catch {
+        res = await fetch(
+          `https://raw.githubusercontent.com/${github_details.org}/${github_details.repo_name}/HEAD/readme.md`
+        )
       }
-      let text = ''
+    } else res = await fetch(`/git_proxy/readme/${encodeURIComponent(clone)}`)
-      text = await res.text()
+    if (!res.ok) {
-      update(text)
+      throw 'api request error'
-    } else {
-      // use proxy to get readme using 'git archive' or 'git clone'
     }
+    let text = ''
+    text = await res.text()
+    update(text)
   } catch (e) {
     update()
   }
 }
-
-const extractGithubDetails = (
-  clone: string
-): { org: string; repo_name: string } | undefined => {
-  if (clone.indexOf('github.') > -1) {
-    const g_split = clone.split('github.')
-    if (g_split.length > 0) {
-      const slash_split = g_split[1].split('/')
-      if (slash_split.length > 2) {
-        return {
-          org: slash_split[1],
-          repo_name: slash_split[2].split('.')[0],
-        }
-      }
-    }
-  }
-  return undefined
-}

src/lib/wrappers/RepoMenu.svelte

@@ -1,6 +1,7 @@
 <script lang="ts">
   import { issue_summaries } from '$lib/stores/Issues'
   import { proposal_summaries } from '$lib/stores/Proposals'
+  import { selected_repo_readme } from '$lib/stores/repo'
 
   export let selected_tab: '' | 'proposals' | 'issues' = ''
   export let identifier = ''
@@ -8,13 +9,15 @@
 
 <div class="flex border-b border-base-400">
   <div role="tablist" class="tabs tabs-bordered flex-none">
-    <a
+    {#if !$selected_repo_readme.failed}
-      href={`/repo/${identifier}`}
+      <a
-      class="tab"
+        href={`/repo/${identifier}`}
-      class:tab-active={selected_tab === ''}
+        class="tab"
-    >
+        class:tab-active={selected_tab === ''}
-      Code
+      >
-    </a>
+        Code
+      </a>
+    {/if}
     <a
       href={`/repo/${identifier}/proposals`}
       class="tab"

src/routes/git_proxy/readme/[clone]/+server.ts

@@ -0,0 +1,28 @@
+import { extractGithubDetails } from '$lib/components/repo/utils'
+
+export const GET = async ({ params }: { params: { clone: string } }) => {
+  const github_details = extractGithubDetails(decodeURIComponent(params.clone))
+  if (github_details) {
+    const res = await fetch(
+      `https://raw.githubusercontent.com/${github_details.org}/${github_details.repo_name}/HEAD/README.md`
+    )
+    const text = await res.text()
+
+    return new Response(text)
+  } else {
+    // options:
+    //  * add support for different git server implementations that serve raw
+    //    files and cycle through the urls until we find the readme
+    //  * add a worker that can use 'git archive' to get specific files
+    //    * unfortunately the two options that can easily embeded within this
+    //      sveltekit backend (wasm-git and isomorphicgit) don't support the
+    //      'archive' command
+    //      https://github.com/petersalomonsen/wasm-git/
+    //      https://github.com/isomorphic-git
+    //    * 'git clone' is too expensive for retrieving single files. even when
+    //      done using treeless or blobless flags. see:
+    //      https://noise.getoto.net/2020/12/21/get-up-to-speed-with-partial-clone-and-shallow-clone/
+
+    return new Response(null)
+  }
+}

src/routes/repo/[repo_id]/+page.svelte

@@ -1,39 +1,42 @@
 <script lang="ts">
-  import ProposalsList from '$lib/components/proposals/ProposalsList.svelte'
+  import { selected_repo_readme } from '$lib/stores/repo'
-  import { proposal_summaries } from '$lib/stores/Proposals'
+  import SvelteMarkdown from 'svelte-markdown'
   import RepoPageWrapper from '$lib/wrappers/RepoPageWrapper.svelte'
+  import { goto } from '$app/navigation'
 
   export let data: { repo_id: string }
   let identifier = data.repo_id
+
+  let selected_tab: '' | 'issues' | 'proposals' = ''
+  $: {
+    if ($selected_repo_readme.failed === true)
+      goto(`/repo/${identifier}/proposals`)
+  }
 </script>
 
-<RepoPageWrapper {identifier} selected_tab="proposals">
+<RepoPageWrapper {identifier} {selected_tab}>
-  <ProposalsList
+  <div class="my-3 rounded-lg border border-base-400">
-    proposals_or_issues={$proposal_summaries.summaries}
+    <div class="border-b border-base-400 bg-base-300 px-6 py-3">
-    loading={$proposal_summaries.loading}
+      <h4 class="">README.md</h4>
-  />
+    </div>
-  <div role="alert" class="alert mt-6">
+    <div class="p-6">
-    <svg
+      {#if $selected_repo_readme.loading}
-      xmlns="http://www.w3.org/2000/svg"
+        <div class="skeleton my-3 h-5 w-20"></div>
-      fill="none"
+        <div class="skeleton my-2 h-4"></div>
-      viewBox="0 0 24 24"
+        <div class="skeleton my-2 mb-3 h-4 w-2/3"></div>
-      class="h-6 w-6 shrink-0 stroke-info"
+        <div class="skeleton my-3 h-5 w-20"></div>
-      ><path
+        <div class="skeleton my-2 h-4"></div>
-        stroke-linecap="round"
+        <div class="skeleton my-2 mb-3 h-4 w-2/3"></div>
-        stroke-linejoin="round"
+      {:else if $selected_repo_readme.failed}
-        stroke-width="2"
+        <div>failed to load readme from git server...</div>
-        d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z"
+      {:else}
-      ></path></svg
+        <article class="prose prose-sm">
-    >
+          <SvelteMarkdown
-    <div>
+            options={{ gfm: true }}
-      <h3 class="prose mb-2 text-sm font-bold">want to submit a proposal?</h3>
+            source={$selected_repo_readme.md}
-      <p class="prose text-xs">
+          />
-        <a href="/ngit">install ngit</a>, create add a feature in the local
+        </article>
-        repository and run
+      {/if}
-        <span class="rounded bg-neutral p-1 font-mono"
-          ><span class="py-3">ngit send</span></span
-        >
-      </p>
     </div>
   </div>
 </RepoPageWrapper>

src/routes/repo/[repo_id]/proposals/+page.svelte

@@ -0,0 +1,39 @@
+<script lang="ts">
+  import ProposalsList from '$lib/components/proposals/ProposalsList.svelte'
+  import { proposal_summaries } from '$lib/stores/Proposals'
+  import RepoPageWrapper from '$lib/wrappers/RepoPageWrapper.svelte'
+
+  export let data: { repo_id: string }
+  let identifier = data.repo_id
+</script>
+
+<RepoPageWrapper {identifier} selected_tab="proposals">
+  <ProposalsList
+    proposals_or_issues={$proposal_summaries.summaries}
+    loading={$proposal_summaries.loading}
+  />
+  <div role="alert" class="alert mt-6">
+    <svg
+      xmlns="http://www.w3.org/2000/svg"
+      fill="none"
+      viewBox="0 0 24 24"
+      class="h-6 w-6 shrink-0 stroke-info"
+      ><path
+        stroke-linecap="round"
+        stroke-linejoin="round"
+        stroke-width="2"
+        d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z"
+      ></path></svg
+    >
+    <div>
+      <h3 class="prose mb-2 text-sm font-bold">want to submit a proposal?</h3>
+      <p class="prose text-xs">
+        <a href="/ngit">install ngit</a>, create add a feature in the local
+        repository and run
+        <span class="rounded bg-neutral p-1 font-mono"
+          ><span class="py-3">ngit send</span></span
+        >
+      </p>
+    </div>
+  </div>
+</RepoPageWrapper>

src/routes/repo/[repo_id]/proposals/+page.ts

@@ -0,0 +1,5 @@
+export const load = ({ params }: { params: { repo_id: string } }) => {
+  return {
+    repo_id: decodeURIComponent(params.repo_id),
+  }
+}