@angeloashmore/prismic-cli-poc 0.0.0-pr.6.9baab87 → 0.0.0-pr.8.b80fefa

package/src/status.ts

@@ -66,16 +66,53 @@ type NextStep = {
 	message: string;
 };
 
-function getDocsUrl(framework: Framework | undefined): string {
+function getDocsPath(framework: Framework | undefined): string {
 	switch (framework) {
 		case "next":
-			return "https://prismic.io/docs/nextjs/with-cli";
+			return "nextjs/with-cli";
 		case "nuxt":
-			return "https://prismic.io/docs/nuxt/with-cli";
+			return "nuxt/with-cli";
 		case "sveltekit":
-			return "https://prismic.io/docs/sveltekit/with-cli";
+			return "sveltekit/with-cli";
 		default:
-			return "https://prismic.io/docs";
+			return "";
+	}
+}
+
+function getDocsRef(docsPath: string, anchor?: string): string {
+	if (!docsPath) return "";
+	const fullPath = anchor ? `${docsPath}${anchor}` : docsPath;
+	return ` (run \`prismic docs ${fullPath}\`)`;
+}
+
+function getClientSetupAnchor(framework: Framework | undefined): string {
+	switch (framework) {
+		case "nuxt":
+			return "#configure-the-modules-prismic-client";
+		default:
+			return "#set-up-a-prismic-client";
+	}
+}
+
+function getPreviewSetupAnchor(framework: Framework | undefined): string {
+	switch (framework) {
+		case "next":
+			return "#set-up-previews-in-next-js";
+		case "sveltekit":
+			return "#set-up-previews-in-sveltekit";
+		default:
+			return "";
+	}
+}
+
+function getWriteComponentsAnchor(framework: Framework | undefined): string {
+	switch (framework) {
+		case "nuxt":
+			return "#write-vue-components";
+		case "sveltekit":
+			return "#write-svelte-components";
+		default:
+			return "#write-react-components";
 	}
 }
 
@@ -85,8 +122,9 @@ function computeNextStep(
 	typeStatuses: TypeWithStatus[],
 	sliceStatuses: TypeWithStatus[],
 	slicesWithMissingComponents: string[],
+	slicesReadyToConnect: string[],
 ): NextStep | undefined {
-	const docsUrl = getDocsUrl(frameworkInfo.framework);
+	const docsPath = getDocsPath(frameworkInfo.framework);
 
 	// 1. Setup - missing dependencies
 	const setupSection = sections.find((s) => s.title === "Setup");
@@ -99,7 +137,7 @@ function computeNextStep(
 	// 2. Setup - missing client file
 	const missingClientFile = setupSection?.items.find((i) => !i.done && i.hint?.includes("client"));
 	if (missingClientFile) {
-		return { message: `Create a ${missingClientFile.label} file (see ${docsUrl})` };
+		return { message: `Create a ${missingClientFile.label} file${getDocsRef(docsPath, getClientSetupAnchor(frameworkInfo.framework))}` };
 	}
 
 	// 3-7. Preview section (in order: local files, then remote config)
@@ -110,21 +148,21 @@ function computeNextStep(
 			(i) => i.label === "/slice-simulator route" && !i.done,
 		);
 		if (sliceSimRoute) {
-			return { message: `Create the /slice-simulator route (see ${docsUrl})` };
+			return { message: `Create the /slice-simulator route${getDocsRef(docsPath, "#set-up-live-previewing")}` };
 		}
 
 		const apiPreview = previewSection.items.find(
 			(i) => i.label === "/api/preview endpoint" && !i.done,
 		);
 		if (apiPreview) {
-			return { message: `Create the /api/preview route (see ${docsUrl})` };
+			return { message: `Create the /api/preview route${getDocsRef(docsPath, getPreviewSetupAnchor(frameworkInfo.framework))}` };
 		}
 
 		const exitPreview = previewSection.items.find(
 			(i) => i.label === "/api/exit-preview endpoint" && !i.done,
 		);
 		if (exitPreview) {
-			return { message: `Create the /api/exit-preview route (see ${docsUrl})` };
+			return { message: `Create the /api/exit-preview route${getDocsRef(docsPath, getPreviewSetupAnchor(frameworkInfo.framework))}` };
 		}
 
 		// Remote config
@@ -151,6 +189,15 @@ function computeNextStep(
 		return { message: `Pull remote models with 'prismic pull'` };
 	}
 
+	// 8.5 Slices ready to connect to a page type (before pushing)
+	if (slicesReadyToConnect.length > 0) {
+		const sorted = [...slicesReadyToConnect].sort();
+		const sliceName = sorted[0];
+		return {
+			message: `Connect ${sliceName} to a page type with 'prismic page-type connect-slice <type-id> ${sliceName}'`,
+		};
+	}
+
 	// 9. Models to push
 	const hasToPush =
 		typeStatuses.some((t) => t.status === "to_push") ||
@@ -166,7 +213,7 @@ function computeNextStep(
 		const slicesDir = getSlicesDirectory(frameworkInfo);
 		const ext = getSliceComponentExtensions(frameworkInfo.framework)[0];
 		const path = `${slicesDir}${sliceName}/index${ext}`;
-		return { message: `Implement the ${sliceName} slice component at ${path} (see ${docsUrl})` };
+		return { message: `Implement the ${sliceName} slice component at ${path}${getDocsRef(docsPath, getWriteComponentsAnchor(frameworkInfo.framework))}` };
 	}
 
 	// 11-12. Deployment (Next.js only)
@@ -176,7 +223,7 @@ function computeNextStep(
 			(i) => i.label === "/api/revalidate endpoint" && !i.done,
 		);
 		if (revalidateEndpoint) {
-			return { message: `Create the /api/revalidate route for ISR (see ${docsUrl})` };
+			return { message: `Create the /api/revalidate route for ISR${getDocsRef(docsPath, "#handle-content-changes")}` };
 		}
 
 		const webhook = deploymentSection.items.find(
@@ -261,6 +308,7 @@ export async function status(): Promise<void> {
 	let typeStatuses: TypeWithStatus[] = [];
 	let sliceStatuses: TypeWithStatus[] = [];
 	let slicesWithMissingComponents: string[] = [];
+	let slicesReadyToConnect: string[] = [];
 
 	// Setup section
 	const setupSection = await buildSetupSection(frameworkInfo, installedDeps);
@@ -283,10 +331,17 @@ export async function status(): Promise<void> {
 			section: slicesSection,
 			statuses,
 			missingComponents,
-		} = await buildSlicesSection(localSlicesResult.value, remoteSlicesResult.value, frameworkInfo);
+			slicesReadyToConnect: readyToConnect,
+		} = await buildSlicesSection(
+			localSlicesResult.value,
+			remoteSlicesResult.value,
+			frameworkInfo,
+			localTypesResult.ok ? localTypesResult.value : [],
+		);
 		sections.push(slicesSection);
 		sliceStatuses = statuses;
 		slicesWithMissingComponents = missingComponents;
+		slicesReadyToConnect = readyToConnect;
 	}
 
 	// Preview section
@@ -318,6 +373,7 @@ export async function status(): Promise<void> {
 		typeStatuses,
 		sliceStatuses,
 		slicesWithMissingComponents,
+		slicesReadyToConnect,
 	);
 	if (nextStep) {
 		console.info(`Next: ${nextStep.message}`);
@@ -554,23 +610,66 @@ function statusToHint(status: TypeStatus): string | undefined {
 }
 
 // Slices Section
+function sliceHasFields(slice: SharedSlice): boolean {
+	for (const variation of slice.variations) {
+		const primaryFields = Object.keys(variation.primary ?? {});
+		const itemFields = Object.keys(variation.items ?? {});
+		if (primaryFields.length > 0 || itemFields.length > 0) {
+			return true;
+		}
+	}
+	return false;
+}
+
+function isSliceConnectedToAnyType(sliceId: string, localTypes: CustomType[]): boolean {
+	for (const type of localTypes) {
+		for (const tabFields of Object.values(type.json)) {
+			for (const field of Object.values(tabFields as Record<string, unknown>)) {
+				const typedField = field as {
+					type?: string;
+					config?: { choices?: Record<string, unknown> };
+				};
+				if (typedField.type === "Slices" && typedField.config?.choices?.[sliceId]) {
+					return true;
+				}
+			}
+		}
+	}
+	return false;
+}
+
 async function buildSlicesSection(
 	localSlices: SharedSlice[],
 	remoteSlices: SharedSlice[],
 	info: FrameworkInfo,
+	localTypes: CustomType[],
 ): Promise<{
 	section: StatusSection;
 	statuses: TypeWithStatus[];
 	missingComponents: string[];
+	slicesReadyToConnect: string[];
 }> {
 	const sliceStatuses = computeTypeStatus(localSlices, remoteSlices);
 	const items: StatusItem[] = [];
 	const missingComponents: string[] = [];
+	const slicesReadyToConnect: string[] = [];
 
 	const slicesDir = getSlicesDirectory(info);
 	const extensions = getSliceComponentExtensions(info.framework);
 
 	for (const slice of sliceStatuses) {
+		const localSlice = localSlices.find((s) => s.id === slice.id);
+
+		// Track slices that have fields but aren't connected to any type
+		// These should be connected before pushing
+		if (localSlice) {
+			const hasFields = sliceHasFields(localSlice);
+			const isConnected = isSliceConnectedToAnyType(slice.id, localTypes);
+
+			if (hasFields && !isConnected) {
+				slicesReadyToConnect.push(slice.label);
+			}
+		}
 		// Check if component is implemented
 		const componentExists = await checkSliceComponent(info, slicesDir, slice.id, extensions);
 
@@ -600,6 +699,7 @@ async function buildSlicesSection(
 		section: { title: "Slices", items },
 		statuses: sliceStatuses,
 		missingComponents,
+		slicesReadyToConnect,
 	};
 }