g1t/apps/web/app/routes/repo/layout.tsx

201 lines8,570 bytesCodeBlame
1import { Box, Lock } from "lucide-react";
2import { Link, NavLink, Outlet, type ShouldRevalidateFunctionArgs, data, useLocation, useRouteLoaderData } from "react-router";
3
4import type { Project } from "@g1t/contracts";
5
6import type { Route } from "./+types/layout";
7import { Topics } from "../../components/topics";
8import { page } from "../../lib/meta";
9import { type Tab as PageTab, tabsFor } from "../../lib/project-nav";
10import { Pill } from "../../components/ui";
11import { ArchivedBanner } from "../../components/repo-lifecycle";
12import { WelcomeBanner } from "../../components/welcome";
13import { clearWelcome, welcomes } from "../../lib/invites";
14import { notFound } from "../../lib/not-found.server";
15import { redirectIfRenamed, redirectIfTransferred } from "../../lib/renamed.server";
16import { accessFor, countsFor, repoFor } from "../../lib/access.server";
17import { projects } from "../../lib/services.server";
18import { getViewer, unwrap } from "../../lib/session.server";
19
20export function meta({ loaderData: loaded, params, ...args }: Route.MetaArgs) {
21 return page(args, { title: `${loaded?.project?.name ?? params.repo} · ${params.owner} · g1t` });
22}
23
24export async function loader({ params, context, request }: Route.LoaderArgs) {
25 const viewer = getViewer(context);
26 const path = { namespace: params.owner, name: params.repo };
27 const [repo, counts, found] = await Promise.all([
28 repoFor(context, params),
29 countsFor(context, params),
30 projects.get(params.owner, params.repo, viewer),
31 ]);
32 if (!repo.ok && !found.ok) {
33 // Under a workspace's old name, after a rename: the project is at the new one.
34 await redirectIfRenamed(request, params.owner);
35 // A repository transferred to another workspace: it is there now.
36 await redirectIfTransferred(request, params.owner, params.repo, viewer);
37 throw notFound("project");
38 }
39 let project: Project | null = found.ok ? found.value : null;
40 // A repository made a moment ago, before its project: make it now.
41 if (!project && repo.ok && !repo.value.forkOf) {
42 const own = await projects.byRepo(repo.value.id);
43 project = own.find((p) => p.slug === params.repo.toLowerCase()) ?? own[0] ?? null;
44 }
45 const value = unwrap(repo);
46 // The viewer's role on the repository and what it lets them do, for the
47 // pages under it and the sidebar.
48 const access = accessFor(viewer, value);
49 // Just given access with an invite: welcomed once (routes/invite.tsx).
50 const welcome = Boolean(access.role) && welcomes(request.headers.get("cookie"), `${value.namespace}/${value.name}`);
51 const headers = welcome ? { "Set-Cookie": clearWelcome(new URL(request.url).protocol === "https:") } : undefined;
52 return data({
53 welcome,
54 repo: value,
55 project,
56 open: counts.ok ? counts.value : { issues: 0, pulls: 0 },
57 access,
58 member: access.insider,
59 }, { headers });
60}
61
62/**
63 * The project's header, tabs and the viewer's role change with the project
64 * or after something was submitted, not from one page of it to the next,
65 * nor when a page refreshes itself.
66 */
67export function shouldRevalidate({ currentParams, nextParams, formMethod, defaultShouldRevalidate }: ShouldRevalidateFunctionArgs) {
68 if (formMethod && formMethod !== "GET") return defaultShouldRevalidate;
69 return currentParams.owner !== nextParams.owner || currentParams.repo !== nextParams.repo;
70}
71
72/** The project the page is in, for the pages under it. */
73export function useProject() {
74 return useRouteLoaderData<typeof loader>("routes/repo/layout");
75}
76
77/** A repository's topics, each a way into Explore. */
78function Header({ project, isPrivate, archived, namespace, name, description, large }: {
79 project: Project | null;
80 isPrivate: boolean;
81 namespace: string;
82 name: string;
83 description: string | null;
84 archived?: boolean;
85 large?: boolean;
86}) {
87 const base = `/${namespace}/${name}`;
88 return (
89 <div className="flex flex-wrap items-center gap-x-3 gap-y-1">
90 <span
91 className={`flex shrink-0 items-center justify-center rounded-md bg-raised text-muted ring-1 ring-line ${large ? "size-8" : "size-6"}`}
92 >
93 {isPrivate ? <Lock size={large ? 15 : 13} /> : <Box size={large ? 15 : 13} />}
94 </span>
95 <h1 className={large ? "text-lg" : "text-[0.9375rem]"}>
96 <Link to={`/${namespace}`} className="font-mono text-muted hover:text-fg">
97 {namespace}
98 </Link>
99 <span className="mx-1.5 text-faint">/</span>
100 <Link to={base} className="font-semibold hover:underline">
101 {project?.name ?? name}
102 </Link>
103 </h1>
104 <Pill>{isPrivate ? "private" : "public"}</Pill>
105 {archived && <Pill>archived</Pill>}
106 {description && <p className="min-w-0 truncate text-sm text-muted">{description}</p>}
107 </div>
108 );
109}
110
111/**
112 * The views of the page the project is on, as tabs across its top: Files,
113 * Commits and what is coming under Code, and so on. Soon tabs open their
114 * roadmap page, under the same tabs.
115 */
116function PageTabs({ base, tabs }: { base: string; tabs: PageTab[] }) {
117 const { pathname } = useLocation();
118 const rest = pathname.slice(base.length + 1);
119 const current = (tab: PageTab) =>
120 [tab.path, ...(tab.also ?? [])].some((path) => rest === path || rest.startsWith(`${path}/`));
121 return (
122 <nav aria-label="Views" className="relative -mb-px flex gap-1 overflow-x-auto [scrollbar-width:none] [&::-webkit-scrollbar]:hidden">
123 {tabs.map((tab) => (
124 <NavLink
125 key={tab.path}
126 to={`${base}/${tab.path}`}
127 title={tab.about}
128 prefetch="intent"
129 className={`flex shrink-0 items-center gap-1.5 border-b-2 px-3 pt-1 pb-2.5 text-sm transition-colors ${
130 current(tab)
131 ? "border-accent font-medium text-fg"
132 : tab.soon
133 ? "border-transparent text-faint hover:text-muted"
134 : "border-transparent text-muted hover:text-fg"
135 }`}
136 >
137 {tab.label}
138 {/* Soon, said quietly: a dot, with the word for screen readers. */}
139 {tab.soon && (
140 <>
141 <span aria-hidden="true" className="size-1.5 rounded-full bg-accent/70" />
142 <span className="sr-only">(soon)</span>
143 </>
144 )}
145 </NavLink>
146 ))}
147 </nav>
148 );
149}
150
151export default function ProjectLayout({ loaderData }: Route.ComponentProps) {
152 const { repo, project, member, access, welcome } = loaderData;
153 const base = `/${repo.namespace}/${repo.name}`;
154 // The project's own description, else the repository's as it is now.
155 const description = (project && !project.descriptionInherited ? project.description : null) ?? repo.description;
156 const { pathname } = useLocation();
157 const tabs = tabsFor(pathname.slice(base.length + 1), member, access.can);
158 // The files' own About says what it is and its topics, as the one place.
159 const filesPage = /^(code|tree|blob|commits?|branches|tags|compare)(\/|$)/.test(pathname.slice(base.length + 1));
160 // Everyone, signed in or not, finds the project's pages in the sidebar;
161 // the page shows its name, and the views of the page it is on as tabs.
162 return (
163 <>
164 <div className="border-b border-line">
165 <div className={`mx-auto max-w-6xl px-4 sm:px-6 ${tabs ? "pt-3" : "py-3"}`}>
166 <Header
167 project={project}
168 isPrivate={repo.isPrivate}
169 archived={Boolean(repo.archivedAt)}
170 namespace={repo.namespace}
171 name={repo.name}
172 // The files' own About says it there, as the one place.
173 description={filesPage ? null : description}
174 />
175 {/* On the files' pages, About shows them. */}
176 {!filesPage && <Topics topics={repo.topics} />}
177 {tabs && (
178 <div className="mt-3">
179 <PageTabs base={base} tabs={tabs} />
180 </div>
181 )}
182 </div>
183 </div>
184 <div className="mx-auto max-w-6xl px-4 py-6 sm:px-6">
185 {welcome && (
186 <div className="mb-6">
187 <WelcomeBanner title={`You're in ${repo.namespace}/${repo.name}`}>
188 You have the {access.role} role on it now. Its code, issues and pull requests are yours to work on.
189 </WelcomeBanner>
190 </div>
191 )}
192 {repo.archivedAt && (
193 <div className="mb-6">
194 <ArchivedBanner base={base} owner={access.can.administer} settings={/^settings(\/|$)/.test(pathname.slice(base.length + 1))} />
195 </div>
196 )}
197 <Outlet />
198 </div>
199 </>
200 );
201}