Files
supabase/apps/docs/features/directives/CodeSample.client.tsx
Alaister Young ca2b50a0a7 chore(ui-patterns): collapse the admonition shim into ui-patterns/Admonition (#48377)
Follow-up to #48344: collapses the two resolution paths for the
Admonition module into one.

`src/admonition.tsx` was a back-compat shim re-exporting
`src/Admonition/`. Two ways to resolve one module is exactly what
produced the macOS self-import bug fixed in #48344, and the local
typecheck errors that #48374 worked around. This removes the shim and
standardizes on the PascalCase subpath, matching every other export in
the package.

**Changed:**

- Codemodded all 246 `ui-patterns/admonition` imports to
`ui-patterns/Admonition` (240 `.tsx`, 5 `.mdx`, 1 `.ts` across studio,
docs, www, design-system, and lite-studio)
- Pointed the 5 internal `'../admonition'` imports back at the
`'../Admonition'` directory

**Removed:**

- `packages/ui-patterns/src/admonition.tsx`, and its `./admonition`
entry in the exports map (regenerated with `pnpm gen:exports`)

## To test

- `grep -r "ui-patterns/admonition" --include='*.ts*'` → no hits
- `pnpm test:case-hazards` → passes
- `pnpm typecheck` → all 15 tasks green
- `pnpm --filter studio run lint:ratchet` → passes
- `pnpm --filter ui-patterns vitest run src/Admonition` → 11 tests pass

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Bug Fixes**
* Standardized Admonition component imports across the application and
documentation.
* Improved compatibility with case-sensitive environments by using the
canonical component path.
  * Removed the legacy Admonition import entry point.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com>
2026-07-29 00:48:56 +08:00

81 lines
2.3 KiB
TypeScript

'use client'
import Link from 'next/link'
import { useState, type PropsWithChildren } from 'react'
import { DropdownMenu, DropdownMenuContent, DropdownMenuItem, DropdownMenuTrigger } from 'ui'
import { Admonition } from 'ui-patterns/Admonition'
export function CodeSampleDummy() {
return (
<Admonition type="caution" title="Local development warning">
The <code>$CodeSample</code> directive with external repos is not supported in local
development because it relies on a GitHub API key. Please check the preview site to see the
final UI.
</Admonition>
)
}
export function CodeSampleWrapper({
children,
/**
* A GitHub URL to the source code file.
*/
source: _source,
}: PropsWithChildren<{ source: string | URL | (string | URL)[] }>) {
const source = Array.isArray(_source) ? _source : [_source]
if (source.length === 1) {
return <SingleSource source={source[0]}>{children}</SingleSource>
}
if (source.length > 1) {
return <MultipleSources sources={source}>{children}</MultipleSources>
}
return <>{children}</>
}
function MultipleSources({ children, sources }: PropsWithChildren<{ sources: (string | URL)[] }>) {
return (
<>
{children}
<DropdownMenu>
<DropdownMenuTrigger asChild>
<button
tabIndex={0}
className="block -mt-4 mb-4 ml-auto text-foreground-lighter text-sm focus-visible:outline-hidden focus-visible:underline"
>
View sources
</button>
</DropdownMenuTrigger>
<DropdownMenuContent align="end">
{sources.map((source) => (
<DropdownMenuItem
key={source.toString()}
onSelect={() => window.open(source.toString(), '_blank', 'noopener noreferrer')}
>
...{source.toString().split('/').slice(-2).join('/')}
</DropdownMenuItem>
))}
</DropdownMenuContent>
</DropdownMenu>
</>
)
}
function SingleSource({ children, source }: PropsWithChildren<{ source: string | URL }>) {
return (
<>
{children}
<Link
href={source.toString()}
target="_blank"
rel="noopener noreferrer"
className="block -mt-5 mb-4 text-right no-underline text-foreground-lighter text-sm"
>
View source
</Link>
</>
)
}