create-fumadocs-app 16.2.16 → 16.2.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bin.js +4 -3
- package/dist/bin.js.map +1 -1
- package/dist/{constants-1h2Bh1dA.js → constants-zMAyDXXs.js} +11 -14
- package/dist/{constants-1h2Bh1dA.js.map → constants-zMAyDXXs.js.map} +1 -1
- package/dist/{feature-D6asuidT.js → feature-_5VTBKAG.js} +2 -2
- package/dist/{feature-D6asuidT.js.map → feature-_5VTBKAG.js.map} +1 -1
- package/dist/index.js +1 -1
- package/dist/plugins/feature.js +1 -1
- package/dist/{src-BY4nWSTl.js → src-CA0piVVr.js} +2 -2
- package/dist/{src-BY4nWSTl.js.map → src-CA0piVVr.js.map} +1 -1
- package/package.json +2 -2
- package/template/+next+fuma-docs-mdx/package.json +1 -1
- package/template/+next+fuma-docs-mdx+static/components/search.tsx +5 -8
- package/template/+next+fuma-docs-mdx+static/package.json +1 -1
- package/template/astro/package.json +1 -1
- package/template/astro/src/components/search.tsx +5 -8
- package/template/react-router-spa/app/components/search.tsx +5 -8
- package/template/react-router-spa/app/lib/shared.ts +8 -0
- package/template/react-router-spa/app/routes/docs.tsx +14 -4
- package/template/react-router-spa/app/routes/og.docs.tsx +21 -0
- package/template/react-router-spa/app/routes.ts +1 -0
- package/template/react-router-spa/package.json +2 -1
- package/template/react-router-spa/react-router.config.ts +6 -1
- package/template/tanstack-start/package.json +2 -1
- package/template/tanstack-start/src/lib/shared.ts +8 -0
- package/template/tanstack-start/src/routes/docs/$.tsx +5 -1
- package/template/tanstack-start/src/routes/og/docs/$.ts +23 -0
- package/template/tanstack-start-spa/package.json +2 -1
- package/template/tanstack-start-spa/src/components/search.tsx +5 -8
- package/template/tanstack-start-spa/src/lib/shared.ts +8 -0
- package/template/tanstack-start-spa/src/routes/docs/$.tsx +5 -1
- package/template/tanstack-start-spa/src/routes/og/docs/$.ts +23 -0
- package/template/tanstack-start-spa/vite.config.ts +12 -1
package/dist/bin.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import { i as templates, n as isCI } from "./constants-
|
|
3
|
-
import { n as getPackageManager, r as managers, t as create } from "./src-
|
|
4
|
-
import { t as feature } from "./feature-
|
|
2
|
+
import { i as templates, n as isCI } from "./constants-zMAyDXXs.js";
|
|
3
|
+
import { n as getPackageManager, r as managers, t as create } from "./src-CA0piVVr.js";
|
|
4
|
+
import { t as feature } from "./feature-_5VTBKAG.js";
|
|
5
5
|
import fs from "node:fs/promises";
|
|
6
6
|
import path from "node:path";
|
|
7
7
|
import { cancel, confirm, group, intro, isCancel, outro, select, spinner, text } from "@clack/prompts";
|
|
@@ -209,6 +209,7 @@ async function main(defaultName, config) {
|
|
|
209
209
|
console.warn(pc.yellow("AI Chat is not supported by the Astro template yet, skipping it."));
|
|
210
210
|
options.aiChat = false;
|
|
211
211
|
}
|
|
212
|
+
if (options.ogImage === "next-og" && !options.template.startsWith("+next")) console.warn(pc.yellow("next/og is only available on Next.js, the template uses Takumi instead."));
|
|
212
213
|
if (!isCI) await checkDir(projectName, skipPrompts);
|
|
213
214
|
const info = spinner();
|
|
214
215
|
info.start(`Generating Project`);
|
package/dist/bin.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bin.js","names":[],"sources":["../src/bin.ts"],"sourcesContent":["#!/usr/bin/env node\nimport fs from 'node:fs/promises';\nimport path from 'node:path';\nimport {\n cancel,\n confirm,\n group,\n intro,\n isCancel,\n outro,\n select,\n spinner,\n text,\n} from '@clack/prompts';\nimport pc from 'picocolors';\nimport { getPackageManager, managers, type PackageManager } from './auto-install';\nimport { create, type Template, type TemplatePlugin } from './index';\nimport { isCI, templates } from './constants';\nimport { cac } from 'cac';\nimport { feature } from './plugins/feature';\nimport { ai, type AIProvider } from '@fumadocs/cli/features/ai';\nimport { lint } from '@fumadocs/cli/features/lint';\nimport { og } from '@fumadocs/cli/features/og';\nimport { search, type SearchProvider } from '@fumadocs/cli/features/search';\n\nconst linters = ['eslint', 'oxlint', 'biome'] as const;\nconst searchProviders = [\n 'orama',\n 'orama-cloud',\n 'algolia',\n 'meilisearch',\n 'typesense',\n 'mixedbread',\n] as const;\nconst ogImages = ['next-og', 'takumi'] as const;\nconst aiChats = ['openrouter', 'llmgateway', 'inkeep'] as const;\nconst templateNames = templates.map((item) => item.value);\n\ninterface CliOptions {\n src?: boolean;\n install?: boolean;\n git: boolean;\n yes?: boolean;\n linter?: (typeof linters)[number];\n search?: SearchProvider | 'orama';\n ogImage?: (typeof ogImages)[number];\n aiChat?: AIProvider;\n template?: Template;\n pm: PackageManager;\n}\n\nconst cli = cac('create-fumadocs-app');\n\ncli\n .command('[name]', 'create a Fumadocs app, [name] is the project name')\n .option('--src', '(Next.js only) enable `src/` directory')\n .option('--install', 'install packages automatically')\n .option('--no-git', 'disable auto Git repository initialization')\n .option('-y, --yes', 'skip prompts and use defaults for unspecified options')\n .option(\n '--linter <name>',\n `configure a linter/formatter, ESLint is currently Next.js only. (${linters.join(', ')})`,\n )\n .option('--search <name>', `configure a search solution (${searchProviders.join(', ')})`)\n .option('--og-image <name>', `configure OG image generation (${ogImages.join(', ')})`)\n .option('--ai-chat <name>', `configure AI chat (${aiChats.join(', ')})`)\n .option('--template <name>', `choose a template (${templateNames.join(', ')})`)\n .option('--pm <name>', `choose a package manager (${managers.join(', ')})`, {\n default: getPackageManager(),\n })\n .action(main);\n\nfunction checkOption(name: string, value: string | undefined, choices: readonly string[]) {\n if (value !== undefined && !choices.includes(value))\n throw new Error(`invalid value for --${name}: ${value}, expected: ${choices.join(', ')}`);\n}\n\nasync function main(defaultName: string | undefined, config: CliOptions): Promise<void> {\n checkOption('linter', config.linter, linters);\n checkOption('search', config.search, searchProviders);\n checkOption('og-image', config.ogImage, ogImages);\n checkOption('ai-chat', config.aiChat, aiChats);\n checkOption('template', config.template, templateNames);\n checkOption('pm', config.pm, managers);\n const skipPrompts = isCI || config.yes === true;\n intro(pc.bgCyan(pc.bold('Create Fumadocs App')));\n\n const options = await group(\n {\n name: async () => {\n if (defaultName) return defaultName;\n if (skipPrompts) return 'untitled';\n\n return text({\n message: 'Project name',\n placeholder: 'my-app',\n defaultValue: 'my-app',\n });\n },\n template: async () => {\n if (config.template) return config.template;\n if (skipPrompts) return '+next+fuma-docs-mdx';\n\n return select<Template>({\n message: 'Choose a template',\n initialValue: '+next+fuma-docs-mdx',\n options: templates,\n });\n },\n src: async ({ results }: { results: { template?: Template } }) => {\n if (config.src !== undefined) return config.src;\n if (skipPrompts || !results.template?.startsWith('+next')) return false;\n\n return confirm({\n message: 'Use `/src` directory?',\n initialValue: false,\n });\n },\n lint: async ({ results }: { results: { template?: Template } }) => {\n if (config.linter !== undefined) return config.linter;\n if (skipPrompts) return 'disabled';\n\n return select({\n message: 'Configure linter?',\n options: results.template?.startsWith('+next')\n ? [\n {\n value: 'disabled',\n label: 'Disabled',\n },\n {\n value: 'eslint',\n label: 'ESLint',\n },\n {\n value: 'biome',\n label: 'Biome',\n },\n {\n value: 'oxlint',\n label: 'Oxlint',\n },\n ]\n : [\n {\n value: 'disabled',\n label: 'Disabled',\n },\n {\n value: 'biome',\n label: 'Biome',\n },\n {\n value: 'oxlint',\n label: 'Oxlint',\n },\n ],\n });\n },\n search: async () => {\n if (config.search !== undefined) return config.search;\n if (skipPrompts) return 'orama';\n\n return select({\n message: 'Choose a search solution?',\n options: [\n {\n value: 'orama',\n label: 'Default',\n hint: 'local search powered by ZBSearch, recommended',\n },\n {\n value: 'orama-cloud',\n label: 'Orama Cloud',\n hint: '3rd party search solution, signup needed',\n },\n { value: 'algolia', label: 'Algolia', hint: 'signup needed' },\n { value: 'meilisearch', label: 'Meilisearch', hint: 'self-hosted or cloud' },\n { value: 'typesense', label: 'Typesense', hint: 'self-hosted or cloud' },\n { value: 'mixedbread', label: 'Mixedbread', hint: 'AI search, signup needed' },\n ],\n });\n },\n ogImage: async ({ results }: { results: { template?: Template } }) => {\n if (config.ogImage !== undefined) return config.ogImage;\n if (!results.template?.startsWith('+next')) return 'takumi';\n if (skipPrompts) return 'next/og';\n\n return select({\n message: 'Configure Open Graph Image generation?',\n options: [\n {\n value: 'next/og',\n label: 'next/og',\n hint: 'Next.js built-in solution',\n },\n {\n value: 'takumi',\n label: 'Takumi',\n hint: 'Output WebP format, framework-agnostic',\n },\n ],\n });\n },\n aiChat: async ({ results }: { results: { template?: Template } }) => {\n if (config.aiChat !== undefined) return config.aiChat;\n if (\n skipPrompts ||\n results.template === 'astro' ||\n results.template === '+next+fuma-docs-mdx+static' ||\n results.template!.endsWith('-spa')\n )\n return false;\n\n return select<false | 'openrouter' | 'llmgateway' | 'inkeep'>({\n message: 'Configure AI Chat?',\n options: [\n {\n value: false,\n label: 'No',\n },\n {\n value: 'openrouter',\n label: 'AI SDK',\n hint: 'default to OpenRouter',\n },\n {\n value: 'llmgateway',\n label: 'LLMGateway',\n hint: 'open-source LLM gateway, API key required',\n },\n {\n value: 'inkeep',\n label: 'Inkeep AI',\n hint: 'API key required',\n },\n ],\n });\n },\n installDeps: async () => {\n if (config.install !== undefined) return config.install;\n if (skipPrompts) return false;\n\n return confirm({\n message: `Do you want to install packages automatically? (detected as ${config.pm})`,\n });\n },\n },\n {\n onCancel: () => {\n cancel('Installation Stopped.');\n process.exit(0);\n },\n },\n );\n\n const projectName = options.name.toLowerCase().replace(/\\s/, '-');\n if (options.template === 'astro' && options.aiChat) {\n console.warn(pc.yellow('AI Chat is not supported by the Astro template yet, skipping it.'));\n options.aiChat = false;\n }\n\n if (!isCI) await checkDir(projectName, skipPrompts);\n\n const info = spinner();\n info.start(`Generating Project`);\n const plugins: TemplatePlugin[] = [];\n\n if (options.src) {\n const { nextUseSrc } = await import('./plugins/next-use-src');\n plugins.push(nextUseSrc());\n }\n\n if (options.search !== 'orama') plugins.push(feature(search, { provider: options.search }));\n if (options.lint !== 'disabled') plugins.push(feature(lint, { linter: options.lint }));\n if (options.ogImage === 'takumi' && options.template.startsWith('+next'))\n plugins.push(feature(og, { engine: 'takumi' }));\n if (options.aiChat) plugins.push(feature(ai, { provider: options.aiChat }));\n\n await create({\n packageManager: config.pm,\n template: options.template,\n outputDir: projectName,\n installDeps: options.installDeps,\n initializeGit: config.git,\n plugins,\n log: (message) => {\n info.message(message);\n },\n });\n\n info.stop('Project Generated');\n\n outro(pc.bgGreen(pc.bold('Done')));\n\n console.log(pc.bold('\\nOpen the project'));\n console.log(pc.cyan(`cd ${projectName}`));\n\n console.log(pc.bold('\\nRun Development Server'));\n if (config.pm === 'npm' || config.pm === 'bun') {\n console.log(pc.cyan(`${config.pm} run dev`));\n } else {\n console.log(pc.cyan(`${config.pm} dev`));\n }\n console.log(pc.bold('\\nYou can now open the project and start writing documents'));\n\n process.exit(0);\n}\n\nasync function checkDir(outputDir: string, skipPrompts: boolean) {\n const destDir = await fs.readdir(outputDir).catch(() => null);\n if (!destDir || destDir.length === 0) return;\n if (skipPrompts) {\n cancel(`directory ${outputDir} already exists and is not empty.`);\n process.exit(1);\n }\n const del = await confirm({\n message: `directory ${outputDir} already exists, do you want to delete its files?`,\n });\n\n if (isCancel(del)) {\n cancel();\n process.exit(1);\n }\n\n if (!del) return;\n\n const info = spinner();\n info.start(`Deleting files in ${outputDir}`);\n\n await Promise.all(\n destDir.map((item) => {\n return fs.rm(path.join(outputDir, item), {\n recursive: true,\n force: true,\n });\n }),\n );\n\n info.stop(`Deleted files in ${outputDir}`);\n}\n\ncli.help();\n\ntry {\n cli.parse(process.argv, { run: false });\n await cli.runMatchedCommand();\n} catch (e) {\n console.error(pc.red(e instanceof Error ? e.message : String(e)));\n process.exit(1);\n}\n"],"mappings":";;;;;;;;;;;;;;AAyBA,MAAM,UAAU;CAAC;CAAU;CAAU;AAAO;AAC5C,MAAM,kBAAkB;CACtB;CACA;CACA;CACA;CACA;CACA;AACF;AACA,MAAM,WAAW,CAAC,WAAW,QAAQ;AACrC,MAAM,UAAU;CAAC;CAAc;CAAc;AAAQ;AACrD,MAAM,gBAAgB,UAAU,KAAK,SAAS,KAAK,KAAK;AAexD,MAAM,MAAM,IAAI,qBAAqB;AAErC,IACG,QAAQ,UAAU,mDAAmD,CAAC,CACtE,OAAO,SAAS,wCAAwC,CAAC,CACzD,OAAO,aAAa,gCAAgC,CAAC,CACrD,OAAO,YAAY,4CAA4C,CAAC,CAChE,OAAO,aAAa,uDAAuD,CAAC,CAC5E,OACC,mBACA,oEAAoE,QAAQ,KAAK,IAAI,EAAE,EACzF,CAAC,CACA,OAAO,mBAAmB,gCAAgC,gBAAgB,KAAK,IAAI,EAAE,EAAE,CAAC,CACxF,OAAO,qBAAqB,kCAAkC,SAAS,KAAK,IAAI,EAAE,EAAE,CAAC,CACrF,OAAO,oBAAoB,sBAAsB,QAAQ,KAAK,IAAI,EAAE,EAAE,CAAC,CACvE,OAAO,qBAAqB,sBAAsB,cAAc,KAAK,IAAI,EAAE,EAAE,CAAC,CAC9E,OAAO,eAAe,6BAA6B,SAAS,KAAK,IAAI,EAAE,IAAI,EAC1E,SAAS,kBAAkB,EAC7B,CAAC,CAAC,CACD,OAAO,IAAI;AAEd,SAAS,YAAY,MAAc,OAA2B,SAA4B;CACxF,IAAI,UAAU,KAAA,KAAa,CAAC,QAAQ,SAAS,KAAK,GAChD,MAAM,IAAI,MAAM,uBAAuB,KAAK,IAAI,MAAM,cAAc,QAAQ,KAAK,IAAI,GAAG;AAC5F;AAEA,eAAe,KAAK,aAAiC,QAAmC;CACtF,YAAY,UAAU,OAAO,QAAQ,OAAO;CAC5C,YAAY,UAAU,OAAO,QAAQ,eAAe;CACpD,YAAY,YAAY,OAAO,SAAS,QAAQ;CAChD,YAAY,WAAW,OAAO,QAAQ,OAAO;CAC7C,YAAY,YAAY,OAAO,UAAU,aAAa;CACtD,YAAY,MAAM,OAAO,IAAI,QAAQ;CACrC,MAAM,cAAc,QAAQ,OAAO,QAAQ;CAC3C,MAAM,GAAG,OAAO,GAAG,KAAK,qBAAqB,CAAC,CAAC;CAE/C,MAAM,UAAU,MAAM,MACpB;EACE,MAAM,YAAY;GAChB,IAAI,aAAa,OAAO;GACxB,IAAI,aAAa,OAAO;GAExB,OAAO,KAAK;IACV,SAAS;IACT,aAAa;IACb,cAAc;GAChB,CAAC;EACH;EACA,UAAU,YAAY;GACpB,IAAI,OAAO,UAAU,OAAO,OAAO;GACnC,IAAI,aAAa,OAAO;GAExB,OAAO,OAAiB;IACtB,SAAS;IACT,cAAc;IACd,SAAS;GACX,CAAC;EACH;EACA,KAAK,OAAO,EAAE,cAAoD;GAChE,IAAI,OAAO,QAAQ,KAAA,GAAW,OAAO,OAAO;GAC5C,IAAI,eAAe,CAAC,QAAQ,UAAU,WAAW,OAAO,GAAG,OAAO;GAElE,OAAO,QAAQ;IACb,SAAS;IACT,cAAc;GAChB,CAAC;EACH;EACA,MAAM,OAAO,EAAE,cAAoD;GACjE,IAAI,OAAO,WAAW,KAAA,GAAW,OAAO,OAAO;GAC/C,IAAI,aAAa,OAAO;GAExB,OAAO,OAAO;IACZ,SAAS;IACT,SAAS,QAAQ,UAAU,WAAW,OAAO,IACzC;KACE;MACE,OAAO;MACP,OAAO;KACT;KACA;MACE,OAAO;MACP,OAAO;KACT;KACA;MACE,OAAO;MACP,OAAO;KACT;KACA;MACE,OAAO;MACP,OAAO;KACT;IACF,IACA;KACE;MACE,OAAO;MACP,OAAO;KACT;KACA;MACE,OAAO;MACP,OAAO;KACT;KACA;MACE,OAAO;MACP,OAAO;KACT;IACF;GACN,CAAC;EACH;EACA,QAAQ,YAAY;GAClB,IAAI,OAAO,WAAW,KAAA,GAAW,OAAO,OAAO;GAC/C,IAAI,aAAa,OAAO;GAExB,OAAO,OAAO;IACZ,SAAS;IACT,SAAS;KACP;MACE,OAAO;MACP,OAAO;MACP,MAAM;KACR;KACA;MACE,OAAO;MACP,OAAO;MACP,MAAM;KACR;KACA;MAAE,OAAO;MAAW,OAAO;MAAW,MAAM;KAAgB;KAC5D;MAAE,OAAO;MAAe,OAAO;MAAe,MAAM;KAAuB;KAC3E;MAAE,OAAO;MAAa,OAAO;MAAa,MAAM;KAAuB;KACvE;MAAE,OAAO;MAAc,OAAO;MAAc,MAAM;KAA2B;IAC/E;GACF,CAAC;EACH;EACA,SAAS,OAAO,EAAE,cAAoD;GACpE,IAAI,OAAO,YAAY,KAAA,GAAW,OAAO,OAAO;GAChD,IAAI,CAAC,QAAQ,UAAU,WAAW,OAAO,GAAG,OAAO;GACnD,IAAI,aAAa,OAAO;GAExB,OAAO,OAAO;IACZ,SAAS;IACT,SAAS,CACP;KACE,OAAO;KACP,OAAO;KACP,MAAM;IACR,GACA;KACE,OAAO;KACP,OAAO;KACP,MAAM;IACR,CACF;GACF,CAAC;EACH;EACA,QAAQ,OAAO,EAAE,cAAoD;GACnE,IAAI,OAAO,WAAW,KAAA,GAAW,OAAO,OAAO;GAC/C,IACE,eACA,QAAQ,aAAa,WACrB,QAAQ,aAAa,gCACrB,QAAQ,SAAU,SAAS,MAAM,GAEjC,OAAO;GAET,OAAO,OAAuD;IAC5D,SAAS;IACT,SAAS;KACP;MACE,OAAO;MACP,OAAO;KACT;KACA;MACE,OAAO;MACP,OAAO;MACP,MAAM;KACR;KACA;MACE,OAAO;MACP,OAAO;MACP,MAAM;KACR;KACA;MACE,OAAO;MACP,OAAO;MACP,MAAM;KACR;IACF;GACF,CAAC;EACH;EACA,aAAa,YAAY;GACvB,IAAI,OAAO,YAAY,KAAA,GAAW,OAAO,OAAO;GAChD,IAAI,aAAa,OAAO;GAExB,OAAO,QAAQ,EACb,SAAS,+DAA+D,OAAO,GAAG,GACpF,CAAC;EACH;CACF,GACA,EACE,gBAAgB;EACd,OAAO,uBAAuB;EAC9B,QAAQ,KAAK,CAAC;CAChB,EACF,CACF;CAEA,MAAM,cAAc,QAAQ,KAAK,YAAY,CAAC,CAAC,QAAQ,MAAM,GAAG;CAChE,IAAI,QAAQ,aAAa,WAAW,QAAQ,QAAQ;EAClD,QAAQ,KAAK,GAAG,OAAO,kEAAkE,CAAC;EAC1F,QAAQ,SAAS;CACnB;CAEA,IAAI,CAAC,MAAM,MAAM,SAAS,aAAa,WAAW;CAElD,MAAM,OAAO,QAAQ;CACrB,KAAK,MAAM,oBAAoB;CAC/B,MAAM,UAA4B,CAAC;CAEnC,IAAI,QAAQ,KAAK;EACf,MAAM,EAAE,eAAe,MAAM,OAAO;EACpC,QAAQ,KAAK,WAAW,CAAC;CAC3B;CAEA,IAAI,QAAQ,WAAW,SAAS,QAAQ,KAAK,QAAQ,QAAQ,EAAE,UAAU,QAAQ,OAAO,CAAC,CAAC;CAC1F,IAAI,QAAQ,SAAS,YAAY,QAAQ,KAAK,QAAQ,MAAM,EAAE,QAAQ,QAAQ,KAAK,CAAC,CAAC;CACrF,IAAI,QAAQ,YAAY,YAAY,QAAQ,SAAS,WAAW,OAAO,GACrE,QAAQ,KAAK,QAAQ,IAAI,EAAE,QAAQ,SAAS,CAAC,CAAC;CAChD,IAAI,QAAQ,QAAQ,QAAQ,KAAK,QAAQ,IAAI,EAAE,UAAU,QAAQ,OAAO,CAAC,CAAC;CAE1E,MAAM,OAAO;EACX,gBAAgB,OAAO;EACvB,UAAU,QAAQ;EAClB,WAAW;EACX,aAAa,QAAQ;EACrB,eAAe,OAAO;EACtB;EACA,MAAM,YAAY;GAChB,KAAK,QAAQ,OAAO;EACtB;CACF,CAAC;CAED,KAAK,KAAK,mBAAmB;CAE7B,MAAM,GAAG,QAAQ,GAAG,KAAK,MAAM,CAAC,CAAC;CAEjC,QAAQ,IAAI,GAAG,KAAK,oBAAoB,CAAC;CACzC,QAAQ,IAAI,GAAG,KAAK,MAAM,aAAa,CAAC;CAExC,QAAQ,IAAI,GAAG,KAAK,0BAA0B,CAAC;CAC/C,IAAI,OAAO,OAAO,SAAS,OAAO,OAAO,OACvC,QAAQ,IAAI,GAAG,KAAK,GAAG,OAAO,GAAG,SAAS,CAAC;MAE3C,QAAQ,IAAI,GAAG,KAAK,GAAG,OAAO,GAAG,KAAK,CAAC;CAEzC,QAAQ,IAAI,GAAG,KAAK,4DAA4D,CAAC;CAEjF,QAAQ,KAAK,CAAC;AAChB;AAEA,eAAe,SAAS,WAAmB,aAAsB;CAC/D,MAAM,UAAU,MAAM,GAAG,QAAQ,SAAS,CAAC,CAAC,YAAY,IAAI;CAC5D,IAAI,CAAC,WAAW,QAAQ,WAAW,GAAG;CACtC,IAAI,aAAa;EACf,OAAO,aAAa,UAAU,kCAAkC;EAChE,QAAQ,KAAK,CAAC;CAChB;CACA,MAAM,MAAM,MAAM,QAAQ,EACxB,SAAS,aAAa,UAAU,mDAClC,CAAC;CAED,IAAI,SAAS,GAAG,GAAG;EACjB,OAAO;EACP,QAAQ,KAAK,CAAC;CAChB;CAEA,IAAI,CAAC,KAAK;CAEV,MAAM,OAAO,QAAQ;CACrB,KAAK,MAAM,qBAAqB,WAAW;CAE3C,MAAM,QAAQ,IACZ,QAAQ,KAAK,SAAS;EACpB,OAAO,GAAG,GAAG,KAAK,KAAK,WAAW,IAAI,GAAG;GACvC,WAAW;GACX,OAAO;EACT,CAAC;CACH,CAAC,CACH;CAEA,KAAK,KAAK,oBAAoB,WAAW;AAC3C;AAEA,IAAI,KAAK;AAET,IAAI;CACF,IAAI,MAAM,QAAQ,MAAM,EAAE,KAAK,MAAM,CAAC;CACtC,MAAM,IAAI,kBAAkB;AAC9B,SAAS,GAAG;CACV,QAAQ,MAAM,GAAG,IAAI,aAAa,QAAQ,EAAE,UAAU,OAAO,CAAC,CAAC,CAAC;CAChE,QAAQ,KAAK,CAAC;AAChB"}
|
|
1
|
+
{"version":3,"file":"bin.js","names":[],"sources":["../src/bin.ts"],"sourcesContent":["#!/usr/bin/env node\nimport fs from 'node:fs/promises';\nimport path from 'node:path';\nimport {\n cancel,\n confirm,\n group,\n intro,\n isCancel,\n outro,\n select,\n spinner,\n text,\n} from '@clack/prompts';\nimport pc from 'picocolors';\nimport { getPackageManager, managers, type PackageManager } from './auto-install';\nimport { create, type Template, type TemplatePlugin } from './index';\nimport { isCI, templates } from './constants';\nimport { cac } from 'cac';\nimport { feature } from './plugins/feature';\nimport { ai, type AIProvider } from '@fumadocs/cli/features/ai';\nimport { lint } from '@fumadocs/cli/features/lint';\nimport { og } from '@fumadocs/cli/features/og';\nimport { search, type SearchProvider } from '@fumadocs/cli/features/search';\n\nconst linters = ['eslint', 'oxlint', 'biome'] as const;\nconst searchProviders = [\n 'orama',\n 'orama-cloud',\n 'algolia',\n 'meilisearch',\n 'typesense',\n 'mixedbread',\n] as const;\nconst ogImages = ['next-og', 'takumi'] as const;\nconst aiChats = ['openrouter', 'llmgateway', 'inkeep'] as const;\nconst templateNames = templates.map((item) => item.value);\n\ninterface CliOptions {\n src?: boolean;\n install?: boolean;\n git: boolean;\n yes?: boolean;\n linter?: (typeof linters)[number];\n search?: SearchProvider | 'orama';\n ogImage?: (typeof ogImages)[number];\n aiChat?: AIProvider;\n template?: Template;\n pm: PackageManager;\n}\n\nconst cli = cac('create-fumadocs-app');\n\ncli\n .command('[name]', 'create a Fumadocs app, [name] is the project name')\n .option('--src', '(Next.js only) enable `src/` directory')\n .option('--install', 'install packages automatically')\n .option('--no-git', 'disable auto Git repository initialization')\n .option('-y, --yes', 'skip prompts and use defaults for unspecified options')\n .option(\n '--linter <name>',\n `configure a linter/formatter, ESLint is currently Next.js only. (${linters.join(', ')})`,\n )\n .option('--search <name>', `configure a search solution (${searchProviders.join(', ')})`)\n .option('--og-image <name>', `configure OG image generation (${ogImages.join(', ')})`)\n .option('--ai-chat <name>', `configure AI chat (${aiChats.join(', ')})`)\n .option('--template <name>', `choose a template (${templateNames.join(', ')})`)\n .option('--pm <name>', `choose a package manager (${managers.join(', ')})`, {\n default: getPackageManager(),\n })\n .action(main);\n\nfunction checkOption(name: string, value: string | undefined, choices: readonly string[]) {\n if (value !== undefined && !choices.includes(value))\n throw new Error(`invalid value for --${name}: ${value}, expected: ${choices.join(', ')}`);\n}\n\nasync function main(defaultName: string | undefined, config: CliOptions): Promise<void> {\n checkOption('linter', config.linter, linters);\n checkOption('search', config.search, searchProviders);\n checkOption('og-image', config.ogImage, ogImages);\n checkOption('ai-chat', config.aiChat, aiChats);\n checkOption('template', config.template, templateNames);\n checkOption('pm', config.pm, managers);\n const skipPrompts = isCI || config.yes === true;\n intro(pc.bgCyan(pc.bold('Create Fumadocs App')));\n\n const options = await group(\n {\n name: async () => {\n if (defaultName) return defaultName;\n if (skipPrompts) return 'untitled';\n\n return text({\n message: 'Project name',\n placeholder: 'my-app',\n defaultValue: 'my-app',\n });\n },\n template: async () => {\n if (config.template) return config.template;\n if (skipPrompts) return '+next+fuma-docs-mdx';\n\n return select<Template>({\n message: 'Choose a template',\n initialValue: '+next+fuma-docs-mdx',\n options: templates,\n });\n },\n src: async ({ results }: { results: { template?: Template } }) => {\n if (config.src !== undefined) return config.src;\n if (skipPrompts || !results.template?.startsWith('+next')) return false;\n\n return confirm({\n message: 'Use `/src` directory?',\n initialValue: false,\n });\n },\n lint: async ({ results }: { results: { template?: Template } }) => {\n if (config.linter !== undefined) return config.linter;\n if (skipPrompts) return 'disabled';\n\n return select({\n message: 'Configure linter?',\n options: results.template?.startsWith('+next')\n ? [\n {\n value: 'disabled',\n label: 'Disabled',\n },\n {\n value: 'eslint',\n label: 'ESLint',\n },\n {\n value: 'biome',\n label: 'Biome',\n },\n {\n value: 'oxlint',\n label: 'Oxlint',\n },\n ]\n : [\n {\n value: 'disabled',\n label: 'Disabled',\n },\n {\n value: 'biome',\n label: 'Biome',\n },\n {\n value: 'oxlint',\n label: 'Oxlint',\n },\n ],\n });\n },\n search: async () => {\n if (config.search !== undefined) return config.search;\n if (skipPrompts) return 'orama';\n\n return select({\n message: 'Choose a search solution?',\n options: [\n {\n value: 'orama',\n label: 'Default',\n hint: 'local search powered by ZBSearch, recommended',\n },\n {\n value: 'orama-cloud',\n label: 'Orama Cloud',\n hint: '3rd party search solution, signup needed',\n },\n { value: 'algolia', label: 'Algolia', hint: 'signup needed' },\n { value: 'meilisearch', label: 'Meilisearch', hint: 'self-hosted or cloud' },\n { value: 'typesense', label: 'Typesense', hint: 'self-hosted or cloud' },\n { value: 'mixedbread', label: 'Mixedbread', hint: 'AI search, signup needed' },\n ],\n });\n },\n ogImage: async ({ results }: { results: { template?: Template } }) => {\n if (config.ogImage !== undefined) return config.ogImage;\n if (!results.template?.startsWith('+next')) return 'takumi';\n if (skipPrompts) return 'next/og';\n\n return select({\n message: 'Configure Open Graph Image generation?',\n options: [\n {\n value: 'next/og',\n label: 'next/og',\n hint: 'Next.js built-in solution',\n },\n {\n value: 'takumi',\n label: 'Takumi',\n hint: 'Output WebP format, framework-agnostic',\n },\n ],\n });\n },\n aiChat: async ({ results }: { results: { template?: Template } }) => {\n if (config.aiChat !== undefined) return config.aiChat;\n if (\n skipPrompts ||\n results.template === 'astro' ||\n results.template === '+next+fuma-docs-mdx+static' ||\n results.template!.endsWith('-spa')\n )\n return false;\n\n return select<false | 'openrouter' | 'llmgateway' | 'inkeep'>({\n message: 'Configure AI Chat?',\n options: [\n {\n value: false,\n label: 'No',\n },\n {\n value: 'openrouter',\n label: 'AI SDK',\n hint: 'default to OpenRouter',\n },\n {\n value: 'llmgateway',\n label: 'LLMGateway',\n hint: 'open-source LLM gateway, API key required',\n },\n {\n value: 'inkeep',\n label: 'Inkeep AI',\n hint: 'API key required',\n },\n ],\n });\n },\n installDeps: async () => {\n if (config.install !== undefined) return config.install;\n if (skipPrompts) return false;\n\n return confirm({\n message: `Do you want to install packages automatically? (detected as ${config.pm})`,\n });\n },\n },\n {\n onCancel: () => {\n cancel('Installation Stopped.');\n process.exit(0);\n },\n },\n );\n\n const projectName = options.name.toLowerCase().replace(/\\s/, '-');\n if (options.template === 'astro' && options.aiChat) {\n console.warn(pc.yellow('AI Chat is not supported by the Astro template yet, skipping it.'));\n options.aiChat = false;\n }\n if (options.ogImage === 'next-og' && !options.template.startsWith('+next')) {\n console.warn(\n pc.yellow('next/og is only available on Next.js, the template uses Takumi instead.'),\n );\n }\n\n if (!isCI) await checkDir(projectName, skipPrompts);\n\n const info = spinner();\n info.start(`Generating Project`);\n const plugins: TemplatePlugin[] = [];\n\n if (options.src) {\n const { nextUseSrc } = await import('./plugins/next-use-src');\n plugins.push(nextUseSrc());\n }\n\n if (options.search !== 'orama') plugins.push(feature(search, { provider: options.search }));\n if (options.lint !== 'disabled') plugins.push(feature(lint, { linter: options.lint }));\n if (options.ogImage === 'takumi' && options.template.startsWith('+next'))\n plugins.push(feature(og, { engine: 'takumi' }));\n if (options.aiChat) plugins.push(feature(ai, { provider: options.aiChat }));\n\n await create({\n packageManager: config.pm,\n template: options.template,\n outputDir: projectName,\n installDeps: options.installDeps,\n initializeGit: config.git,\n plugins,\n log: (message) => {\n info.message(message);\n },\n });\n\n info.stop('Project Generated');\n\n outro(pc.bgGreen(pc.bold('Done')));\n\n console.log(pc.bold('\\nOpen the project'));\n console.log(pc.cyan(`cd ${projectName}`));\n\n console.log(pc.bold('\\nRun Development Server'));\n if (config.pm === 'npm' || config.pm === 'bun') {\n console.log(pc.cyan(`${config.pm} run dev`));\n } else {\n console.log(pc.cyan(`${config.pm} dev`));\n }\n console.log(pc.bold('\\nYou can now open the project and start writing documents'));\n\n process.exit(0);\n}\n\nasync function checkDir(outputDir: string, skipPrompts: boolean) {\n const destDir = await fs.readdir(outputDir).catch(() => null);\n if (!destDir || destDir.length === 0) return;\n if (skipPrompts) {\n cancel(`directory ${outputDir} already exists and is not empty.`);\n process.exit(1);\n }\n const del = await confirm({\n message: `directory ${outputDir} already exists, do you want to delete its files?`,\n });\n\n if (isCancel(del)) {\n cancel();\n process.exit(1);\n }\n\n if (!del) return;\n\n const info = spinner();\n info.start(`Deleting files in ${outputDir}`);\n\n await Promise.all(\n destDir.map((item) => {\n return fs.rm(path.join(outputDir, item), {\n recursive: true,\n force: true,\n });\n }),\n );\n\n info.stop(`Deleted files in ${outputDir}`);\n}\n\ncli.help();\n\ntry {\n cli.parse(process.argv, { run: false });\n await cli.runMatchedCommand();\n} catch (e) {\n console.error(pc.red(e instanceof Error ? e.message : String(e)));\n process.exit(1);\n}\n"],"mappings":";;;;;;;;;;;;;;AAyBA,MAAM,UAAU;CAAC;CAAU;CAAU;AAAO;AAC5C,MAAM,kBAAkB;CACtB;CACA;CACA;CACA;CACA;CACA;AACF;AACA,MAAM,WAAW,CAAC,WAAW,QAAQ;AACrC,MAAM,UAAU;CAAC;CAAc;CAAc;AAAQ;AACrD,MAAM,gBAAgB,UAAU,KAAK,SAAS,KAAK,KAAK;AAexD,MAAM,MAAM,IAAI,qBAAqB;AAErC,IACG,QAAQ,UAAU,mDAAmD,CAAC,CACtE,OAAO,SAAS,wCAAwC,CAAC,CACzD,OAAO,aAAa,gCAAgC,CAAC,CACrD,OAAO,YAAY,4CAA4C,CAAC,CAChE,OAAO,aAAa,uDAAuD,CAAC,CAC5E,OACC,mBACA,oEAAoE,QAAQ,KAAK,IAAI,EAAE,EACzF,CAAC,CACA,OAAO,mBAAmB,gCAAgC,gBAAgB,KAAK,IAAI,EAAE,EAAE,CAAC,CACxF,OAAO,qBAAqB,kCAAkC,SAAS,KAAK,IAAI,EAAE,EAAE,CAAC,CACrF,OAAO,oBAAoB,sBAAsB,QAAQ,KAAK,IAAI,EAAE,EAAE,CAAC,CACvE,OAAO,qBAAqB,sBAAsB,cAAc,KAAK,IAAI,EAAE,EAAE,CAAC,CAC9E,OAAO,eAAe,6BAA6B,SAAS,KAAK,IAAI,EAAE,IAAI,EAC1E,SAAS,kBAAkB,EAC7B,CAAC,CAAC,CACD,OAAO,IAAI;AAEd,SAAS,YAAY,MAAc,OAA2B,SAA4B;CACxF,IAAI,UAAU,KAAA,KAAa,CAAC,QAAQ,SAAS,KAAK,GAChD,MAAM,IAAI,MAAM,uBAAuB,KAAK,IAAI,MAAM,cAAc,QAAQ,KAAK,IAAI,GAAG;AAC5F;AAEA,eAAe,KAAK,aAAiC,QAAmC;CACtF,YAAY,UAAU,OAAO,QAAQ,OAAO;CAC5C,YAAY,UAAU,OAAO,QAAQ,eAAe;CACpD,YAAY,YAAY,OAAO,SAAS,QAAQ;CAChD,YAAY,WAAW,OAAO,QAAQ,OAAO;CAC7C,YAAY,YAAY,OAAO,UAAU,aAAa;CACtD,YAAY,MAAM,OAAO,IAAI,QAAQ;CACrC,MAAM,cAAc,QAAQ,OAAO,QAAQ;CAC3C,MAAM,GAAG,OAAO,GAAG,KAAK,qBAAqB,CAAC,CAAC;CAE/C,MAAM,UAAU,MAAM,MACpB;EACE,MAAM,YAAY;GAChB,IAAI,aAAa,OAAO;GACxB,IAAI,aAAa,OAAO;GAExB,OAAO,KAAK;IACV,SAAS;IACT,aAAa;IACb,cAAc;GAChB,CAAC;EACH;EACA,UAAU,YAAY;GACpB,IAAI,OAAO,UAAU,OAAO,OAAO;GACnC,IAAI,aAAa,OAAO;GAExB,OAAO,OAAiB;IACtB,SAAS;IACT,cAAc;IACd,SAAS;GACX,CAAC;EACH;EACA,KAAK,OAAO,EAAE,cAAoD;GAChE,IAAI,OAAO,QAAQ,KAAA,GAAW,OAAO,OAAO;GAC5C,IAAI,eAAe,CAAC,QAAQ,UAAU,WAAW,OAAO,GAAG,OAAO;GAElE,OAAO,QAAQ;IACb,SAAS;IACT,cAAc;GAChB,CAAC;EACH;EACA,MAAM,OAAO,EAAE,cAAoD;GACjE,IAAI,OAAO,WAAW,KAAA,GAAW,OAAO,OAAO;GAC/C,IAAI,aAAa,OAAO;GAExB,OAAO,OAAO;IACZ,SAAS;IACT,SAAS,QAAQ,UAAU,WAAW,OAAO,IACzC;KACE;MACE,OAAO;MACP,OAAO;KACT;KACA;MACE,OAAO;MACP,OAAO;KACT;KACA;MACE,OAAO;MACP,OAAO;KACT;KACA;MACE,OAAO;MACP,OAAO;KACT;IACF,IACA;KACE;MACE,OAAO;MACP,OAAO;KACT;KACA;MACE,OAAO;MACP,OAAO;KACT;KACA;MACE,OAAO;MACP,OAAO;KACT;IACF;GACN,CAAC;EACH;EACA,QAAQ,YAAY;GAClB,IAAI,OAAO,WAAW,KAAA,GAAW,OAAO,OAAO;GAC/C,IAAI,aAAa,OAAO;GAExB,OAAO,OAAO;IACZ,SAAS;IACT,SAAS;KACP;MACE,OAAO;MACP,OAAO;MACP,MAAM;KACR;KACA;MACE,OAAO;MACP,OAAO;MACP,MAAM;KACR;KACA;MAAE,OAAO;MAAW,OAAO;MAAW,MAAM;KAAgB;KAC5D;MAAE,OAAO;MAAe,OAAO;MAAe,MAAM;KAAuB;KAC3E;MAAE,OAAO;MAAa,OAAO;MAAa,MAAM;KAAuB;KACvE;MAAE,OAAO;MAAc,OAAO;MAAc,MAAM;KAA2B;IAC/E;GACF,CAAC;EACH;EACA,SAAS,OAAO,EAAE,cAAoD;GACpE,IAAI,OAAO,YAAY,KAAA,GAAW,OAAO,OAAO;GAChD,IAAI,CAAC,QAAQ,UAAU,WAAW,OAAO,GAAG,OAAO;GACnD,IAAI,aAAa,OAAO;GAExB,OAAO,OAAO;IACZ,SAAS;IACT,SAAS,CACP;KACE,OAAO;KACP,OAAO;KACP,MAAM;IACR,GACA;KACE,OAAO;KACP,OAAO;KACP,MAAM;IACR,CACF;GACF,CAAC;EACH;EACA,QAAQ,OAAO,EAAE,cAAoD;GACnE,IAAI,OAAO,WAAW,KAAA,GAAW,OAAO,OAAO;GAC/C,IACE,eACA,QAAQ,aAAa,WACrB,QAAQ,aAAa,gCACrB,QAAQ,SAAU,SAAS,MAAM,GAEjC,OAAO;GAET,OAAO,OAAuD;IAC5D,SAAS;IACT,SAAS;KACP;MACE,OAAO;MACP,OAAO;KACT;KACA;MACE,OAAO;MACP,OAAO;MACP,MAAM;KACR;KACA;MACE,OAAO;MACP,OAAO;MACP,MAAM;KACR;KACA;MACE,OAAO;MACP,OAAO;MACP,MAAM;KACR;IACF;GACF,CAAC;EACH;EACA,aAAa,YAAY;GACvB,IAAI,OAAO,YAAY,KAAA,GAAW,OAAO,OAAO;GAChD,IAAI,aAAa,OAAO;GAExB,OAAO,QAAQ,EACb,SAAS,+DAA+D,OAAO,GAAG,GACpF,CAAC;EACH;CACF,GACA,EACE,gBAAgB;EACd,OAAO,uBAAuB;EAC9B,QAAQ,KAAK,CAAC;CAChB,EACF,CACF;CAEA,MAAM,cAAc,QAAQ,KAAK,YAAY,CAAC,CAAC,QAAQ,MAAM,GAAG;CAChE,IAAI,QAAQ,aAAa,WAAW,QAAQ,QAAQ;EAClD,QAAQ,KAAK,GAAG,OAAO,kEAAkE,CAAC;EAC1F,QAAQ,SAAS;CACnB;CACA,IAAI,QAAQ,YAAY,aAAa,CAAC,QAAQ,SAAS,WAAW,OAAO,GACvE,QAAQ,KACN,GAAG,OAAO,yEAAyE,CACrF;CAGF,IAAI,CAAC,MAAM,MAAM,SAAS,aAAa,WAAW;CAElD,MAAM,OAAO,QAAQ;CACrB,KAAK,MAAM,oBAAoB;CAC/B,MAAM,UAA4B,CAAC;CAEnC,IAAI,QAAQ,KAAK;EACf,MAAM,EAAE,eAAe,MAAM,OAAO;EACpC,QAAQ,KAAK,WAAW,CAAC;CAC3B;CAEA,IAAI,QAAQ,WAAW,SAAS,QAAQ,KAAK,QAAQ,QAAQ,EAAE,UAAU,QAAQ,OAAO,CAAC,CAAC;CAC1F,IAAI,QAAQ,SAAS,YAAY,QAAQ,KAAK,QAAQ,MAAM,EAAE,QAAQ,QAAQ,KAAK,CAAC,CAAC;CACrF,IAAI,QAAQ,YAAY,YAAY,QAAQ,SAAS,WAAW,OAAO,GACrE,QAAQ,KAAK,QAAQ,IAAI,EAAE,QAAQ,SAAS,CAAC,CAAC;CAChD,IAAI,QAAQ,QAAQ,QAAQ,KAAK,QAAQ,IAAI,EAAE,UAAU,QAAQ,OAAO,CAAC,CAAC;CAE1E,MAAM,OAAO;EACX,gBAAgB,OAAO;EACvB,UAAU,QAAQ;EAClB,WAAW;EACX,aAAa,QAAQ;EACrB,eAAe,OAAO;EACtB;EACA,MAAM,YAAY;GAChB,KAAK,QAAQ,OAAO;EACtB;CACF,CAAC;CAED,KAAK,KAAK,mBAAmB;CAE7B,MAAM,GAAG,QAAQ,GAAG,KAAK,MAAM,CAAC,CAAC;CAEjC,QAAQ,IAAI,GAAG,KAAK,oBAAoB,CAAC;CACzC,QAAQ,IAAI,GAAG,KAAK,MAAM,aAAa,CAAC;CAExC,QAAQ,IAAI,GAAG,KAAK,0BAA0B,CAAC;CAC/C,IAAI,OAAO,OAAO,SAAS,OAAO,OAAO,OACvC,QAAQ,IAAI,GAAG,KAAK,GAAG,OAAO,GAAG,SAAS,CAAC;MAE3C,QAAQ,IAAI,GAAG,KAAK,GAAG,OAAO,GAAG,KAAK,CAAC;CAEzC,QAAQ,IAAI,GAAG,KAAK,4DAA4D,CAAC;CAEjF,QAAQ,KAAK,CAAC;AAChB;AAEA,eAAe,SAAS,WAAmB,aAAsB;CAC/D,MAAM,UAAU,MAAM,GAAG,QAAQ,SAAS,CAAC,CAAC,YAAY,IAAI;CAC5D,IAAI,CAAC,WAAW,QAAQ,WAAW,GAAG;CACtC,IAAI,aAAa;EACf,OAAO,aAAa,UAAU,kCAAkC;EAChE,QAAQ,KAAK,CAAC;CAChB;CACA,MAAM,MAAM,MAAM,QAAQ,EACxB,SAAS,aAAa,UAAU,mDAClC,CAAC;CAED,IAAI,SAAS,GAAG,GAAG;EACjB,OAAO;EACP,QAAQ,KAAK,CAAC;CAChB;CAEA,IAAI,CAAC,KAAK;CAEV,MAAM,OAAO,QAAQ;CACrB,KAAK,MAAM,qBAAqB,WAAW;CAE3C,MAAM,QAAQ,IACZ,QAAQ,KAAK,SAAS;EACpB,OAAO,GAAG,GAAG,KAAK,KAAK,WAAW,IAAI,GAAG;GACvC,WAAW;GACX,OAAO;EACT,CAAC;CACH,CAAC,CACH;CAEA,KAAK,KAAK,oBAAoB,WAAW;AAC3C;AAEA,IAAI,KAAK;AAET,IAAI;CACF,IAAI,MAAM,QAAQ,MAAM,EAAE,KAAK,MAAM,CAAC;CACtC,MAAM,IAAI,kBAAkB;AAC9B,SAAS,GAAG;CACV,QAAQ,MAAM,GAAG,IAAI,aAAa,QAAQ,EAAE,UAAU,OAAO,CAAC,CAAC,CAAC;CAChE,QAAQ,KAAK,CAAC;AAChB"}
|
|
@@ -53,7 +53,7 @@ var package_exports$2 = /* @__PURE__ */ __exportAll({
|
|
|
53
53
|
version: () => version$2
|
|
54
54
|
});
|
|
55
55
|
var name$2 = "fumadocs-core";
|
|
56
|
-
var version$2 = "16.
|
|
56
|
+
var version$2 = "16.17.1";
|
|
57
57
|
var description$2 = "The React.js library for building a documentation website";
|
|
58
58
|
var keywords$2 = ["Docs", "Fumadocs"];
|
|
59
59
|
var homepage$2 = "https://fumadocs.dev";
|
|
@@ -163,10 +163,12 @@ var dependencies$2 = {
|
|
|
163
163
|
"@fumari/image-size": "workspace:^",
|
|
164
164
|
"estree-util-value-to-estree": "^3.5.0",
|
|
165
165
|
"github-slugger": "^2.0.0",
|
|
166
|
+
"hast-util-from-dom": "^5.0.1",
|
|
166
167
|
"hast-util-to-estree": "^3.1.3",
|
|
167
168
|
"hast-util-to-jsx-runtime": "^2.3.6",
|
|
168
169
|
"mdast-util-mdx": "^3.0.0",
|
|
169
|
-
"
|
|
170
|
+
"micromark": "^4.0.2",
|
|
171
|
+
"micromark-extension-gfm-table": "^2.1.2",
|
|
170
172
|
"npm-to-yarn": "3.2.0",
|
|
171
173
|
"remark": "^15.0.1",
|
|
172
174
|
"remark-gfm": "^4.0.1",
|
|
@@ -175,7 +177,6 @@ var dependencies$2 = {
|
|
|
175
177
|
"shiki": "^4.5.0",
|
|
176
178
|
"tinyglobby": "^0.2.17",
|
|
177
179
|
"unified": "^11.0.5",
|
|
178
|
-
"unist-util-visit": "^5.1.0",
|
|
179
180
|
"vfile": "^6.0.3",
|
|
180
181
|
"yaml": "^2.9.1",
|
|
181
182
|
"zbsearch": "^4.0.1"
|
|
@@ -309,7 +310,7 @@ var package_exports$1 = /* @__PURE__ */ __exportAll({
|
|
|
309
310
|
version: () => version$1
|
|
310
311
|
});
|
|
311
312
|
var name$1 = "fumadocs-mdx";
|
|
312
|
-
var version$1 = "15.4.
|
|
313
|
+
var version$1 = "15.4.7";
|
|
313
314
|
var description$1 = "The built-in source for Fumadocs";
|
|
314
315
|
var keywords$1 = ["Docs", "fumadocs"];
|
|
315
316
|
var homepage$1 = "https://fumadocs.dev";
|
|
@@ -369,7 +370,6 @@ var dependencies$1 = {
|
|
|
369
370
|
"tinyglobby": "^0.2.17",
|
|
370
371
|
"unified": "^11.0.5",
|
|
371
372
|
"unist-util-remove-position": "^5.0.0",
|
|
372
|
-
"unist-util-visit": "^5.1.0",
|
|
373
373
|
"vfile": "^6.0.3",
|
|
374
374
|
"yaml": "^2.9.1",
|
|
375
375
|
"yuku-analyzer": "^0.17.0",
|
|
@@ -403,7 +403,7 @@ var peerDependencies$1 = {
|
|
|
403
403
|
"@types/mdast": "*",
|
|
404
404
|
"@types/mdx": "*",
|
|
405
405
|
"@types/react": "*",
|
|
406
|
-
"fumadocs-core": "^16.
|
|
406
|
+
"fumadocs-core": "^16.17.0",
|
|
407
407
|
"mdast-util-directive": "*",
|
|
408
408
|
"next": "^15.3.0 || ^16.0.0",
|
|
409
409
|
"react": "^19.2.0",
|
|
@@ -470,7 +470,7 @@ var package_exports = /* @__PURE__ */ __exportAll({
|
|
|
470
470
|
version: () => version
|
|
471
471
|
});
|
|
472
472
|
var name = "@fumadocs/base-ui";
|
|
473
|
-
var version = "16.
|
|
473
|
+
var version = "16.17.1";
|
|
474
474
|
var description = "The Base UI version of Fumadocs UI";
|
|
475
475
|
var keywords = ["Docs", "Fumadocs"];
|
|
476
476
|
var homepage = "https://fumadocs.dev";
|
|
@@ -606,21 +606,19 @@ var dependencies = {
|
|
|
606
606
|
"@fumadocs/tailwind": "workspace:*",
|
|
607
607
|
"class-variance-authority": "^0.7.1",
|
|
608
608
|
"cn": "^0.4.0",
|
|
609
|
+
"hast-util-to-jsx-runtime": "^2.3.6",
|
|
609
610
|
"lucide-react": "^1.50.0",
|
|
610
611
|
"motion": "^14.0.0",
|
|
611
612
|
"next-themes": "^0.4.6",
|
|
612
613
|
"react-remove-scroll": "^2.7.2",
|
|
613
|
-
"rehype-raw": "^7.0.0",
|
|
614
614
|
"scroll-into-view-if-needed": "^3.1.0",
|
|
615
|
-
"shiki": "^4.5.0"
|
|
616
|
-
"unist-util-visit": "^5.1.0"
|
|
615
|
+
"shiki": "^4.5.0"
|
|
617
616
|
};
|
|
618
617
|
var devDependencies = {
|
|
619
618
|
"@fumadocs/cli": "workspace:*",
|
|
620
619
|
"@tailwindcss/cli": "^4.3.3",
|
|
621
620
|
"@tailwindcss/oxide": "^4.3.3",
|
|
622
621
|
"@tsdown/css": "^0.23.0",
|
|
623
|
-
"@types/hast": "^3.0.5",
|
|
624
622
|
"@types/mdx": "^2.0.14",
|
|
625
623
|
"@types/node": "^26.6.4",
|
|
626
624
|
"@types/react": "^19.3.0",
|
|
@@ -630,8 +628,7 @@ var devDependencies = {
|
|
|
630
628
|
"react-medium-image-zoom": "^5.4.9",
|
|
631
629
|
"tailwindcss": "^4.3.3",
|
|
632
630
|
"tsconfig": "workspace:*",
|
|
633
|
-
"tsdown": "0.23.0"
|
|
634
|
-
"unified": "^11.0.5"
|
|
631
|
+
"tsdown": "0.23.0"
|
|
635
632
|
};
|
|
636
633
|
var peerDependencies = {
|
|
637
634
|
"@types/mdx": "*",
|
|
@@ -740,4 +737,4 @@ depVersions["fumadocs-ui"] = `npm:${name}@${version}`;
|
|
|
740
737
|
//#endregion
|
|
741
738
|
export { templates as i, isCI as n, sourceDir as r, depVersions as t };
|
|
742
739
|
|
|
743
|
-
//# sourceMappingURL=constants-
|
|
740
|
+
//# sourceMappingURL=constants-zMAyDXXs.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constants-
|
|
1
|
+
{"version":3,"file":"constants-zMAyDXXs.js","names":["corePkg","mdxPkg","basePkg","versionPkg.dependencies","basePkg.name","basePkg.version"],"sources":["../../create-app-versions/package.json","../../core/package.json","../../mdx/package.json","../../base-ui/package.json","../src/constants.ts"],"sourcesContent":["","","","","import { fileURLToPath } from 'node:url';\nimport versionPkg from '../../create-app-versions/package.json';\nimport * as corePkg from '../../core/package.json';\nimport * as mdxPkg from '../../mdx/package.json';\nimport * as basePkg from '../../base-ui/package.json';\n\nexport const sourceDir = fileURLToPath(new URL(`../`, import.meta.url).href);\n\nexport const isCI = Boolean(process.env.CI);\n\nexport interface TemplateInfo {\n value:\n | '+next+fuma-docs-mdx'\n | 'astro'\n | 'waku'\n | 'react-router'\n | 'react-router-spa'\n | 'tanstack-start'\n | 'tanstack-start-spa'\n | '+next+fuma-docs-mdx+static';\n label: string;\n appDir: string;\n /**\n * path to root provider, relative to `appDir``\n */\n rootProviderPath: string;\n hint?: string;\n /**\n * rename files when copying from template\n */\n rename?: (name: string) => string;\n}\n\nexport const templates: TemplateInfo[] = [\n {\n value: '+next+fuma-docs-mdx',\n label: 'Next.js: Fumadocs MDX',\n hint: 'recommended: powerful and mature',\n appDir: '',\n rootProviderPath: 'app/layout.tsx',\n },\n {\n value: 'waku',\n label: 'Waku: Fumadocs MDX',\n hint: 'recommended: fast and simple',\n appDir: 'src',\n rootProviderPath: 'components/provider.tsx',\n },\n {\n value: '+next+fuma-docs-mdx+static',\n label: 'Next.js Static: Fumadocs MDX',\n appDir: '',\n rootProviderPath: 'components/provider.tsx',\n },\n {\n value: 'react-router',\n label: 'React Router: Fumadocs MDX (not RSC)',\n appDir: 'app',\n rootProviderPath: 'root.tsx',\n },\n {\n value: 'react-router-spa',\n label: 'React Router SPA: Fumadocs MDX (not RSC)',\n hint: 'SPA mode allows you to host the site statically, compatible with a CDN.',\n appDir: 'app',\n rootProviderPath: 'root.tsx',\n },\n {\n value: 'tanstack-start',\n label: 'Tanstack Start: Fumadocs MDX (not RSC)',\n appDir: 'src',\n rootProviderPath: 'routes/__root.tsx',\n },\n {\n value: 'tanstack-start-spa',\n label: 'Tanstack Start SPA: Fumadocs MDX (not RSC)',\n hint: 'SPA mode allows you to host the site statically, compatible with a CDN.',\n appDir: 'src',\n rootProviderPath: 'routes/__root.tsx',\n },\n {\n value: 'astro',\n label: 'Astro: React Islands',\n hint: 'partial support only, uses Astro Content Collections.',\n appDir: 'src',\n rootProviderPath: 'components/docs.tsx',\n },\n];\n\nconst workspaces = [corePkg, mdxPkg, basePkg];\n\nexport const depVersions = versionPkg.dependencies;\n\nfor (const workspace of workspaces) {\n depVersions[workspace.name as keyof typeof depVersions] = workspace.version;\n}\n\ndepVersions['fumadocs-ui'] = `npm:${basePkg.name}@${basePkg.version}`;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AIMA,MAAa,YAAY,cAAc,IAAI,IAAI,OAAO,YAAY,GAAG,CAAC,CAAC,IAAI;AAE3E,MAAa,OAAO,QAAQ,QAAQ,IAAI,EAAE;AAyB1C,MAAa,YAA4B;CACvC;EACE,OAAO;EACP,OAAO;EACP,MAAM;EACN,QAAQ;EACR,kBAAkB;CACpB;CACA;EACE,OAAO;EACP,OAAO;EACP,MAAM;EACN,QAAQ;EACR,kBAAkB;CACpB;CACA;EACE,OAAO;EACP,OAAO;EACP,QAAQ;EACR,kBAAkB;CACpB;CACA;EACE,OAAO;EACP,OAAO;EACP,QAAQ;EACR,kBAAkB;CACpB;CACA;EACE,OAAO;EACP,OAAO;EACP,MAAM;EACN,QAAQ;EACR,kBAAkB;CACpB;CACA;EACE,OAAO;EACP,OAAO;EACP,QAAQ;EACR,kBAAkB;CACpB;CACA;EACE,OAAO;EACP,OAAO;EACP,MAAM;EACN,QAAQ;EACR,kBAAkB;CACpB;CACA;EACE,OAAO;EACP,OAAO;EACP,MAAM;EACN,QAAQ;EACR,kBAAkB;CACpB;AACF;AAEA,MAAM,aAAa;CAACA;CAASC;CAAQC;AAAO;AAE5C,MAAa,cAAcC;AAE3B,KAAK,MAAM,aAAa,YACtB,YAAY,UAAU,QAAoC,UAAU;AAGtE,YAAY,iBAAiB,OAAOC,KAAa,GAAGC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { t as depVersions } from "./constants-
|
|
1
|
+
import { t as depVersions } from "./constants-zMAyDXXs.js";
|
|
2
2
|
import { HttpRegistryConnector } from "fuma-cli/registry/connector";
|
|
3
3
|
import { getDefaultConfig } from "@fumadocs/cli/config";
|
|
4
4
|
import { runFeature } from "@fumadocs/cli/features";
|
|
@@ -24,4 +24,4 @@ function feature(feature, options) {
|
|
|
24
24
|
//#endregion
|
|
25
25
|
export { feature as t };
|
|
26
26
|
|
|
27
|
-
//# sourceMappingURL=feature-
|
|
27
|
+
//# sourceMappingURL=feature-_5VTBKAG.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"feature-
|
|
1
|
+
{"version":3,"file":"feature-_5VTBKAG.js","names":[],"sources":["../src/plugins/feature.ts"],"sourcesContent":["import type { TemplatePlugin } from '@/index';\nimport { HttpRegistryConnector } from 'fuma-cli/registry/connector';\nimport { getDefaultConfig } from '@fumadocs/cli/config';\nimport { type Feature, runFeature } from '@fumadocs/cli/features';\nimport { loadProject } from '@fumadocs/cli/project';\nimport { depVersions } from '@/constants';\n\n/** apply a Fumadocs CLI feature to the generated project */\nexport function feature<O extends object>(feature: Feature<O>, options: O): TemplatePlugin {\n return {\n async afterWrite() {\n const config = await getDefaultConfig(this.dest);\n const project = await loadProject(config, this.dest);\n\n await runFeature(feature, options, {\n project,\n connector: new HttpRegistryConnector('https://fumadocs.dev/registry'),\n versions: depVersions,\n io: { log: this.log, installDependencies: false, confirmOverwrite: async () => true },\n });\n },\n };\n}\n"],"mappings":";;;;;;;AAQA,SAAgB,QAA0B,SAAqB,SAA4B;CACzF,OAAO,EACL,MAAM,aAAa;EACjB,MAAM,SAAS,MAAM,iBAAiB,KAAK,IAAI;EAC/C,MAAM,UAAU,MAAM,YAAY,QAAQ,KAAK,IAAI;EAEnD,MAAM,WAAW,SAAS,SAAS;GACjC;GACA,WAAW,IAAI,sBAAsB,+BAA+B;GACpE,UAAU;GACV,IAAI;IAAE,KAAK,KAAK;IAAK,qBAAqB;IAAO,kBAAkB,YAAY;GAAK;EACtF,CAAC;CACH,EACF;AACF"}
|
package/dist/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { t as create } from "./src-
|
|
1
|
+
import { t as create } from "./src-CA0piVVr.js";
|
|
2
2
|
export { create };
|
package/dist/plugins/feature.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { t as feature } from "../feature-
|
|
1
|
+
import { t as feature } from "../feature-_5VTBKAG.js";
|
|
2
2
|
export { feature };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { i as templates, r as sourceDir, t as depVersions } from "./constants-
|
|
1
|
+
import { i as templates, r as sourceDir, t as depVersions } from "./constants-zMAyDXXs.js";
|
|
2
2
|
import fs from "node:fs/promises";
|
|
3
3
|
import path, { join } from "node:path";
|
|
4
4
|
import { x } from "tinyexec";
|
|
@@ -145,4 +145,4 @@ async function initPackageJson(projectName, packageJsonPath) {
|
|
|
145
145
|
//#endregion
|
|
146
146
|
export { getPackageManager as n, managers as r, create as t };
|
|
147
147
|
|
|
148
|
-
//# sourceMappingURL=src-
|
|
148
|
+
//# sourceMappingURL=src-CA0piVVr.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"src-BY4nWSTl.js","names":[],"sources":["../src/auto-install.ts","../src/utils.ts","../src/index.ts"],"sourcesContent":["import { x } from 'tinyexec';\n\nexport type PackageManager = (typeof managers)[number];\n\nexport const managers = ['npm', 'yarn', 'bun', 'pnpm'] as const;\n\nexport function getPackageManager(): PackageManager {\n const userAgent = process.env.npm_config_user_agent ?? '';\n\n if (userAgent.startsWith('yarn')) {\n return 'yarn';\n }\n\n if (userAgent.startsWith('pnpm')) {\n return 'pnpm';\n }\n\n if (userAgent.startsWith('bun')) {\n return 'bun';\n }\n\n return 'npm';\n}\n\nexport async function autoInstall(manager: PackageManager, dest: string) {\n await x(manager, ['install'], {\n throwOnError: true,\n nodeOptions: {\n env: {\n ...process.env,\n NODE_ENV: 'development',\n DISABLE_OPENCOLLECTIVE: '1',\n },\n cwd: dest,\n },\n });\n}\n","import fs from 'node:fs/promises';\nimport path, { join } from 'node:path';\nimport { x } from 'tinyexec';\n\nexport async function copy(\n from: string,\n to: string,\n options: {\n rename?: (s: string) => string;\n filter?: (s: string) => boolean;\n filterDir?: (dir: string) => boolean;\n } = {},\n): Promise<void> {\n const { rename = (s) => s, filterDir = () => true, filter = () => true } = options;\n const stats = await fs.stat(from);\n\n if (stats.isDirectory() && filterDir(from)) {\n const files = await fs.readdir(from);\n\n await Promise.all(\n files.map((file) => copy(path.join(from, file), path.join(to, file), options)),\n );\n }\n\n if (stats.isFile() && filter(from)) {\n to = rename(to);\n await fs.mkdir(path.dirname(to), { recursive: true });\n await fs.copyFile(from, to);\n }\n}\n\nasync function isInGitRepository(cwd: string) {\n const { exitCode } = await x('git', ['rev-parse', '--is-inside-work-tree'], {\n nodeOptions: { cwd },\n });\n\n return exitCode === 0;\n}\n\nasync function isDefaultBranchSet(cwd: string) {\n const { exitCode } = await x('git', ['config', 'init.defaultBranch'], {\n nodeOptions: { cwd },\n });\n\n return exitCode === 0;\n}\n\n/*\nInitialize a Git repo on the project.\n\nBased on https://github.com/vercel/next.js/blob/canary/packages/create-next-app/helpers/git.ts\n*/\nexport async function tryGitInit(cwd: string): Promise<boolean> {\n const { exitCode } = await x('git', ['--version']);\n if (exitCode !== 0) return false;\n\n if (await isInGitRepository(cwd)) return false;\n\n try {\n await x('git', ['init'], {\n throwOnError: true,\n nodeOptions: { cwd },\n });\n\n if (!(await isDefaultBranchSet(cwd))) {\n await x('git', ['checkout', '-b', 'main'], {\n throwOnError: true,\n nodeOptions: {\n cwd,\n },\n });\n }\n\n await x('git', ['add', '-A'], {\n throwOnError: true,\n nodeOptions: {\n cwd,\n },\n });\n\n await x('git', ['commit', '-m', 'Initial commit from Create Fumadocs App'], {\n throwOnError: true,\n nodeOptions: {\n cwd,\n },\n });\n return true;\n } catch {\n await fs.rm(join(cwd, '.git'), { recursive: true, force: true });\n\n return false;\n }\n}\n","import path from 'node:path';\nimport fs from 'node:fs/promises';\nimport { copy, tryGitInit } from '@/utils';\nimport type { PackageManager } from './auto-install';\nimport { autoInstall } from './auto-install';\nimport { depVersions, sourceDir, type TemplateInfo, templates } from './constants';\n\nexport type Template = TemplateInfo['value'];\nexport interface Options {\n outputDir: string;\n template: Template;\n\n /**\n * the package manager to use\n *\n * @defaultValue 'npm'\n */\n packageManager?: PackageManager;\n\n installDeps?: boolean;\n initializeGit?: boolean;\n log?: (message: string) => void;\n plugins?: TemplatePlugin[];\n}\n\nexport interface TemplatePluginContext {\n template: TemplateInfo;\n log: (message: string) => void;\n /**\n * output directory\n */\n dest: string;\n\n /**\n * output directory for app code (e.g. under `/src`)\n */\n appDir: string;\n}\n\nexport type PackageJsonType = {\n name?: string;\n version?: string;\n private?: boolean;\n scripts?: Record<string, string>;\n dependencies?: Record<string, string>;\n devDependencies?: Record<string, string>;\n} & Record<string, unknown>;\n\ntype Awaitable<T> = T | Promise<T>;\n\nexport interface TemplatePlugin {\n template?: (\n this: Pick<TemplatePluginContext, 'dest'>,\n info: TemplateInfo,\n ) => Awaitable<void | TemplateInfo>;\n packageJson?: (\n this: TemplatePluginContext,\n packageJson: PackageJsonType,\n ) => Awaitable<void | PackageJsonType>;\n afterWrite?: (this: TemplatePluginContext) => Awaitable<void>;\n readme?: (this: TemplatePluginContext, content: string) => Awaitable<void | string>;\n}\n\nexport async function create(createOptions: Options): Promise<void> {\n const {\n outputDir,\n plugins = [],\n packageManager = 'npm',\n initializeGit = false,\n installDeps = false,\n log = console.log,\n } = createOptions;\n\n let template = templates.find((item) => item.value === createOptions.template)!;\n for (const plugin of plugins) {\n template = (await plugin.template?.call({ dest: outputDir }, template)) ?? template;\n }\n\n const appDir = path.join(outputDir, template.appDir);\n const projectName = path.basename(outputDir);\n const pluginContext: TemplatePluginContext = {\n template,\n dest: outputDir,\n log,\n appDir,\n };\n\n await copy(path.join(sourceDir, 'template', template.value), outputDir, {\n rename(file) {\n file = file.replace('example.gitignore', '.gitignore');\n\n return template.rename?.(file) ?? file;\n },\n });\n\n const packageJsonPath = path.join(outputDir, 'package.json');\n let packageJson = await initPackageJson(projectName, packageJsonPath);\n for (const plugin of plugins) {\n packageJson = (await plugin.packageJson?.call(pluginContext, packageJson)) ?? packageJson;\n }\n await fs.writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2));\n\n const readmePath = path.join(outputDir, 'README.md');\n let readme = `# ${projectName}\\n\\n${await fs.readFile(readmePath)}`;\n for (const plugin of plugins) {\n readme = (await plugin.readme?.call(pluginContext, readme)) ?? readme;\n }\n await fs.writeFile(readmePath, readme);\n\n for (const plugin of plugins) {\n await plugin.afterWrite?.call(pluginContext);\n }\n\n if (installDeps) {\n try {\n await autoInstall(packageManager, outputDir);\n log('Installed dependencies');\n } catch (err) {\n log(`Failed to install dependencies: ${err}`);\n }\n }\n\n if (initializeGit && (await tryGitInit(outputDir))) {\n log('Initialized Git repository');\n }\n}\n\nasync function initPackageJson(\n projectName: string,\n packageJsonPath: string,\n): Promise<PackageJsonType> {\n function replaceWorkspaceDeps(deps: Record<string, string> = {}) {\n for (const k in deps) {\n if (deps[k].startsWith('workspace:') && k in depVersions) {\n deps[k] = depVersions[k as keyof typeof depVersions];\n }\n }\n\n return deps;\n }\n\n const packageJson: PackageJsonType = JSON.parse(await fs.readFile(packageJsonPath, 'utf-8'));\n const dependencies = replaceWorkspaceDeps(packageJson.dependencies);\n const devDependencies = replaceWorkspaceDeps(packageJson.devDependencies);\n const scripts = { ...packageJson.scripts };\n\n return {\n ...packageJson,\n name: projectName,\n scripts,\n dependencies,\n devDependencies,\n };\n}\n"],"mappings":";;;;;AAIA,MAAa,WAAW;CAAC;CAAO;CAAQ;CAAO;AAAM;AAErD,SAAgB,oBAAoC;CAClD,MAAM,YAAY,QAAQ,IAAI,yBAAyB;CAEvD,IAAI,UAAU,WAAW,MAAM,GAC7B,OAAO;CAGT,IAAI,UAAU,WAAW,MAAM,GAC7B,OAAO;CAGT,IAAI,UAAU,WAAW,KAAK,GAC5B,OAAO;CAGT,OAAO;AACT;AAEA,eAAsB,YAAY,SAAyB,MAAc;CACvE,MAAM,EAAE,SAAS,CAAC,SAAS,GAAG;EAC5B,cAAc;EACd,aAAa;GACX,KAAK;IACH,GAAG,QAAQ;IACX,UAAU;IACV,wBAAwB;GAC1B;GACA,KAAK;EACP;CACF,CAAC;AACH;;;AChCA,eAAsB,KACpB,MACA,IACA,UAII,CAAC,GACU;CACf,MAAM,EAAE,UAAU,MAAM,GAAG,kBAAkB,MAAM,eAAe,SAAS;CAC3E,MAAM,QAAQ,MAAM,GAAG,KAAK,IAAI;CAEhC,IAAI,MAAM,YAAY,KAAK,UAAU,IAAI,GAAG;EAC1C,MAAM,QAAQ,MAAM,GAAG,QAAQ,IAAI;EAEnC,MAAM,QAAQ,IACZ,MAAM,KAAK,SAAS,KAAK,KAAK,KAAK,MAAM,IAAI,GAAG,KAAK,KAAK,IAAI,IAAI,GAAG,OAAO,CAAC,CAC/E;CACF;CAEA,IAAI,MAAM,OAAO,KAAK,OAAO,IAAI,GAAG;EAClC,KAAK,OAAO,EAAE;EACd,MAAM,GAAG,MAAM,KAAK,QAAQ,EAAE,GAAG,EAAE,WAAW,KAAK,CAAC;EACpD,MAAM,GAAG,SAAS,MAAM,EAAE;CAC5B;AACF;AAEA,eAAe,kBAAkB,KAAa;CAC5C,MAAM,EAAE,aAAa,MAAM,EAAE,OAAO,CAAC,aAAa,uBAAuB,GAAG,EAC1E,aAAa,EAAE,IAAI,EACrB,CAAC;CAED,OAAO,aAAa;AACtB;AAEA,eAAe,mBAAmB,KAAa;CAC7C,MAAM,EAAE,aAAa,MAAM,EAAE,OAAO,CAAC,UAAU,oBAAoB,GAAG,EACpE,aAAa,EAAE,IAAI,EACrB,CAAC;CAED,OAAO,aAAa;AACtB;AAOA,eAAsB,WAAW,KAA+B;CAC9D,MAAM,EAAE,aAAa,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC;CACjD,IAAI,aAAa,GAAG,OAAO;CAE3B,IAAI,MAAM,kBAAkB,GAAG,GAAG,OAAO;CAEzC,IAAI;EACF,MAAM,EAAE,OAAO,CAAC,MAAM,GAAG;GACvB,cAAc;GACd,aAAa,EAAE,IAAI;EACrB,CAAC;EAED,IAAI,CAAE,MAAM,mBAAmB,GAAG,GAChC,MAAM,EAAE,OAAO;GAAC;GAAY;GAAM;EAAM,GAAG;GACzC,cAAc;GACd,aAAa,EACX,IACF;EACF,CAAC;EAGH,MAAM,EAAE,OAAO,CAAC,OAAO,IAAI,GAAG;GAC5B,cAAc;GACd,aAAa,EACX,IACF;EACF,CAAC;EAED,MAAM,EAAE,OAAO;GAAC;GAAU;GAAM;EAAyC,GAAG;GAC1E,cAAc;GACd,aAAa,EACX,IACF;EACF,CAAC;EACD,OAAO;CACT,QAAQ;EACN,MAAM,GAAG,GAAG,KAAK,KAAK,MAAM,GAAG;GAAE,WAAW;GAAM,OAAO;EAAK,CAAC;EAE/D,OAAO;CACT;AACF;;;AC7BA,eAAsB,OAAO,eAAuC;CAClE,MAAM,EACJ,WACA,UAAU,CAAC,GACX,iBAAiB,OACjB,gBAAgB,OAChB,cAAc,OACd,MAAM,QAAQ,QACZ;CAEJ,IAAI,WAAW,UAAU,MAAM,SAAS,KAAK,UAAU,cAAc,QAAQ;CAC7E,KAAK,MAAM,UAAU,SACnB,WAAY,MAAM,OAAO,UAAU,KAAK,EAAE,MAAM,UAAU,GAAG,QAAQ,KAAM;CAG7E,MAAM,SAAS,KAAK,KAAK,WAAW,SAAS,MAAM;CACnD,MAAM,cAAc,KAAK,SAAS,SAAS;CAC3C,MAAM,gBAAuC;EAC3C;EACA,MAAM;EACN;EACA;CACF;CAEA,MAAM,KAAK,KAAK,KAAK,WAAW,YAAY,SAAS,KAAK,GAAG,WAAW,EACtE,OAAO,MAAM;EACX,OAAO,KAAK,QAAQ,qBAAqB,YAAY;EAErD,OAAO,SAAS,SAAS,IAAI,KAAK;CACpC,EACF,CAAC;CAED,MAAM,kBAAkB,KAAK,KAAK,WAAW,cAAc;CAC3D,IAAI,cAAc,MAAM,gBAAgB,aAAa,eAAe;CACpE,KAAK,MAAM,UAAU,SACnB,cAAe,MAAM,OAAO,aAAa,KAAK,eAAe,WAAW,KAAM;CAEhF,MAAM,GAAG,UAAU,iBAAiB,KAAK,UAAU,aAAa,MAAM,CAAC,CAAC;CAExE,MAAM,aAAa,KAAK,KAAK,WAAW,WAAW;CACnD,IAAI,SAAS,KAAK,YAAY,MAAM,MAAM,GAAG,SAAS,UAAU;CAChE,KAAK,MAAM,UAAU,SACnB,SAAU,MAAM,OAAO,QAAQ,KAAK,eAAe,MAAM,KAAM;CAEjE,MAAM,GAAG,UAAU,YAAY,MAAM;CAErC,KAAK,MAAM,UAAU,SACnB,MAAM,OAAO,YAAY,KAAK,aAAa;CAG7C,IAAI,aACF,IAAI;EACF,MAAM,YAAY,gBAAgB,SAAS;EAC3C,IAAI,wBAAwB;CAC9B,SAAS,KAAK;EACZ,IAAI,mCAAmC,KAAK;CAC9C;CAGF,IAAI,iBAAkB,MAAM,WAAW,SAAS,GAC9C,IAAI,4BAA4B;AAEpC;AAEA,eAAe,gBACb,aACA,iBAC0B;CAC1B,SAAS,qBAAqB,OAA+B,CAAC,GAAG;EAC/D,KAAK,MAAM,KAAK,MACd,IAAI,KAAK,EAAE,CAAC,WAAW,YAAY,KAAK,KAAK,aAC3C,KAAK,KAAK,YAAY;EAI1B,OAAO;CACT;CAEA,MAAM,cAA+B,KAAK,MAAM,MAAM,GAAG,SAAS,iBAAiB,OAAO,CAAC;CAC3F,MAAM,eAAe,qBAAqB,YAAY,YAAY;CAClE,MAAM,kBAAkB,qBAAqB,YAAY,eAAe;CACxE,MAAM,UAAU,EAAE,GAAG,YAAY,QAAQ;CAEzC,OAAO;EACL,GAAG;EACH,MAAM;EACN;EACA;EACA;CACF;AACF"}
|
|
1
|
+
{"version":3,"file":"src-CA0piVVr.js","names":[],"sources":["../src/auto-install.ts","../src/utils.ts","../src/index.ts"],"sourcesContent":["import { x } from 'tinyexec';\n\nexport type PackageManager = (typeof managers)[number];\n\nexport const managers = ['npm', 'yarn', 'bun', 'pnpm'] as const;\n\nexport function getPackageManager(): PackageManager {\n const userAgent = process.env.npm_config_user_agent ?? '';\n\n if (userAgent.startsWith('yarn')) {\n return 'yarn';\n }\n\n if (userAgent.startsWith('pnpm')) {\n return 'pnpm';\n }\n\n if (userAgent.startsWith('bun')) {\n return 'bun';\n }\n\n return 'npm';\n}\n\nexport async function autoInstall(manager: PackageManager, dest: string) {\n await x(manager, ['install'], {\n throwOnError: true,\n nodeOptions: {\n env: {\n ...process.env,\n NODE_ENV: 'development',\n DISABLE_OPENCOLLECTIVE: '1',\n },\n cwd: dest,\n },\n });\n}\n","import fs from 'node:fs/promises';\nimport path, { join } from 'node:path';\nimport { x } from 'tinyexec';\n\nexport async function copy(\n from: string,\n to: string,\n options: {\n rename?: (s: string) => string;\n filter?: (s: string) => boolean;\n filterDir?: (dir: string) => boolean;\n } = {},\n): Promise<void> {\n const { rename = (s) => s, filterDir = () => true, filter = () => true } = options;\n const stats = await fs.stat(from);\n\n if (stats.isDirectory() && filterDir(from)) {\n const files = await fs.readdir(from);\n\n await Promise.all(\n files.map((file) => copy(path.join(from, file), path.join(to, file), options)),\n );\n }\n\n if (stats.isFile() && filter(from)) {\n to = rename(to);\n await fs.mkdir(path.dirname(to), { recursive: true });\n await fs.copyFile(from, to);\n }\n}\n\nasync function isInGitRepository(cwd: string) {\n const { exitCode } = await x('git', ['rev-parse', '--is-inside-work-tree'], {\n nodeOptions: { cwd },\n });\n\n return exitCode === 0;\n}\n\nasync function isDefaultBranchSet(cwd: string) {\n const { exitCode } = await x('git', ['config', 'init.defaultBranch'], {\n nodeOptions: { cwd },\n });\n\n return exitCode === 0;\n}\n\n/*\nInitialize a Git repo on the project.\n\nBased on https://github.com/vercel/next.js/blob/canary/packages/create-next-app/helpers/git.ts\n*/\nexport async function tryGitInit(cwd: string): Promise<boolean> {\n const { exitCode } = await x('git', ['--version']);\n if (exitCode !== 0) return false;\n\n if (await isInGitRepository(cwd)) return false;\n\n try {\n await x('git', ['init'], {\n throwOnError: true,\n nodeOptions: { cwd },\n });\n\n if (!(await isDefaultBranchSet(cwd))) {\n await x('git', ['checkout', '-b', 'main'], {\n throwOnError: true,\n nodeOptions: {\n cwd,\n },\n });\n }\n\n await x('git', ['add', '-A'], {\n throwOnError: true,\n nodeOptions: {\n cwd,\n },\n });\n\n await x('git', ['commit', '-m', 'Initial commit from Create Fumadocs App'], {\n throwOnError: true,\n nodeOptions: {\n cwd,\n },\n });\n return true;\n } catch {\n await fs.rm(join(cwd, '.git'), { recursive: true, force: true });\n\n return false;\n }\n}\n","import path from 'node:path';\nimport fs from 'node:fs/promises';\nimport { copy, tryGitInit } from '@/utils';\nimport type { PackageManager } from './auto-install';\nimport { autoInstall } from './auto-install';\nimport { depVersions, sourceDir, type TemplateInfo, templates } from './constants';\n\nexport type Template = TemplateInfo['value'];\nexport interface Options {\n outputDir: string;\n template: Template;\n\n /**\n * the package manager to use\n *\n * @defaultValue 'npm'\n */\n packageManager?: PackageManager;\n\n installDeps?: boolean;\n initializeGit?: boolean;\n log?: (message: string) => void;\n plugins?: TemplatePlugin[];\n}\n\nexport interface TemplatePluginContext {\n template: TemplateInfo;\n log: (message: string) => void;\n /**\n * output directory\n */\n dest: string;\n\n /**\n * output directory for app code (e.g. under `/src`)\n */\n appDir: string;\n}\n\nexport type PackageJsonType = {\n name?: string;\n version?: string;\n private?: boolean;\n scripts?: Record<string, string>;\n dependencies?: Record<string, string>;\n devDependencies?: Record<string, string>;\n} & Record<string, unknown>;\n\ntype Awaitable<T> = T | Promise<T>;\n\nexport interface TemplatePlugin {\n template?: (\n this: Pick<TemplatePluginContext, 'dest'>,\n info: TemplateInfo,\n ) => Awaitable<void | TemplateInfo>;\n packageJson?: (\n this: TemplatePluginContext,\n packageJson: PackageJsonType,\n ) => Awaitable<void | PackageJsonType>;\n afterWrite?: (this: TemplatePluginContext) => Awaitable<void>;\n readme?: (this: TemplatePluginContext, content: string) => Awaitable<void | string>;\n}\n\nexport async function create(createOptions: Options): Promise<void> {\n const {\n outputDir,\n plugins = [],\n packageManager = 'npm',\n initializeGit = false,\n installDeps = false,\n log = console.log,\n } = createOptions;\n\n let template = templates.find((item) => item.value === createOptions.template)!;\n for (const plugin of plugins) {\n template = (await plugin.template?.call({ dest: outputDir }, template)) ?? template;\n }\n\n const appDir = path.join(outputDir, template.appDir);\n const projectName = path.basename(outputDir);\n const pluginContext: TemplatePluginContext = {\n template,\n dest: outputDir,\n log,\n appDir,\n };\n\n await copy(path.join(sourceDir, 'template', template.value), outputDir, {\n rename(file) {\n file = file.replace('example.gitignore', '.gitignore');\n\n return template.rename?.(file) ?? file;\n },\n });\n\n const packageJsonPath = path.join(outputDir, 'package.json');\n let packageJson = await initPackageJson(projectName, packageJsonPath);\n for (const plugin of plugins) {\n packageJson = (await plugin.packageJson?.call(pluginContext, packageJson)) ?? packageJson;\n }\n await fs.writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2));\n\n const readmePath = path.join(outputDir, 'README.md');\n let readme = `# ${projectName}\\n\\n${await fs.readFile(readmePath)}`;\n for (const plugin of plugins) {\n readme = (await plugin.readme?.call(pluginContext, readme)) ?? readme;\n }\n await fs.writeFile(readmePath, readme);\n\n for (const plugin of plugins) {\n await plugin.afterWrite?.call(pluginContext);\n }\n\n if (installDeps) {\n try {\n await autoInstall(packageManager, outputDir);\n log('Installed dependencies');\n } catch (err) {\n log(`Failed to install dependencies: ${err}`);\n }\n }\n\n if (initializeGit && (await tryGitInit(outputDir))) {\n log('Initialized Git repository');\n }\n}\n\nasync function initPackageJson(\n projectName: string,\n packageJsonPath: string,\n): Promise<PackageJsonType> {\n function replaceWorkspaceDeps(deps: Record<string, string> = {}) {\n for (const k in deps) {\n if (deps[k].startsWith('workspace:') && k in depVersions) {\n deps[k] = depVersions[k as keyof typeof depVersions];\n }\n }\n\n return deps;\n }\n\n const packageJson: PackageJsonType = JSON.parse(await fs.readFile(packageJsonPath, 'utf-8'));\n const dependencies = replaceWorkspaceDeps(packageJson.dependencies);\n const devDependencies = replaceWorkspaceDeps(packageJson.devDependencies);\n const scripts = { ...packageJson.scripts };\n\n return {\n ...packageJson,\n name: projectName,\n scripts,\n dependencies,\n devDependencies,\n };\n}\n"],"mappings":";;;;;AAIA,MAAa,WAAW;CAAC;CAAO;CAAQ;CAAO;AAAM;AAErD,SAAgB,oBAAoC;CAClD,MAAM,YAAY,QAAQ,IAAI,yBAAyB;CAEvD,IAAI,UAAU,WAAW,MAAM,GAC7B,OAAO;CAGT,IAAI,UAAU,WAAW,MAAM,GAC7B,OAAO;CAGT,IAAI,UAAU,WAAW,KAAK,GAC5B,OAAO;CAGT,OAAO;AACT;AAEA,eAAsB,YAAY,SAAyB,MAAc;CACvE,MAAM,EAAE,SAAS,CAAC,SAAS,GAAG;EAC5B,cAAc;EACd,aAAa;GACX,KAAK;IACH,GAAG,QAAQ;IACX,UAAU;IACV,wBAAwB;GAC1B;GACA,KAAK;EACP;CACF,CAAC;AACH;;;AChCA,eAAsB,KACpB,MACA,IACA,UAII,CAAC,GACU;CACf,MAAM,EAAE,UAAU,MAAM,GAAG,kBAAkB,MAAM,eAAe,SAAS;CAC3E,MAAM,QAAQ,MAAM,GAAG,KAAK,IAAI;CAEhC,IAAI,MAAM,YAAY,KAAK,UAAU,IAAI,GAAG;EAC1C,MAAM,QAAQ,MAAM,GAAG,QAAQ,IAAI;EAEnC,MAAM,QAAQ,IACZ,MAAM,KAAK,SAAS,KAAK,KAAK,KAAK,MAAM,IAAI,GAAG,KAAK,KAAK,IAAI,IAAI,GAAG,OAAO,CAAC,CAC/E;CACF;CAEA,IAAI,MAAM,OAAO,KAAK,OAAO,IAAI,GAAG;EAClC,KAAK,OAAO,EAAE;EACd,MAAM,GAAG,MAAM,KAAK,QAAQ,EAAE,GAAG,EAAE,WAAW,KAAK,CAAC;EACpD,MAAM,GAAG,SAAS,MAAM,EAAE;CAC5B;AACF;AAEA,eAAe,kBAAkB,KAAa;CAC5C,MAAM,EAAE,aAAa,MAAM,EAAE,OAAO,CAAC,aAAa,uBAAuB,GAAG,EAC1E,aAAa,EAAE,IAAI,EACrB,CAAC;CAED,OAAO,aAAa;AACtB;AAEA,eAAe,mBAAmB,KAAa;CAC7C,MAAM,EAAE,aAAa,MAAM,EAAE,OAAO,CAAC,UAAU,oBAAoB,GAAG,EACpE,aAAa,EAAE,IAAI,EACrB,CAAC;CAED,OAAO,aAAa;AACtB;AAOA,eAAsB,WAAW,KAA+B;CAC9D,MAAM,EAAE,aAAa,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC;CACjD,IAAI,aAAa,GAAG,OAAO;CAE3B,IAAI,MAAM,kBAAkB,GAAG,GAAG,OAAO;CAEzC,IAAI;EACF,MAAM,EAAE,OAAO,CAAC,MAAM,GAAG;GACvB,cAAc;GACd,aAAa,EAAE,IAAI;EACrB,CAAC;EAED,IAAI,CAAE,MAAM,mBAAmB,GAAG,GAChC,MAAM,EAAE,OAAO;GAAC;GAAY;GAAM;EAAM,GAAG;GACzC,cAAc;GACd,aAAa,EACX,IACF;EACF,CAAC;EAGH,MAAM,EAAE,OAAO,CAAC,OAAO,IAAI,GAAG;GAC5B,cAAc;GACd,aAAa,EACX,IACF;EACF,CAAC;EAED,MAAM,EAAE,OAAO;GAAC;GAAU;GAAM;EAAyC,GAAG;GAC1E,cAAc;GACd,aAAa,EACX,IACF;EACF,CAAC;EACD,OAAO;CACT,QAAQ;EACN,MAAM,GAAG,GAAG,KAAK,KAAK,MAAM,GAAG;GAAE,WAAW;GAAM,OAAO;EAAK,CAAC;EAE/D,OAAO;CACT;AACF;;;AC7BA,eAAsB,OAAO,eAAuC;CAClE,MAAM,EACJ,WACA,UAAU,CAAC,GACX,iBAAiB,OACjB,gBAAgB,OAChB,cAAc,OACd,MAAM,QAAQ,QACZ;CAEJ,IAAI,WAAW,UAAU,MAAM,SAAS,KAAK,UAAU,cAAc,QAAQ;CAC7E,KAAK,MAAM,UAAU,SACnB,WAAY,MAAM,OAAO,UAAU,KAAK,EAAE,MAAM,UAAU,GAAG,QAAQ,KAAM;CAG7E,MAAM,SAAS,KAAK,KAAK,WAAW,SAAS,MAAM;CACnD,MAAM,cAAc,KAAK,SAAS,SAAS;CAC3C,MAAM,gBAAuC;EAC3C;EACA,MAAM;EACN;EACA;CACF;CAEA,MAAM,KAAK,KAAK,KAAK,WAAW,YAAY,SAAS,KAAK,GAAG,WAAW,EACtE,OAAO,MAAM;EACX,OAAO,KAAK,QAAQ,qBAAqB,YAAY;EAErD,OAAO,SAAS,SAAS,IAAI,KAAK;CACpC,EACF,CAAC;CAED,MAAM,kBAAkB,KAAK,KAAK,WAAW,cAAc;CAC3D,IAAI,cAAc,MAAM,gBAAgB,aAAa,eAAe;CACpE,KAAK,MAAM,UAAU,SACnB,cAAe,MAAM,OAAO,aAAa,KAAK,eAAe,WAAW,KAAM;CAEhF,MAAM,GAAG,UAAU,iBAAiB,KAAK,UAAU,aAAa,MAAM,CAAC,CAAC;CAExE,MAAM,aAAa,KAAK,KAAK,WAAW,WAAW;CACnD,IAAI,SAAS,KAAK,YAAY,MAAM,MAAM,GAAG,SAAS,UAAU;CAChE,KAAK,MAAM,UAAU,SACnB,SAAU,MAAM,OAAO,QAAQ,KAAK,eAAe,MAAM,KAAM;CAEjE,MAAM,GAAG,UAAU,YAAY,MAAM;CAErC,KAAK,MAAM,UAAU,SACnB,MAAM,OAAO,YAAY,KAAK,aAAa;CAG7C,IAAI,aACF,IAAI;EACF,MAAM,YAAY,gBAAgB,SAAS;EAC3C,IAAI,wBAAwB;CAC9B,SAAS,KAAK;EACZ,IAAI,mCAAmC,KAAK;CAC9C;CAGF,IAAI,iBAAkB,MAAM,WAAW,SAAS,GAC9C,IAAI,4BAA4B;AAEpC;AAEA,eAAe,gBACb,aACA,iBAC0B;CAC1B,SAAS,qBAAqB,OAA+B,CAAC,GAAG;EAC/D,KAAK,MAAM,KAAK,MACd,IAAI,KAAK,EAAE,CAAC,WAAW,YAAY,KAAK,KAAK,aAC3C,KAAK,KAAK,YAAY;EAI1B,OAAO;CACT;CAEA,MAAM,cAA+B,KAAK,MAAM,MAAM,GAAG,SAAS,iBAAiB,OAAO,CAAC;CAC3F,MAAM,eAAe,qBAAqB,YAAY,YAAY;CAClE,MAAM,kBAAkB,qBAAqB,YAAY,eAAe;CACxE,MAAM,UAAU,EAAE,GAAG,YAAY,QAAQ;CAEzC,OAAO;EACL,GAAG;EACH,MAAM;EACN;EACA;EACA;CACF;AACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-fumadocs-app",
|
|
3
|
-
"version": "16.2.
|
|
3
|
+
"version": "16.2.18",
|
|
4
4
|
"description": "Create a new documentation site with Fumadocs",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"Docs",
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
},
|
|
41
41
|
"dependencies": {
|
|
42
42
|
"@clack/prompts": "^1.8.1",
|
|
43
|
-
"@fumadocs/cli": "1.7.
|
|
43
|
+
"@fumadocs/cli": "1.7.5",
|
|
44
44
|
"cac": "^7.0.0",
|
|
45
45
|
"fuma-cli": "^0.3.1",
|
|
46
46
|
"picocolors": "^1.1.1",
|
|
@@ -10,20 +10,17 @@ import {
|
|
|
10
10
|
SearchDialogOverlay,
|
|
11
11
|
type SharedProps,
|
|
12
12
|
} from 'fumadocs-ui/components/dialog/search';
|
|
13
|
-
import {
|
|
14
|
-
import { staticClient } from 'fumadocs-core/search/client/orama-static';
|
|
13
|
+
import { useStaticSearch } from 'fumadocs-core/search/client';
|
|
15
14
|
import { useI18n } from 'fumadocs-ui/contexts/i18n';
|
|
16
15
|
|
|
17
16
|
export default function DefaultSearchDialog(props: SharedProps) {
|
|
18
17
|
const { locale } = useI18n(); // (optional) for i18n
|
|
19
|
-
const
|
|
20
|
-
|
|
21
|
-
locale,
|
|
22
|
-
}),
|
|
18
|
+
const search = useStaticSearch({
|
|
19
|
+
locale,
|
|
23
20
|
});
|
|
24
21
|
|
|
25
22
|
return (
|
|
26
|
-
<SearchDialog
|
|
23
|
+
<SearchDialog {...search} {...props}>
|
|
27
24
|
<SearchDialogOverlay />
|
|
28
25
|
<SearchDialogContent>
|
|
29
26
|
<SearchDialogHeader>
|
|
@@ -31,7 +28,7 @@ export default function DefaultSearchDialog(props: SharedProps) {
|
|
|
31
28
|
<SearchDialogInput />
|
|
32
29
|
<SearchDialogClose />
|
|
33
30
|
</SearchDialogHeader>
|
|
34
|
-
<SearchDialogList
|
|
31
|
+
<SearchDialogList />
|
|
35
32
|
</SearchDialogContent>
|
|
36
33
|
</SearchDialog>
|
|
37
34
|
);
|
|
@@ -10,20 +10,17 @@ import {
|
|
|
10
10
|
SearchDialogOverlay,
|
|
11
11
|
type SharedProps,
|
|
12
12
|
} from 'fumadocs-ui/components/dialog/search';
|
|
13
|
-
import {
|
|
14
|
-
import { staticClient } from 'fumadocs-core/search/client/orama-static';
|
|
13
|
+
import { useStaticSearch } from 'fumadocs-core/search/client';
|
|
15
14
|
import { useI18n } from 'fumadocs-ui/contexts/i18n';
|
|
16
15
|
|
|
17
16
|
export default function DefaultSearchDialog(props: SharedProps) {
|
|
18
17
|
const { locale } = useI18n(); // (optional) for i18n
|
|
19
|
-
const
|
|
20
|
-
|
|
21
|
-
locale,
|
|
22
|
-
}),
|
|
18
|
+
const search = useStaticSearch({
|
|
19
|
+
locale,
|
|
23
20
|
});
|
|
24
21
|
|
|
25
22
|
return (
|
|
26
|
-
<SearchDialog
|
|
23
|
+
<SearchDialog {...search} {...props}>
|
|
27
24
|
<SearchDialogOverlay />
|
|
28
25
|
<SearchDialogContent>
|
|
29
26
|
<SearchDialogHeader>
|
|
@@ -31,7 +28,7 @@ export default function DefaultSearchDialog(props: SharedProps) {
|
|
|
31
28
|
<SearchDialogInput />
|
|
32
29
|
<SearchDialogClose />
|
|
33
30
|
</SearchDialogHeader>
|
|
34
|
-
<SearchDialogList
|
|
31
|
+
<SearchDialogList />
|
|
35
32
|
</SearchDialogContent>
|
|
36
33
|
</SearchDialog>
|
|
37
34
|
);
|
|
@@ -10,20 +10,17 @@ import {
|
|
|
10
10
|
SearchDialogOverlay,
|
|
11
11
|
type SharedProps,
|
|
12
12
|
} from 'fumadocs-ui/components/dialog/search';
|
|
13
|
-
import {
|
|
14
|
-
import { staticClient } from 'fumadocs-core/search/client/orama-static';
|
|
13
|
+
import { useStaticSearch } from 'fumadocs-core/search/client';
|
|
15
14
|
import { useI18n } from 'fumadocs-ui/contexts/i18n';
|
|
16
15
|
|
|
17
16
|
export default function DefaultSearchDialog(props: SharedProps) {
|
|
18
17
|
const { locale } = useI18n();
|
|
19
|
-
const
|
|
20
|
-
|
|
21
|
-
locale,
|
|
22
|
-
}),
|
|
18
|
+
const search = useStaticSearch({
|
|
19
|
+
locale,
|
|
23
20
|
});
|
|
24
21
|
|
|
25
22
|
return (
|
|
26
|
-
<SearchDialog
|
|
23
|
+
<SearchDialog {...search} {...props}>
|
|
27
24
|
<SearchDialogOverlay />
|
|
28
25
|
<SearchDialogContent>
|
|
29
26
|
<SearchDialogHeader>
|
|
@@ -31,7 +28,7 @@ export default function DefaultSearchDialog(props: SharedProps) {
|
|
|
31
28
|
<SearchDialogInput />
|
|
32
29
|
<SearchDialogClose />
|
|
33
30
|
</SearchDialogHeader>
|
|
34
|
-
<SearchDialogList
|
|
31
|
+
<SearchDialogList />
|
|
35
32
|
</SearchDialogContent>
|
|
36
33
|
</SearchDialog>
|
|
37
34
|
);
|
|
@@ -19,3 +19,11 @@ export function getPageMarkdownUrl(page: { slugs: string[]; locale?: string }) {
|
|
|
19
19
|
|
|
20
20
|
return { segments, url: getContentUrl(segments, page.locale) };
|
|
21
21
|
}
|
|
22
|
+
|
|
23
|
+
const getImageUrl = createGetUrl(docsImageRoute);
|
|
24
|
+
|
|
25
|
+
export function getPageImageUrl(page: { slugs: string[]; locale?: string }) {
|
|
26
|
+
const segments = [...page.slugs, 'image.webp'];
|
|
27
|
+
|
|
28
|
+
return { segments, url: getImageUrl(segments, page.locale) };
|
|
29
|
+
}
|
|
@@ -13,7 +13,7 @@ import { baseOptions } from '@/lib/layout.shared';
|
|
|
13
13
|
import { useFumadocsLoader } from 'fumadocs-core/source/client';
|
|
14
14
|
import { useMDXComponents } from '@/components/mdx';
|
|
15
15
|
import { use } from 'react';
|
|
16
|
-
import { getPageMarkdownUrl, gitConfig } from '@/lib/shared';
|
|
16
|
+
import { getPageImageUrl, getPageMarkdownUrl, gitConfig } from '@/lib/shared';
|
|
17
17
|
|
|
18
18
|
export async function loader({ params }: Route.LoaderArgs) {
|
|
19
19
|
const slugs = params['*'].split('/').filter((v) => v.length > 0);
|
|
@@ -24,10 +24,19 @@ export async function loader({ params }: Route.LoaderArgs) {
|
|
|
24
24
|
path: page.path,
|
|
25
25
|
markdownUrl: getPageMarkdownUrl(page).url,
|
|
26
26
|
pageTree: await source.serializePageTree(source.getPageTree()),
|
|
27
|
+
imagePath: getPageImageUrl(page).url,
|
|
27
28
|
};
|
|
28
29
|
}
|
|
29
30
|
|
|
30
|
-
function Content({
|
|
31
|
+
function Content({
|
|
32
|
+
path,
|
|
33
|
+
markdownUrl,
|
|
34
|
+
imagePath,
|
|
35
|
+
}: {
|
|
36
|
+
path: string;
|
|
37
|
+
markdownUrl: string;
|
|
38
|
+
imagePath: string;
|
|
39
|
+
}) {
|
|
31
40
|
const page = docs.getPage(path);
|
|
32
41
|
if (!page) throw new Error(`unknown page: ${path}`);
|
|
33
42
|
|
|
@@ -39,6 +48,7 @@ function Content({ path, markdownUrl }: { path: string; markdownUrl: string }) {
|
|
|
39
48
|
<DocsPage toc={toc}>
|
|
40
49
|
<title>{page.title}</title>
|
|
41
50
|
<meta name="description" content={page.description} />
|
|
51
|
+
<meta property="og:image" content={imagePath} />
|
|
42
52
|
<DocsTitle>{page.title}</DocsTitle>
|
|
43
53
|
<DocsDescription>{page.description}</DocsDescription>
|
|
44
54
|
<div className="flex flex-row gap-2 items-center border-b -mt-4 pb-6">
|
|
@@ -56,11 +66,11 @@ function Content({ path, markdownUrl }: { path: string; markdownUrl: string }) {
|
|
|
56
66
|
}
|
|
57
67
|
|
|
58
68
|
export default function Page({ loaderData }: Route.ComponentProps) {
|
|
59
|
-
const { pageTree, path, markdownUrl } = useFumadocsLoader(loaderData);
|
|
69
|
+
const { pageTree, path, markdownUrl, imagePath } = useFumadocsLoader(loaderData);
|
|
60
70
|
|
|
61
71
|
return (
|
|
62
72
|
<DocsLayout {...baseOptions()} tree={pageTree}>
|
|
63
|
-
<Content path={path} markdownUrl={markdownUrl} />
|
|
73
|
+
<Content path={path} markdownUrl={markdownUrl} imagePath={imagePath} />
|
|
64
74
|
</DocsLayout>
|
|
65
75
|
);
|
|
66
76
|
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { Route } from './+types/og.docs';
|
|
2
|
+
import { generateOGImage } from 'fumadocs-ui/og/takumi';
|
|
3
|
+
import { source } from '@/lib/source';
|
|
4
|
+
import { appName } from '@/lib/shared';
|
|
5
|
+
|
|
6
|
+
export function loader({ params }: Route.LoaderArgs) {
|
|
7
|
+
const slugs = params['*']
|
|
8
|
+
.split('/')
|
|
9
|
+
.filter((v) => v.length > 0)
|
|
10
|
+
.slice(0, -1);
|
|
11
|
+
const page = source.getPage(slugs);
|
|
12
|
+
|
|
13
|
+
if (!page) throw new Response(undefined, { status: 404 });
|
|
14
|
+
|
|
15
|
+
return generateOGImage({
|
|
16
|
+
title: page.data.title,
|
|
17
|
+
description: page.data.description,
|
|
18
|
+
site: appName,
|
|
19
|
+
format: 'webp',
|
|
20
|
+
});
|
|
21
|
+
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { Config } from '@react-router/dev/config';
|
|
2
2
|
import { glob } from 'node:fs/promises';
|
|
3
3
|
import { createGetUrl, getSlugs } from 'fumadocs-core/source';
|
|
4
|
+
import { getPageImageUrl } from './app/lib/shared';
|
|
4
5
|
|
|
5
6
|
const getUrl = createGetUrl('/docs');
|
|
6
7
|
|
|
@@ -16,7 +17,11 @@ export default {
|
|
|
16
17
|
|
|
17
18
|
for await (const entry of glob('**/*.mdx', { cwd: 'content/docs' })) {
|
|
18
19
|
const slugs = getSlugs(entry);
|
|
19
|
-
paths.push(
|
|
20
|
+
paths.push(
|
|
21
|
+
getUrl(slugs),
|
|
22
|
+
getPageImageUrl({ slugs }).url,
|
|
23
|
+
`/llms.mdx/docs/${[...slugs, 'content.md'].join('/')}`,
|
|
24
|
+
);
|
|
20
25
|
}
|
|
21
26
|
|
|
22
27
|
return paths;
|
|
@@ -33,3 +33,11 @@ export function decodeMarkdownUrl(segments: string[]) {
|
|
|
33
33
|
if (out.length === 1 && out[0] === 'index') out.pop();
|
|
34
34
|
return out;
|
|
35
35
|
}
|
|
36
|
+
|
|
37
|
+
const getImageUrl = createGetUrl(docsImageRoute);
|
|
38
|
+
|
|
39
|
+
export function getPageImageUrl(page: { slugs: string[]; locale?: string }) {
|
|
40
|
+
const segments = [...page.slugs, 'image.webp'];
|
|
41
|
+
|
|
42
|
+
return { segments, url: getImageUrl(segments, page.locale) };
|
|
43
|
+
}
|
|
@@ -11,7 +11,7 @@ import {
|
|
|
11
11
|
ViewOptionsPopover,
|
|
12
12
|
} from 'fumadocs-ui/layouts/docs/page';
|
|
13
13
|
import { baseOptions } from '@/lib/layout.shared';
|
|
14
|
-
import { getPageMarkdownUrl, gitConfig } from '@/lib/shared';
|
|
14
|
+
import { getPageImageUrl, getPageMarkdownUrl, gitConfig } from '@/lib/shared';
|
|
15
15
|
import { useFumadocsLoader } from 'fumadocs-core/source/client';
|
|
16
16
|
import { Suspense, use } from 'react';
|
|
17
17
|
import { useMDXComponents } from '@/components/mdx';
|
|
@@ -24,6 +24,9 @@ export const Route = createFileRoute('/docs/$')({
|
|
|
24
24
|
await docs.getPage(data.path)?.preload();
|
|
25
25
|
return data;
|
|
26
26
|
},
|
|
27
|
+
head: ({ loaderData }) => ({
|
|
28
|
+
meta: loaderData ? [{ property: 'og:image', content: loaderData.imageUrl }] : [],
|
|
29
|
+
}),
|
|
27
30
|
});
|
|
28
31
|
|
|
29
32
|
const serverLoader = createServerFn({
|
|
@@ -37,6 +40,7 @@ const serverLoader = createServerFn({
|
|
|
37
40
|
return {
|
|
38
41
|
path: page.path,
|
|
39
42
|
markdownUrl: getPageMarkdownUrl(page).url,
|
|
43
|
+
imageUrl: getPageImageUrl(page).url,
|
|
40
44
|
pageTree: await source.serializePageTree(source.getPageTree()),
|
|
41
45
|
};
|
|
42
46
|
});
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { createFileRoute } from '@tanstack/react-router';
|
|
2
|
+
import { generateOGImage } from 'fumadocs-ui/og/takumi';
|
|
3
|
+
import { source } from '@/lib/source';
|
|
4
|
+
import { appName } from '@/lib/shared';
|
|
5
|
+
|
|
6
|
+
export const Route = createFileRoute('/og/docs/$')({
|
|
7
|
+
server: {
|
|
8
|
+
handlers: {
|
|
9
|
+
GET: ({ params }) => {
|
|
10
|
+
const slugs = (params._splat?.split('/') ?? []).filter((v) => v.length > 0).slice(0, -1);
|
|
11
|
+
const page = source.getPage(slugs);
|
|
12
|
+
if (!page) return new Response(undefined, { status: 404 });
|
|
13
|
+
|
|
14
|
+
return generateOGImage({
|
|
15
|
+
title: page.data.title,
|
|
16
|
+
description: page.data.description,
|
|
17
|
+
site: appName,
|
|
18
|
+
format: 'webp',
|
|
19
|
+
});
|
|
20
|
+
},
|
|
21
|
+
},
|
|
22
|
+
},
|
|
23
|
+
});
|
|
@@ -10,20 +10,17 @@ import {
|
|
|
10
10
|
SearchDialogOverlay,
|
|
11
11
|
type SharedProps,
|
|
12
12
|
} from 'fumadocs-ui/components/dialog/search';
|
|
13
|
-
import {
|
|
14
|
-
import { staticClient } from 'fumadocs-core/search/client/orama-static';
|
|
13
|
+
import { useStaticSearch } from 'fumadocs-core/search/client';
|
|
15
14
|
import { useI18n } from 'fumadocs-ui/contexts/i18n';
|
|
16
15
|
|
|
17
16
|
export default function DefaultSearchDialog(props: SharedProps) {
|
|
18
17
|
const { locale } = useI18n(); // (optional) for i18n
|
|
19
|
-
const
|
|
20
|
-
|
|
21
|
-
locale,
|
|
22
|
-
}),
|
|
18
|
+
const search = useStaticSearch({
|
|
19
|
+
locale,
|
|
23
20
|
});
|
|
24
21
|
|
|
25
22
|
return (
|
|
26
|
-
<SearchDialog
|
|
23
|
+
<SearchDialog {...search} {...props}>
|
|
27
24
|
<SearchDialogOverlay />
|
|
28
25
|
<SearchDialogContent>
|
|
29
26
|
<SearchDialogHeader>
|
|
@@ -31,7 +28,7 @@ export default function DefaultSearchDialog(props: SharedProps) {
|
|
|
31
28
|
<SearchDialogInput />
|
|
32
29
|
<SearchDialogClose />
|
|
33
30
|
</SearchDialogHeader>
|
|
34
|
-
<SearchDialogList
|
|
31
|
+
<SearchDialogList />
|
|
35
32
|
</SearchDialogContent>
|
|
36
33
|
</SearchDialog>
|
|
37
34
|
);
|
|
@@ -33,3 +33,11 @@ export function decodeMarkdownUrl(segments: string[]) {
|
|
|
33
33
|
if (out.length === 1 && out[0] === 'index') out.pop();
|
|
34
34
|
return out;
|
|
35
35
|
}
|
|
36
|
+
|
|
37
|
+
const getImageUrl = createGetUrl(docsImageRoute);
|
|
38
|
+
|
|
39
|
+
export function getPageImageUrl(page: { slugs: string[]; locale?: string }) {
|
|
40
|
+
const segments = [...page.slugs, 'image.webp'];
|
|
41
|
+
|
|
42
|
+
return { segments, url: getImageUrl(segments, page.locale) };
|
|
43
|
+
}
|
|
@@ -11,7 +11,7 @@ import {
|
|
|
11
11
|
ViewOptionsPopover,
|
|
12
12
|
} from 'fumadocs-ui/layouts/docs/page';
|
|
13
13
|
import { baseOptions } from '@/lib/layout.shared';
|
|
14
|
-
import { getPageMarkdownUrl, gitConfig } from '@/lib/shared';
|
|
14
|
+
import { getPageImageUrl, getPageMarkdownUrl, gitConfig } from '@/lib/shared';
|
|
15
15
|
import { staticFunctionMiddleware } from '@tanstack/start-static-server-functions';
|
|
16
16
|
import { useFumadocsLoader } from 'fumadocs-core/source/client';
|
|
17
17
|
import { Suspense, use } from 'react';
|
|
@@ -25,6 +25,9 @@ export const Route = createFileRoute('/docs/$')({
|
|
|
25
25
|
await docs.getPage(data.path)?.preload();
|
|
26
26
|
return data;
|
|
27
27
|
},
|
|
28
|
+
head: ({ loaderData }) => ({
|
|
29
|
+
meta: loaderData ? [{ property: 'og:image', content: loaderData.imageUrl }] : [],
|
|
30
|
+
}),
|
|
28
31
|
});
|
|
29
32
|
|
|
30
33
|
const loader = createServerFn({
|
|
@@ -39,6 +42,7 @@ const loader = createServerFn({
|
|
|
39
42
|
return {
|
|
40
43
|
path: page.path,
|
|
41
44
|
markdownUrl: getPageMarkdownUrl(page).url,
|
|
45
|
+
imageUrl: getPageImageUrl(page).url,
|
|
42
46
|
pageTree: await source.serializePageTree(source.getPageTree()),
|
|
43
47
|
};
|
|
44
48
|
});
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { createFileRoute } from '@tanstack/react-router';
|
|
2
|
+
import { generateOGImage } from 'fumadocs-ui/og/takumi';
|
|
3
|
+
import { source } from '@/lib/source';
|
|
4
|
+
import { appName } from '@/lib/shared';
|
|
5
|
+
|
|
6
|
+
export const Route = createFileRoute('/og/docs/$')({
|
|
7
|
+
server: {
|
|
8
|
+
handlers: {
|
|
9
|
+
GET: ({ params }) => {
|
|
10
|
+
const slugs = (params._splat?.split('/') ?? []).filter((v) => v.length > 0).slice(0, -1);
|
|
11
|
+
const page = source.getPage(slugs);
|
|
12
|
+
if (!page) return new Response(undefined, { status: 404 });
|
|
13
|
+
|
|
14
|
+
return generateOGImage({
|
|
15
|
+
title: page.data.title,
|
|
16
|
+
description: page.data.description,
|
|
17
|
+
site: appName,
|
|
18
|
+
format: 'webp',
|
|
19
|
+
});
|
|
20
|
+
},
|
|
21
|
+
},
|
|
22
|
+
},
|
|
23
|
+
});
|
|
@@ -4,6 +4,14 @@ import { defineConfig } from 'vite';
|
|
|
4
4
|
import tailwindcss from '@tailwindcss/vite';
|
|
5
5
|
import { fumadocsMdx } from 'fumadocs-mdx/vite';
|
|
6
6
|
import { nitro } from 'nitro/vite';
|
|
7
|
+
import { glob } from 'node:fs/promises';
|
|
8
|
+
import { getSlugs } from 'fumadocs-core/source';
|
|
9
|
+
import { getPageImageUrl } from './src/lib/shared';
|
|
10
|
+
|
|
11
|
+
const imageRoutes: string[] = [];
|
|
12
|
+
for await (const entry of glob('**/*.mdx', { cwd: 'content/docs' })) {
|
|
13
|
+
imageRoutes.push(getPageImageUrl({ slugs: getSlugs(entry) }).url);
|
|
14
|
+
}
|
|
7
15
|
|
|
8
16
|
export default defineConfig({
|
|
9
17
|
server: {
|
|
@@ -38,7 +46,10 @@ export default defineConfig({
|
|
|
38
46
|
}),
|
|
39
47
|
react(),
|
|
40
48
|
// please see https://tanstack.com/start/latest/docs/framework/react/guide/hosting#nitro for guides on hosting
|
|
41
|
-
nitro(
|
|
49
|
+
nitro({
|
|
50
|
+
// TanStack Start pre-renders responses as text, which breaks images
|
|
51
|
+
prerender: { routes: imageRoutes },
|
|
52
|
+
}),
|
|
42
53
|
],
|
|
43
54
|
resolve: {
|
|
44
55
|
tsconfigPaths: true,
|