create-ardo 2.5.0 → 2.7.0

package/dist/index.js

@@ -36,9 +36,7 @@ function createProjectStructure(root, template, options) {
     GITHUB_PAGES_BASENAME: options.githubPages ? "basename: detectGitHubBasename()," : "// basename: detectGitHubBasename(), // Uncomment for GitHub Pages",
     DESCRIPTION: options.description,
     TYPEDOC_NAV: options.typedoc ? "{ text: 'API', link: '/api-reference' }," : "",
-    TYPEDOC_SIDEBAR: options.typedoc ? "{ text: 'API Reference', link: '/api-reference' }," : "",
-    TYPEDOC_NAVLINK: options.typedoc ? '<NavLink to="/api-reference">API</NavLink>' : "",
-    TYPEDOC_SIDEBARLINK: options.typedoc ? '<SidebarLink to="/api-reference">API Reference</SidebarLink>' : ""
+    TYPEDOC_SIDEBAR: options.typedoc ? "{ text: 'API Reference', link: '/api-reference' }," : ""
   };
   copyDir(templateDir, root, vars);
 }
@@ -93,9 +91,76 @@ function detectProjectDescription(targetDir) {
   }
   return void 0;
 }
+function isArdoProject(dir) {
+  try {
+    const pkgPath = path.join(dir, "package.json");
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
+    return Boolean(pkg.dependencies?.ardo);
+  } catch {
+    return false;
+  }
+}
+function upgradeProject(root) {
+  const templateDir = path.join(templatesRoot, "minimal");
+  const cliVersion = getCliVersion();
+  const result = { updated: [], deleted: [], skipped: [] };
+  const skeletonFiles = [
+    "app/entry.client.tsx",
+    "app/entry.server.tsx",
+    "app/root.tsx",
+    "tsconfig.json"
+  ];
+  for (const file of skeletonFiles) {
+    const src = path.join(templateDir, file);
+    const dest = path.join(root, file);
+    if (fs.existsSync(src)) {
+      fs.mkdirSync(path.dirname(dest), { recursive: true });
+      fs.copyFileSync(src, dest);
+      result.updated.push(file);
+    } else {
+      result.skipped.push(file);
+    }
+  }
+  const userPkgPath = path.join(root, "package.json");
+  const templatePkgPath = path.join(templateDir, "package.json");
+  const userPkg = JSON.parse(fs.readFileSync(userPkgPath, "utf-8"));
+  const templatePkg = JSON.parse(fs.readFileSync(templatePkgPath, "utf-8"));
+  if (userPkg.dependencies) {
+    userPkg.dependencies.ardo = `^${cliVersion}`;
+  }
+  for (const [dep, version] of Object.entries(
+    templatePkg.dependencies || {}
+  )) {
+    if (dep === "ardo") continue;
+    if (!userPkg.dependencies?.[dep]) {
+      userPkg.dependencies = userPkg.dependencies || {};
+      userPkg.dependencies[dep] = version;
+    }
+  }
+  for (const [dep, version] of Object.entries(
+    templatePkg.devDependencies || {}
+  )) {
+    userPkg.devDependencies = userPkg.devDependencies || {};
+    userPkg.devDependencies[dep] = version;
+  }
+  fs.writeFileSync(userPkgPath, JSON.stringify(userPkg, null, 2) + "\n");
+  result.updated.push("package.json");
+  const obsoleteFiles = ["app/vite-env.d.ts"];
+  for (const file of obsoleteFiles) {
+    const filePath = path.join(root, file);
+    if (fs.existsSync(filePath)) {
+      fs.unlinkSync(filePath);
+      result.deleted.push(file);
+    }
+  }
+  return result;
+}
 
 // src/index.ts
 var defaultTargetDir = "my-docs";
