mirror of
https://github.com/supabase/supabase.git
synced 2026-09-22 13:37:53 +08:00
Saxon Fletcher
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>
67 lines
2.7 KiB
TypeScript
67 lines
2.7 KiB
TypeScript
import { afterEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import { getInstallCommands } from '../lib/install-command'
|
|
|
|
afterEach(() => {
|
|
vi.unstubAllEnvs()
|
|
})
|
|
|
|
describe('registry install commands', () => {
|
|
it('uses the React namespace in production for each package manager', () => {
|
|
expect(getInstallCommands('dropzone-react', { production: true })).toEqual({
|
|
npm: 'npx shadcn@latest add @supabase/dropzone-react',
|
|
pnpm: 'pnpm dlx shadcn@latest add @supabase/dropzone-react',
|
|
yarn: 'yarn dlx shadcn@latest add @supabase/dropzone-react',
|
|
bun: 'bunx --bun shadcn@latest add @supabase/dropzone-react',
|
|
})
|
|
})
|
|
|
|
it('uses the explicit Vue CLI and absolute production URL without namespace setup', () => {
|
|
for (const name of ['dropzone-vue', 'dropzone-nuxtjs', 'infinite-query-composable']) {
|
|
const commands = getInstallCommands(name, { framework: 'vue', production: true })
|
|
expect(commands.npm).toBe(
|
|
`npx shadcn-vue@latest add https://supabase.com/library/r/${name}.json`
|
|
)
|
|
expect(
|
|
Object.values(commands).every((command) =>
|
|
command.includes('shadcn-vue@latest add https://')
|
|
)
|
|
).toBe(true)
|
|
expect(Object.values(commands).every((command) => !command.includes('@supabase/'))).toBe(true)
|
|
}
|
|
})
|
|
|
|
it('does not guess the CLI from a registry name', () => {
|
|
expect(
|
|
getInstallCommands('vue-named-react-component', { framework: 'react', production: true }).npm
|
|
).toBe('npx shadcn@latest add @supabase/vue-named-react-component')
|
|
})
|
|
|
|
it('uses the configured preview hostname and base path for either CLI', () => {
|
|
vi.stubEnv('NEXT_PUBLIC_VERCEL_TARGET_ENV', 'preview')
|
|
vi.stubEnv('NEXT_PUBLIC_VERCEL_BRANCH_URL', 'library-example.vercel.app')
|
|
vi.stubEnv('NEXT_PUBLIC_BASE_PATH', '/library')
|
|
|
|
expect(getInstallCommands('infinite-query-composable', { framework: 'vue' }).pnpm).toBe(
|
|
'pnpm dlx shadcn-vue@latest add https://library-example.vercel.app/library/r/infinite-query-composable.json'
|
|
)
|
|
expect(getInstallCommands('dropzone-react').npm).toBe(
|
|
'npx shadcn@latest add https://library-example.vercel.app/library/r/dropzone-react.json'
|
|
)
|
|
})
|
|
|
|
it('uses local registry URLs with and without a base path', () => {
|
|
vi.stubEnv('NEXT_PUBLIC_VERCEL_TARGET_ENV', 'development')
|
|
vi.stubEnv('NEXT_PUBLIC_BASE_PATH', undefined)
|
|
|
|
expect(getInstallCommands('dropzone-react').npm).toBe(
|
|
'npx shadcn@latest add http://localhost:3004/r/dropzone-react.json'
|
|
)
|
|
|
|
vi.stubEnv('NEXT_PUBLIC_BASE_PATH', '/library')
|
|
expect(getInstallCommands('dropzone-react').npm).toBe(
|
|
'npx shadcn@latest add http://localhost:3004/library/r/dropzone-react.json'
|
|
)
|
|
})
|
|
})
|