Skip to content

g1t/packages/contracts/src/names.ts

48 lines1,904 bytesCodeBlame
1// Namespaces follow GitHub's rules (no leading, trailing or doubled hyphens),
2// so "--" can never appear inside one.
3const NAMESPACE = /^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){0,38}$/;
4const REPO_NAME = /^[a-z0-9._-]{1,100}$/;
5
6/** Routes and reserved words that may not be registered as usernames. */
7const RESERVED = new Set([
8 "api", "mcp", "login", "logout", "register", "new", "settings", "search",
9 "admin", "auth", "integrations", "pulls", "issues", "verify", "forgot", "reset", "device", "workspaces", "u", "oauth", "assets", "avatars", "docs", "explore", "about", "pricing",
10 // g1t itself, and the name its agent once went by: everything g1t does is
11 // shown as `g1t`, so nobody else may be called either.
12 "g1t", "g1t-agent",
13 // Trust pages on g1t.sh, and names kept for them.
14 "policies", "security", "support", "status", "terms", "privacy", "help", "blog",
15 // Invite links, and the waitlist.
16 "invite", "invites", "waitlist",
17 // The container registry, at g1t.sh/v2/.
18 "v2",
19 // g1t.sh/inbox, and the name it might also go by.
20 "inbox", "notifications",
21]);
22
23/** Whether `value`, whatever its case, is a name nobody can register: a route, or g1t's own. */
24export function isReservedName(value: string): boolean {
25 return RESERVED.has(value.trim().toLowerCase());
26}
27
28export function isValidNamespace(value: string): boolean {
29 return isNamespaceShaped(value) && !isReservedName(value);
30}
31
32/**
33 * Whether `value` has a namespace's shape, reserved or not: what a
34 * workspace's old name or an alias staff set (such as `g1t`) can be.
35 */
36export function isNamespaceShaped(value: string): boolean {
37 return NAMESPACE.test(value);
38}
39
40export function isValidRepoName(value: string): boolean {
41 return (
42 REPO_NAME.test(value) &&
43 !value.startsWith(".") &&
44 !value.endsWith(".git") &&
45 // `/<workspace>/-/…` holds the workspace's own pages.
46 value !== "-"
47 );
48}