+var onCancel = () => {
+  throw new Error(red("\u2716") + " Operation cancelled");
+};
 async function main() {
   console.log();
   console.log(`  ${cyan("\u25C6")} ${green("create-ardo")}`);
@@ -103,11 +168,10 @@ async function main() {
   const argTargetDir = process.argv[2];
   const argTemplate = process.argv[3];
   let targetDir = argTargetDir || defaultTargetDir;
-  let template = argTemplate;
-  const response = await prompts(
-    [
+  if (!argTargetDir) {
+    const { projectName } = await prompts(
       {
-        type: argTargetDir ? null : "text",
+        type: "text",
         name: "projectName",
         message: reset("Project name:"),
         initial: defaultTargetDir,
@@ -118,13 +182,55 @@ async function main() {
           if (!/^[a-z0-9-]+$/.test(name))
             return "Project name may only contain lowercase letters, digits, and hyphens";
           return true;
-        },
-        onState: (state) => {
-          targetDir = formatTargetDir(state.value) || defaultTargetDir;
         }
       },
+      { onCancel }
+    );
+    targetDir = formatTargetDir(projectName) || defaultTargetDir;
+  }
+  const root = path2.join(process.cwd(), targetDir);
+  if (fs2.existsSync(root) && !isEmpty(root) && isArdoProject(root)) {
+    const cliVersion = getCliVersion();
+    const { action } = await prompts(
+      {
+        type: "select",
+        name: "action",
+        message: `Existing Ardo project detected. Upgrade to v${cliVersion}?`,
+        choices: [
+          { title: "Upgrade framework files", value: "upgrade" },
+          { title: "Cancel", value: "cancel" }
+        ]
+      },
+      { onCancel }
+    );
+    if (action === "cancel") {
+      throw new Error(red("\u2716") + " Operation cancelled");
+    }
+    console.log();
+    console.log(`  ${cyan("Upgrading project in")} ${root}...`);
+    console.log();
+    const result = upgradeProject(root);
+    for (const file of result.updated) {
+      console.log(`  ${green("\u25CF")} ${file}`);
+    }
+    for (const file of result.deleted) {
+      console.log(`  ${yellow("\u25CF")} ${file} ${dim("(removed)")}`);
+    }
+    for (const file of result.skipped) {
+      console.log(`  ${dim("\u25CB")} ${file} ${dim("(not found, skipped)")}`);
+    }
+    console.log();
+    console.log(`  ${green("Done!")} Now run:`);
+    console.log();
+    console.log(`  ${blue("pnpm install")}`);
+    console.log();
+    return;
+  }
+  let template = argTemplate;
+  const response = await prompts(
+    [
       {
-        type: () => !fs2.existsSync(targetDir) || isEmpty(targetDir) ? null : "select",
+        type: () => !fs2.existsSync(root) || isEmpty(root) ? null : "select",
         name: "overwrite",
         message: () => `${targetDir === "." ? "Current directory" : `Target directory "${targetDir}"`} is not empty. How would you like to proceed?`,
         choices: [
@@ -188,15 +294,10 @@ async function main() {
         ]
       }
     ],
-    {
-      onCancel: () => {
-        throw new Error(red("\u2716") + " Operation cancelled");
-      }
-    }
+    { onCancel }
   );
   const { overwrite, template: templateChoice, siteTitle, docType, githubPages } = response;
   template = templateChoice || template || "minimal";
-  const root = path2.join(process.cwd(), targetDir);
   if (overwrite === "yes") {
     emptyDir(root);
   } else if (!fs2.existsSync(root)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-ardo",
-  "version": "2.5.0",
+  "version": "2.7.0",
   "description": "Scaffolding tool for Ardo documentation projects",
   "type": "module",
   "bin": {
@@ -24,7 +24,7 @@
     "url": "https://github.com/sebastian-software/ardo.git",
     "directory": "packages/create-ardo"
   },
-  "homepage": "https://sebastian-software.github.io/ardo/",
+  "homepage": "https://ardo-docs.dev",
   "bugs": {
     "url": "https://github.com/sebastian-software/ardo/issues"
   },

package/templates/minimal/app/root.tsx

@@ -1,84 +1,15 @@
-import { Links, Meta, Outlet, Scripts, ScrollRestoration, useLocation } from "react-router"
-import {
-  Layout as ArdoLayout,
-  Header,
-  Nav,
-  NavLink,
-  Sidebar,
-  SidebarGroup,
-  SidebarLink,
-  Footer,
-} from "ardo/ui"
-import { PressProvider } from "ardo/runtime"
+import { RootLayout, ArdoRoot } from "ardo/ui"
 import config from "virtual:ardo/config"
 import sidebar from "virtual:ardo/sidebar"
+import type { MetaFunction } from "react-router"
 import "ardo/ui/styles.css"
 
+export const meta: MetaFunction = () => [{ title: config.title }]
+
 export function Layout({ children }: { children: React.ReactNode }) {
-  return (
-    <html lang="en" suppressHydrationWarning>
-      <head>
-        <meta charSet="utf-8" />
-        <meta name="viewport" content="width=device-width, initial-scale=1" />
-        <Meta />
-        <Links />
-      </head>
-      <body suppressHydrationWarning>
-        {children}
-        <ScrollRestoration />
-        <Scripts />
-      </body>
-    </html>
-  )
+  return <RootLayout>{children}</RootLayout>
 }
 
 export default function Root() {
-  const location = useLocation()
-  const isHomePage = location.pathname === "/"
-
-  return (
-    <PressProvider config={config} sidebar={sidebar}>
-      <ArdoLayout
-        className={isHomePage ? "ardo-layout ardo-home" : "ardo-layout"}
-        header={
-          <Header
-            title="{{SITE_TITLE}}"
-            nav={
-              <Nav>
-                <NavLink to="/guide/getting-started">Guide</NavLink>
-                {{TYPEDOC_NAVLINK}}
-              </Nav>
-            }
-          />
-        }
-        sidebar={
-          isHomePage ? undefined : (
-            <Sidebar>
-              <SidebarGroup title="Guide">
-                <SidebarLink to="/guide/getting-started">Getting Started</SidebarLink>
-              </SidebarGroup>
-              {{TYPEDOC_SIDEBARLINK}}
-            </Sidebar>
-          )
-        }
-        footer={
-          <Footer
-            message={[
-              config.project?.homepage
-                ? `<a href="${config.project.homepage}">${config.title}</a>`
-                : config.title,
-              "Built with <a href='https://github.com/sebastian-software/ardo'>Ardo</a>",
-            ].join(" &middot; ")}
-            copyright={
-              config.project?.author
-                ? `Copyright &copy; ${new Date().getFullYear()} ${config.project.author}`
-                : undefined
-            }
-          />
-        }
-      >
-        <Outlet />
-      </ArdoLayout>
-    </PressProvider>
-  )
+  return <ArdoRoot config={config} sidebar={sidebar} />
 }

package/templates/minimal/app/routes/guide/getting-started.mdx

@@ -34,5 +34,5 @@ Edit `vite.config.ts` to customize your site:
 
 ## Learn More
 
-- [Ardo Documentation](https://sebastian-software.github.io/ardo/)
+- [Ardo Documentation](https://ardo-docs.dev)
 - [GitHub Repository](https://github.com/sebastian-software/ardo)

package/templates/minimal/app/routes/home.tsx

@@ -1,5 +1,10 @@
 import { Hero, Features } from "ardo/ui"
 import { Zap, Sparkles, Palette, ArrowRight, Github } from "ardo/icons"
+import type { MetaFunction } from "react-router"
+
+export const meta: MetaFunction = () => [
+  { title: "{{SITE_TITLE}}" },
+]
 
 export default function HomePage() {
   return (

package/templates/minimal/tsconfig.json

@@ -11,7 +11,8 @@
     "esModuleInterop": true,
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
-    "jsx": "react-jsx"
+    "jsx": "react-jsx",
+    "types": ["vite/client", "ardo/virtual"]
   },
   "include": ["app/**/*", "*.ts", "*.config.ts"],
   "exclude": ["node_modules", "build"]

package/templates/minimal/vite.config.ts

@@ -28,7 +28,7 @@ export default defineConfig({
         ],
 
         footer: {
-          message: 'Built with Ardo',
+          message: 'Released under the MIT License.',
         },
 
         search: {

package/templates/minimal/app/vite-env.d.ts

@@ -1,13 +0,0 @@
-/// <reference types="vite/client" />
-
-declare module "virtual:ardo/config" {
-  import type { PressConfig } from "ardo"
-  const config: PressConfig
-  export default config
-}
-
-declare module "virtual:ardo/sidebar" {
-  import type { SidebarItem } from "ardo"
-  const sidebar: SidebarItem[]
-  export default sidebar
-}