Update pnpm-lock.yaml and package.json to include fast-glob; refactor CLI commands for improved error handling and project info retrieval

Author: eluce2

packages/cli/package.json

@@ -69,6 +69,7 @@
     "dotenv": "^16.5.0",
     "es-toolkit": "^1.15.1",
     "execa": "^9.5.1",
+    "fast-glob": "^3.3.3",
     "fs-extra": "^11.3.0",
     "glob": "^11.0.1",
     "gradient-string": "^2.0.2",

packages/cli/src/cli/add/index.ts

@@ -17,21 +17,22 @@ import {
 } from "./data-source/index.js";
 import { makeAddSchemaCommand, runAddSchemaAction } from "./fmschema.js";
 import { makeAddPageCommand, runAddPageAction } from "./page/index.js";
-import { getMetaFromRegistry } from "./registry/getOptions.js";
 import { installFromRegistry } from "./registry/install.js";
 
 export const runAdd = async (
   name: string | undefined,
   options?: { noInstall?: boolean }
 ) => {
-  const settings = getSettings();
-
+  
   if (name === "tanstack-query") {
     return await runAddTanstackQueryCommand();
   } else if (name !== undefined) {
     // an arbitrary name was provided, so we'll try to install from the registry
     return await installFromRegistry(name);
   }
+  
+   ensureProofKitProject({ commandName: "add" });
+  const settings = getSettings();
 
   const addType = abortIfCancel(
     await p.select({
@@ -99,13 +100,11 @@ export const makeAddCommand = () => {
     // console.log("preAction", _actionCommand.opts());
     initProgramState(_actionCommand.opts());
     state.baseCommand = "add";
-    ensureProofKitProject({ commandName: "add" });
   });
   addCommand.hook("preSubcommand", (_thisCommand, _subCommand) => {
     // console.log("preSubcommand", _subCommand.opts());
     initProgramState(_subCommand.opts());
     state.baseCommand = "add";
-    ensureProofKitProject({ commandName: "add" });
   });
 
   addCommand.addCommand(makeAddAuthCommand());

packages/cli/src/cli/add/registry/getOptions.ts

@@ -1,4 +1,9 @@
+
 import { registryFetch } from "./http.js";
+import fs from "fs-extra";
+import fg from "fast-glob"
+import path from "path";
+import { state } from "~/state.js";
 
 export async function getMetaFromRegistry(name: string) {
   const result = await registryFetch("@get/meta/:name", {
@@ -10,3 +15,39 @@ export async function getMetaFromRegistry(name: string) {
   }
   return result.data;
 }
+
+const PROJECT_SHARED_IGNORE = [
+  "**/node_modules/**",
+  ".next",
+  "public",
+  "dist",
+  "build",
+]
+
+export async function getProjectInfo() {
+  const cwd = state.projectDir || process.cwd();
+  const [configFiles, isSrcDir] = await Promise.all([
+   fg.glob(
+    "**/{next,vite,astro,app}.config.*|gatsby-config.*|composer.json|react-router.config.*",
+    {
+      cwd,
+      deep: 3,
+      ignore: PROJECT_SHARED_IGNORE,
+    }
+  ),
+    fs.pathExists(path.resolve(cwd, "src"))
+  ])
+  
+
+const isUsingAppDir = await fs.pathExists(
+  path.resolve(cwd, `${isSrcDir ? "src/" : ""}app`)
+)
+
+
+// Next.js.
+if (configFiles.find((file) => file.startsWith("next.config."))?.length) {
+  return isUsingAppDir ? "next-app" : "next-pages"
+}
+
+return "manual"
+}

packages/cli/src/cli/add/registry/install.ts

@@ -1,29 +1,40 @@
 import { getOtherProofKitDependencies } from "@proofkit/registry";
 import semver from "semver";
+import ora from "ora";
 
 import { getRegistryUrl, shadcnInstall } from "~/helpers/shadcn-cli.js";
 import { getVersion } from "~/utils/getProofKitVersion.js";
 import { logger } from "~/utils/logger.js";
 import { getSettings, mergeSettings } from "~/utils/parseSettings.js";
 import { getMetaFromRegistry } from "./getOptions.js";
 import { processPostInstallStep } from "./postInstall/index.js";
+import { preflightAddCommand } from "./preflight.js";
+import { uniq } from "es-toolkit";
 
 export async function installFromRegistry(name: string) {
-  const meta = await getMetaFromRegistry(name);
-  if (!meta) {
-    logger.error(`Template ${name} not found in the ProofKit registry`);
-    return;
-  }
-
-  if (
-    meta.minimumProofKitVersion &&
-    semver.gt(meta.minimumProofKitVersion, getVersion())
-  ) {
-    logger.error(
-      `Template ${name} requires ProofKit version ${meta.minimumProofKitVersion}, but you are using version ${getVersion()}`
-    );
-    return;
-  }
+  
+  const spinner = ora("Validating template").start();
+  await preflightAddCommand();
+  
+  try {
+    const meta = await getMetaFromRegistry(name);
+    if (!meta) {
+      spinner.fail(`Template ${name} not found in the ProofKit registry`);
+      return;
+    }
+    
+    
+    if (
+      meta.minimumProofKitVersion &&
+      semver.gt(meta.minimumProofKitVersion, getVersion())
+    ) {
+      logger.error(
+        `Template ${name} requires ProofKit version ${meta.minimumProofKitVersion}, but you are using version ${getVersion()}`
+      );
+      spinner.fail("Template is not compatible with your ProofKit version");
+      return;
+    }
+    spinner.succeed();
 
   const otherProofKitDependencies = getOtherProofKitDependencies(meta);
 
@@ -55,10 +66,14 @@ export async function installFromRegistry(name: string) {
 
   // update the settings
   mergeSettings({
-    registryTemplates: [
+    registryTemplates: uniq([
       ...previouslyInstalledTemplates,
       name,
       ...otherProofKitDependencies,
-    ],
+    ]),
   });
+  } catch (error) {
+    spinner.fail("Failed to fetch template metadata.");
+    logger.error(error);
+  }
 }

packages/cli/src/cli/add/registry/preflight.ts

@@ -0,0 +1,8 @@
+import { stealthInit } from "~/helpers/stealth-init.js";
+
+export async function preflightAddCommand() {
+    // make sure shadcn is installed, throw if not
+
+    // if proofkit is not inited, try to stealth init
+    await stealthInit();    
+}

packages/cli/src/cli/init.ts

@@ -309,7 +309,7 @@ export const runInit = async (name?: string, opts?: CliFlags) => {
 
   if (state.ui === "shadcn") {
     await shadcnInstall([
-      `${getRegistryUrl()}/r/mode-toggle`,
+      `${getRegistryUrl()}/r/components/mode-toggle`,
       "sonner",
       "button",
     ]);

packages/cli/src/helpers/shadcn-cli.ts

@@ -6,19 +6,25 @@ import { state } from "~/state.js";
 import { logger } from "~/utils/logger.js";
 import { getSettings } from "~/utils/parseSettings.js";
 import { runExecCommand } from "./installDependencies.js";
+import { execa } from "execa";
 
 export async function shadcnInstall(
   components: string | string[],
   friendlyComponentName?: string
 ) {
   const componentsArray = Array.isArray(components) ? components : [components];
-  const command = ["shadcn@latest", "add", "--overwrite", ...componentsArray];
-  await runExecCommand({
-    command,
-    loadingMessage: `Installing ${friendlyComponentName ?? "components"}...`,
-    successMessage: `${friendlyComponentName ?? "Components"} installed successfully!`,
-    errorMessage: `Failed to install ${friendlyComponentName ?? "components"}`,
-  });
+  const command = ["shadcn@latest", "add", ...componentsArray, "--overwrite"];
+  // Use execa to run the shadcn add command directly
+  
+  try {
+    await execa("pnpm", ["dlx", ...command], {
+      stdio: "inherit",
+      cwd: process.cwd(),
+    });
+  } catch (error) {
+    logger.error(`Failed to run shadcn add: ${error}`);
+    throw error;
+  }
 }
 
 export function getRegistryUrl(): string {

packages/cli/src/helpers/stealth-init.ts

@@ -0,0 +1,25 @@
+
+
+
+
+
+
+import fs from "fs-extra";
+import { defaultSettings } from "~/utils/parseSettings.js";
+
+
+/**
+ * Used to add a proofkit.json file to an existing project
+ */
+export async function stealthInit() {
+    // check if proofkit.json exists
+    const proofkitJson = await fs.pathExists("proofkit.json");
+    if (proofkitJson) {
+        return;
+    }
+
+    // create proofkit.json
+    await fs.writeJson("proofkit.json", defaultSettings
+        
+    );
+}

packages/registry/lib/types.ts

@@ -29,7 +29,7 @@ export const templateFileSchema = z.discriminatedUnion("type", [
     // The name of the file within this template directory
     sourceFileName: z.string(),
     // The destination path in a consumer project, relative to project root
-    destinationPath: z.string(),
+    destinationPath: z.string().optional(),
     type: registryTypeSchema.extract(["registry:file", "registry:page"]),
   }),
   z.object({
@@ -103,6 +103,8 @@ const categorySchema = z.enum([
   "email",
 ]);
 
+export const frameworkSchema = z.enum(["next-pages", "next-app", "manual"]);
+
 const sharedMetadataSchema = registryItemSchema
   .omit({ name: true, type: true, files: true })
   .extend({
@@ -121,6 +123,7 @@ const sharedMetadataSchema = registryItemSchema
       .string()
       .describe("The minimum version of ProofKit required to use this template")
       .optional(),
+    allowedFrameworks: z.array(frameworkSchema).optional(),
   });
 
 // Defines the metadata for a single template (_meta.ts)

packages/registry/lib/utils.ts

@@ -185,13 +185,13 @@ export async function getStaticComponent(
               path: file.sourceFileName,
               type: file.type,
               content,
-              target: file.destinationPath,
+              target: file.destinationPath ?? file.sourceFileName,
             }
           : {
               path: file.sourceFileName,
               type: file.type,
               content,
-              target: file.destinationPath ?? "",
+              target: file.destinationPath ?? file.sourceFileName,
             };
 
       return shadcnFile;