| 1 | // Namespaces follow GitHub's rules (no leading, trailing or doubled hyphens), |
| 2 | // so "--" can never appear inside one. |
| 3 | const NAMESPACE = /^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){0,38}$/; |
| 4 | const REPO_NAME = /^[a-z0-9._-]{1,100}$/; |
| 5 | |
| 6 | /** Routes and reserved words that may not be registered as usernames. */ |
| 7 | const RESERVED = new Set([ |
| 8 | "api", "mcp", "login", "logout", "register", "new", "settings", "search", |
| 9 | "admin", "auth", "integrations", "pulls", "issues", "verify", "confirm-email", "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. `ghost` wrote what |
| 12 | // a deleted account wrote (`GHOST_USERNAME`). |
| 13 | "g1t", "g1t-agent", "ghost", |
| 14 | // Trust pages on g1t.sh, and names kept for them. |
| 15 | "policies", "security", "support", "status", "terms", "privacy", "help", "blog", |
| 16 | // Invite links, and the retired waitlist. |
| 17 | "invite", "invites", "waitlist", |
| 18 | // g1t.sh/invitations: the workspace invitations waiting for an answer. |
| 19 | "invitations", |
| 20 | // The container registry, at g1t.sh/v2/. |
| 21 | "v2", |
| 22 | // g1t.sh/inbox, and the name it might also go by. |
| 23 | "inbox", "notifications", |
| 24 | // g1t.sh/download, the desktop app; g1t.sh/downloads/, the releases it and the runner come from. |
| 25 | "download", "downloads", |
| 26 | // g1t.sh/install and g1t.sh/install.ps1, the CLI's install scripts. |
| 27 | "install", |
| 28 | ]); |
| 29 | |
| 30 | /** |
| 31 | * The GitHub accounts whose actions workflows use most. `uses: |
| 32 | * actions/setup-node@v4` means GitHub's `actions`, so nobody may register |
| 33 | * these on g1t; an account that already has one keeps it. The list is |
| 34 | * crates/contracts/src/names.rs's `ACTION_OWNERS`. |
| 35 | */ |
| 36 | const ACTION_OWNERS = new Set([ |
| 37 | "actions", "actions-ecosystem", "actions-rs", "amannn", "anchore", "appleboy", "aquasecurity", |
| 38 | "arduino", "astral-sh", "aws-actions", "azure", "browser-actions", "bufbuild", "cachix", |
| 39 | "changesets", "chromaui", "cloudflare", "codecov", "conda-incubator", "coursier", "crazy-max", |
| 40 | "cypress-io", "dawidd6", "denoland", "dependabot", "dessant", "determinatesystems", |
| 41 | "devcontainers", "digitalocean", "docker", "dorny", "dtolnay", "endbug", "erlef", |
| 42 | "firebaseextended", "fluxcd", "getsentry", "github", "golangci", "google-github-actions", |
| 43 | "googleapis", "goreleaser", "gradle", "gradle-update", "hadolint", "hashicorp", |
| 44 | "haskell-actions", "hecrj", "helm", "ilammy", "jamesives", "jetbrains", "julia-actions", |
| 45 | "kubernetes-sigs", "lukka", "marocchino", "microsoft", "mikepenz", "mozilla-actions", "msys2", |
| 46 | "mxschmitt", "ncipollo", "netlify", "nick-fields", "nwtgck", "octokit", "ossf", "oven-sh", |
| 47 | "peaceiris", "peter-evans", "pnpm", "pre-commit", "pypa", "r-lib", "release-drafter", |
| 48 | "renovatebot", "reviewdog", "rhysd", "ruby", "rust-lang", "sbt", "shivammathur", "sigstore", |
| 49 | "slackapi", "slsa-framework", "snyk", "softprops", "sonarsource", "stefanzweifel", |
| 50 | "step-security", "styfle", "subosito", "supabase", "super-linter", "superfly", "svenstaro", |
| 51 | "swatinem", "taiki-e", "tj-actions", "treosh", "vercel", "webfactory", |
| 52 | ]); |
| 53 | |
| 54 | /** Whether `value`, whatever its case, names a well-known GitHub action owner. */ |
| 55 | export function isActionOwnerName(value: string): boolean { |
| 56 | return ACTION_OWNERS.has(value.trim().toLowerCase()); |
| 57 | } |
| 58 | |
| 59 | /** Whether a person or workspace may take `value` as its name now: valid, and no well-known action owner's. */ |
| 60 | export function isClaimableName(value: string): boolean { |
| 61 | return isValidNamespace(value) && !isActionOwnerName(value); |
| 62 | } |
| 63 | |
| 64 | /** Whether `value`, whatever its case, is a name nobody can register: a route, or g1t's own. */ |
| 65 | export function isReservedName(value: string): boolean { |
| 66 | return RESERVED.has(value.trim().toLowerCase()); |
| 67 | } |
| 68 | |
| 69 | export function isValidNamespace(value: string): boolean { |
| 70 | return isNamespaceShaped(value) && !isReservedName(value); |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Whether `value` has a namespace's shape, reserved or not: what a |
| 75 | * workspace's old name or an alias staff set (such as `g1t`) can be. |
| 76 | */ |
| 77 | export function isNamespaceShaped(value: string): boolean { |
| 78 | return NAMESPACE.test(value); |
| 79 | } |
| 80 | |
| 81 | /** |
| 82 | * Usernames: letters of either case, digits and single hyphens, not |
| 83 | * starting or ending with a hyphen, 1 to 39 characters, never reserved in |
| 84 | * any case. The case is kept for showing; everything finds a person by the |
| 85 | * name lowercased (`canonicalUsername`), so `Ana` and `ana` are one name. |
| 86 | */ |
| 87 | const USERNAME = /^[A-Za-z0-9](?:[A-Za-z0-9]|-(?=[A-Za-z0-9])){0,38}$/; |
| 88 | |
| 89 | /** The `pattern` a username field takes in a form: the same rule, for the browser. */ |
| 90 | export const USERNAME_PATTERN = "[A-Za-z0-9](?:[A-Za-z0-9]|-(?=[A-Za-z0-9]))*"; |
| 91 | |
| 92 | export function isValidUsername(value: string): boolean { |
| 93 | const name = value.trim(); |
| 94 | return USERNAME.test(name) && !isReservedName(name) && !isActionOwnerName(name); |
| 95 | } |
| 96 | |
| 97 | /** The name a person is found, linked and mentioned by: lowercased. */ |
| 98 | export function canonicalUsername(value: string): string { |
| 99 | return value.trim().toLowerCase(); |
| 100 | } |
| 101 | |
| 102 | /** How a person's username shows: as they wrote it, or as it is kept. */ |
| 103 | export function shownUsername(person: { username: string; display_username?: string | null; displayUsername?: string | null }): string { |
| 104 | const display = person.display_username ?? person.displayUsername; |
| 105 | return display && display.toLowerCase() === person.username.toLowerCase() ? display : person.username; |
| 106 | } |
| 107 | |
| 108 | export function isValidRepoName(value: string): boolean { |
| 109 | return ( |
| 110 | REPO_NAME.test(value) && |
| 111 | !value.startsWith(".") && |
| 112 | !value.endsWith(".git") && |
| 113 | // `/<workspace>/-/…` holds the workspace's own pages. |
| 114 | value !== "-" |
| 115 | ); |
| 116 | } |