mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
## 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>
91 lines
3.0 KiB
TypeScript
91 lines
3.0 KiB
TypeScript
import * as fs from 'fs'
|
|
import * as path from 'path'
|
|
|
|
import { normalizeVueRegistryFiles } from '../lib/registry-resolution'
|
|
|
|
function processJsonFile(filePath: string) {
|
|
try {
|
|
// Read the file
|
|
const content = fs.readFileSync(filePath, 'utf8')
|
|
const json = JSON.parse(content)
|
|
|
|
// Normalize only after shadcn build has read the original package source files.
|
|
for (const item of Array.isArray(json.items) ? json.items : [json]) {
|
|
if (Array.isArray(item.files)) item.files = normalizeVueRegistryFiles(item.files)
|
|
}
|
|
|
|
// Convert to string to do replacement
|
|
let stringified = JSON.stringify(json, null, 2)
|
|
|
|
// Perform the replacement
|
|
stringified = stringified
|
|
.replace(/\/ui\/example\/password-based-auth/g, '')
|
|
.replace(/\/example\/password-based-auth/g, '')
|
|
.replaceAll(
|
|
"import { Link } from '@/registry/default/components/ui/link'",
|
|
"import Link from 'next/link'"
|
|
)
|
|
// Replace the file origin path to exclude the monorepo structure
|
|
.replaceAll('node_modules/@supabase/vue-blocks/', '')
|
|
|
|
// Blocks that combine() across all client variants hard-code the nextjs
|
|
// client path in their source. Rewrite that import per-variant so each
|
|
// generated artifact points at the client file it actually bundles.
|
|
const variantClientMap: Record<string, string> = {
|
|
react: 'react',
|
|
'react-router': 'react-router',
|
|
tanstack: 'tanstack',
|
|
}
|
|
const baseName = path.basename(filePath, '.json')
|
|
for (const [suffix, clientDir] of Object.entries(variantClientMap)) {
|
|
if (baseName.endsWith(`-${suffix}`)) {
|
|
stringified = stringified.replaceAll(
|
|
'@/registry/default/clients/nextjs/lib/supabase/client',
|
|
`@/registry/default/clients/${clientDir}/lib/supabase/client`
|
|
)
|
|
break
|
|
}
|
|
}
|
|
|
|
// Registry source routes are absent from this app's generated TanStack tree.
|
|
// Consumers generate their own tree, where this suppression would be unused.
|
|
stringified = stringified.replaceAll(
|
|
'// @ts-expect-error The local generated route tree does not include this block route.\\n',
|
|
''
|
|
)
|
|
|
|
// Write back to file
|
|
fs.writeFileSync(filePath, stringified)
|
|
console.log(`✓ Updated ${filePath}`)
|
|
} catch (error) {
|
|
throw new Error(`Unable to prepare registry artifact "${filePath}"`, { cause: error })
|
|
}
|
|
}
|
|
|
|
function processDirectory(directoryPath: string) {
|
|
const files = fs.readdirSync(directoryPath)
|
|
|
|
files.forEach((file) => {
|
|
const fullPath = path.join(directoryPath, file)
|
|
const stat = fs.statSync(fullPath)
|
|
|
|
if (stat.isDirectory()) {
|
|
processDirectory(fullPath)
|
|
} else if (path.extname(file) === '.json') {
|
|
processJsonFile(fullPath)
|
|
}
|
|
})
|
|
}
|
|
|
|
// Start processing from the specified directory
|
|
const targetDir = path.join(process.cwd(), 'public/r')
|
|
|
|
if (!fs.existsSync(targetDir)) {
|
|
console.error('Target directory does not exist:', targetDir)
|
|
process.exit(1)
|
|
}
|
|
|
|
console.log('Starting JSON file processing...')
|
|
processDirectory(targetDir)
|
|
console.log('Processing complete!')
|