Files
supabase/apps/studio/components/interfaces/SQLEditor/DownloadSnippetModal.tsx
Alaister Young 5f533247e1 Update docs url to env var (#38772)
* Update Supabase docs URLs to use env variable

Co-authored-by: a <a@alaisteryoung.com>

* Refactor: Use DOCS_URL constant for documentation links

This change centralizes documentation links using a new DOCS_URL constant, improving maintainability and consistency.

Co-authored-by: a <a@alaisteryoung.com>

* Refactor: Use DOCS_URL constant for all documentation links

This change replaces hardcoded documentation URLs with a centralized constant, improving maintainability and consistency.

Co-authored-by: a <a@alaisteryoung.com>

* replace more instances

* ci: Autofix updates from GitHub workflow

* remaining instances

* fix duplicate useRouter

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: alaister <10985857+alaister@users.noreply.github.com>
2025-09-26 10:16:33 +00:00

133 lines
4.6 KiB
TypeScript

import { snakeCase } from 'lodash'
import { ExternalLink } from 'lucide-react'
import Link from 'next/link'
import { useState } from 'react'
import type { ModalProps } from '@ui/components/Modal/Modal'
import TwoOptionToggle from 'components/ui/TwoOptionToggle'
import { DOCS_URL } from 'lib/constants'
import { useSqlEditorV2StateSnapshot } from 'state/sql-editor-v2'
import { Button, CodeBlock, Modal, Tabs } from 'ui'
import { Markdown } from '../Markdown'
import {
generateFileCliCommand,
generateMigrationCliCommand,
generateSeedCliCommand,
} from './SQLEditor.utils'
export interface DownloadSnippetModalProps extends ModalProps {
id: string
}
const DownloadSnippetModal = ({ id, ...props }: DownloadSnippetModalProps) => {
const snapV2 = useSqlEditorV2StateSnapshot()
const snippet = snapV2.snippets[id]?.snippet
const migrationName = snakeCase(snippet?.name)
const [selectedView, setSelectedView] = useState<'CLI' | 'NPM'>('CLI')
const SNIPPETS = [
{
id: 'migration',
label: 'Migration',
title: 'Download as migration',
description: `Download the snippet in a new migration named \`${migrationName}\``,
cli: generateMigrationCliCommand(id, migrationName),
npm: generateMigrationCliCommand(id, migrationName, true),
},
{
id: 'seed',
label: 'Seed file',
title: 'Download as seed file',
description:
'If your query consists of sample data, append the snippet to the end of `supabase/seed.sql`',
cli: generateSeedCliCommand(id),
npm: generateSeedCliCommand(id, true),
},
{
id: 'sql',
label: 'SQL file',
title: 'Download as SQL file',
description: `Download the snippet directly into a new SQL file named \`${migrationName}.sql\``,
cli: generateFileCliCommand(id, migrationName),
npm: generateFileCliCommand(id, migrationName, true),
},
]
return (
<Modal
hideFooter
showCloseButton
size="xlarge"
header={<p>Download snippet as local migration file via the Supabase CLI.</p>}
{...props}
>
<div className="flex flex-col items-start justify-between gap-4 relative pt-2">
<Tabs type="underlined" listClassNames="pl-5">
{SNIPPETS.map((snippet) => {
return (
<Tabs.Panel key={snippet.id} id={snippet.id} label={snippet.label}>
<Modal.Content className="!py-0">
<div className="flex items-center justify-between mb-3">
<div className="flex flex-col gap-y-1">
<p className="text-base">{snippet.title}</p>
<Markdown
className="text-sm text-scale-1000 [&>p>code]:!break-normal"
content={snippet.description}
/>
</div>
<TwoOptionToggle
width={50}
options={['CLI', 'NPM']}
activeOption={selectedView}
borderOverride="border-muted"
onClickOption={() =>
selectedView === 'CLI' ? setSelectedView('NPM') : setSelectedView('CLI')
}
/>
</div>
<pre>
<CodeBlock
language="bash"
className="language-bash prose dark:prose-dark max-w-none"
>
{selectedView === 'CLI' ? snippet.cli : snippet.npm}
</CodeBlock>
</pre>
</Modal.Content>
</Tabs.Panel>
)
})}
</Tabs>
<Modal.Content className="w-full flex items-center justify-between pt-0">
<p className="text-xs text-lighter">Run this command from your project directory</p>
<div className="flex justify-between items-center gap-x-2">
<Button asChild type="default" icon={<ExternalLink strokeWidth={1.5} />}>
<Link
href={`${DOCS_URL}/guides/deployment/database-migrations`}
target="_blank"
rel="noreferrer"
>
About migrations
</Link>
</Button>
<Button asChild type="default" icon={<ExternalLink strokeWidth={1.5} />}>
<Link
href={`${DOCS_URL}/guides/cli/local-development`}
target="_blank"
rel="noreferrer"
>
About CLI
</Link>
</Button>
</div>
</Modal.Content>
</div>
</Modal>
)
}
export default DownloadSnippetModal