mirror of
https://github.com/supabase/supabase.git
synced 2026-09-22 13:37:53 +08:00
abbac3b852
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? Refactor, bug fix. Part 1 of 6 in a stack that splits the library redesign into reviewable pieces. This one is the foundation the rest build on and has no visual change. ## What is the current behavior? Three build steps each reimplement "where does this registry file land in the user's project": `process-registry`'s `getDefaultPath`, `registry/utils`' `uniqBy` on `file.path`, and the Markdown exporter. They disagree, which produces real bugs: - A Vue block whose files come from `node_modules/@supabase/vue-blocks/` keeps its package path, so the installer writes the package folder into the user's project. - `registryItemAppend` builds its `docs` string from `(item.docs, items.flatMap(...))` — a comma expression, so the item's own docs are discarded. - A name collision between a block file and its client's file silently keeps one of the two. - Install commands guess the CLI family from substrings in the item name, so `infinite-query-composable` — a Vue block with neither "vue" nor "nuxtjs" in its name — gets the React CLI. - Production Vue installs use `@supabase/<name>`, but the `@supabase` namespace is registered with shadcn, not shadcn-vue. - `build:registry`, `build:content`, `build:markdown` and `build:llms` run in parallel, but the last three read `public/r`. ## What is the new behavior? `lib/registry-resolution.ts` owns installed-path derivation, first-party dependency naming, deduplication, and cycle detection, and every consumer calls it. `build-registry` validates the whole registry against shadcn's schema and resolves every item, so a broken reference fails the build instead of shipping. `clean-registry` throws rather than logging past a failure. Pages declare their install `framework` explicitly instead of it being inferred, and production Vue installs use the absolute registry URL. The build steps are serialized behind `build:prepare`, and a new `library-tests.yml` workflow runs the library's tests, checks the generated registry is committed, and builds the app. ## Additional context Regenerated registry artifacts are the mechanical result of the resolution fix — the Vue client items and the OAuth consent items that gained their client's docs. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added explicit React and Vue framework selection for library blocks and installation commands. * Improved registry resolution, dependency handling, path validation, and Vue file normalization. * Added support for reliable local, preview, and production registry URLs. * **Documentation** * Updated Vue and Nuxt installation documentation to identify the Vue framework explicitly. * **Bug Fixes** * Preserved combined documentation and validated generated registry content more consistently. * **Tests** * Added coverage for installation commands, registry resolution, dependency handling, and generated artifacts. * **Chores** * Added automated pull-request checks for library tests and builds. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 5 <noreply@anthropic.com> Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
32 lines
1.2 KiB
TypeScript
32 lines
1.2 KiB
TypeScript
export type PackageManager = 'npm' | 'pnpm' | 'yarn' | 'bun'
|
|
export type ShadcnFramework = 'react' | 'vue'
|
|
|
|
function getRegistrySpecifier(name: string, framework: ShadcnFramework, env?: string): string {
|
|
if (env === 'production') {
|
|
// The Supabase namespace is registered with shadcn, but not shadcn-vue.
|
|
return framework === 'vue' ? `https://supabase.com/library/r/${name}.json` : `@supabase/${name}`
|
|
}
|
|
const origin =
|
|
env === 'preview'
|
|
? `https://${process.env.NEXT_PUBLIC_VERCEL_BRANCH_URL}`
|
|
: 'http://localhost:3004'
|
|
return `${origin}${process.env.NEXT_PUBLIC_BASE_PATH ?? ''}/r/${name}.json`
|
|
}
|
|
|
|
export function getInstallCommands(
|
|
name: string,
|
|
options?: { framework?: ShadcnFramework; production?: boolean }
|
|
): Record<PackageManager, string> {
|
|
const framework = options?.framework ?? 'react'
|
|
const env = options?.production ? 'production' : process.env.NEXT_PUBLIC_VERCEL_TARGET_ENV
|
|
const specifier = getRegistrySpecifier(name, framework, env)
|
|
const cli = framework === 'vue' ? 'shadcn-vue@latest' : 'shadcn@latest'
|
|
|
|
return {
|
|
npm: `npx ${cli} add ${specifier}`,
|
|
pnpm: `pnpm dlx ${cli} add ${specifier}`,
|
|
yarn: `yarn dlx ${cli} add ${specifier}`,
|
|
bun: `bunx --bun ${cli} add ${specifier}`,
|
|
}
|
|
}
|