@slicemachine/init 2.1.1-dev-page-types-m2.0 → 2.1.1-dev-hotfixes.0

package/src/SliceMachineInitProcess.ts

@@ -13,10 +13,12 @@ import {
 	PrismicRepository,
 	SliceMachineManager,
 	PackageManager,
+	StarterID,
 } from "@slicemachine/manager";
 
 import pkg from "../package.json";
 import { detectFramework, Framework } from "./lib/framework";
+import { detectStarterId } from "./lib/starters";
 import { getRunScriptCommand } from "./lib/getRunScriptCommand";
 import { getExecuteCommand } from "./lib/getExecuteCommand";
 import {
@@ -66,6 +68,7 @@ type SliceMachineInitProcessContext = {
 	projectInitialization?: {
 		patchedScript?: boolean;
 	};
+	starterID?: StarterID;
 };
 
 export class SliceMachineInitProcess {
@@ -149,7 +152,7 @@ export class SliceMachineInitProcess {
 
 		await this.manager.telemetry.track({
 			event: "command:init:end",
-			framework: this.context.framework.prismicName,
+			framework: this.context.framework.sliceMachineTelemetryID,
 			repository: this.context.repository.domain,
 			success: true,
 		});
@@ -220,7 +223,7 @@ export class SliceMachineInitProcess {
 
 		return this.manager.telemetry.track({
 			event: "command:init:end",
-			framework: this.context.framework?.prismicName ?? "unknown",
+			framework: this.context.framework?.sliceMachineTelemetryID ?? "unknown",
 			repository: this.context.repository?.domain,
 			success: false,
 			error: safeError,
@@ -268,6 +271,22 @@ export class SliceMachineInitProcess {
 								)}`;
 							},
 						},
+						{
+							title: "Detecting starter...",
+							task: async (_, task) => {
+								this.context.starterID = await detectStarterId(
+									this.manager.cwd,
+								);
+
+								if (this.context.starterID) {
+									task.title = `Detected starter ${chalk.cyan(
+										this.context.starterID,
+									)}`;
+								} else {
+									task.title = "No starter detected";
+								}
+							},
+						},
 					]),
 			},
 		]);
@@ -683,7 +702,8 @@ ${chalk.cyan("?")} Your Prismic repository name`.replace("\n", ""),
 
 					await this.manager.prismicRepository.create({
 						domain: this.context.repository.domain,
-						framework: this.context.framework.prismicName,
+						framework: this.context.framework.wroomTelemetryID,
+						starterID: this.context.starterID,
 					});
 
 					this.context.repository.exists = true;

package/src/lib/framework.ts

@@ -1,8 +1,9 @@
 import { readFile } from "node:fs/promises";
 import { join } from "node:path";
-
 import semver from "semver";
 
+import { FrameworkWroomTelemetryID } from "@slicemachine/manager";
+
 import { version as pkgVersion } from "../../package.json";
 
 export type Framework = {
@@ -12,9 +13,14 @@ export type Framework = {
 	name: string;
 
 	/**
-	 * Framework's name sent to Prismic
+	 * Framework 's id sent to Segment from Slice Machine
+	 */
+	sliceMachineTelemetryID: "next-11-13" | "nuxt-2" | "nuxt-3" | "universal";
+
+	/**
+	 * Framework's id sent to Segment from wroom.
 	 */
-	prismicName: string;
+	wroomTelemetryID: FrameworkWroomTelemetryID;
 
 	/**
 	 * A link to the Prismic documentation for the framework
@@ -60,7 +66,8 @@ const DEFAULT_DEV_DEPENDENCIES: Record<string, string> = {
 export const FRAMEWORKS: Record<string, Framework> = {
 	"nuxt-2": {
 		name: "Nuxt 2",
-		prismicName: "nuxt-2",
+		sliceMachineTelemetryID: "nuxt-2",
+		wroomTelemetryID: "nuxt",
 		prismicDocumentation: "https://prismic.dev/init/nuxt-2",
 		adapterName: "@slicemachine/adapter-nuxt2",
 		compatibility: {
@@ -73,7 +80,8 @@ export const FRAMEWORKS: Record<string, Framework> = {
 	},
 	"nuxt-3": {
 		name: "Nuxt 3",
-		prismicName: "nuxt-3",
+		sliceMachineTelemetryID: "nuxt-3",
+		wroomTelemetryID: "nuxt",
 		prismicDocumentation: "https://prismic.dev/init/nuxt-3",
 		adapterName: "@slicemachine/adapter-nuxt",
 		compatibility: {
@@ -86,7 +94,8 @@ export const FRAMEWORKS: Record<string, Framework> = {
 	},
 	"next-11-13": {
 		name: "Next.js 11-13",
-		prismicName: "next-11-13",
+		sliceMachineTelemetryID: "next-11-13",
+		wroomTelemetryID: "next",
 		prismicDocumentation: "https://prismic.dev/init/next-11-13",
 		adapterName: "@slicemachine/adapter-next",
 		compatibility: {
@@ -104,7 +113,8 @@ export const FRAMEWORKS: Record<string, Framework> = {
  */
 export const UNIVERSAL: Framework = {
 	name: "universal (no framework)",
-	prismicName: "universal",
+	sliceMachineTelemetryID: "universal",
+	wroomTelemetryID: "other",
 	prismicDocumentation: "https://prismic.dev/init/universal",
 	adapterName: "@slicemachine/adapter-universal",
 	compatibility: {},

package/src/lib/starters.ts

@@ -0,0 +1,30 @@
+import { readFile } from "node:fs/promises";
+import { join } from "node:path";
+
+import { StarterID } from "@slicemachine/manager";
+
+const STARTERS_REPOSITORY_NAME_TO_ID: Record<string, StarterID> = {
+	"nextjs-starter-prismic-multi-page": "next_multi_page",
+	"nextjs-starter-prismic-blog": "next_blog",
+	"nextjs-starter-prismic-multi-language": "next_multi_lang",
+	"nuxt-starter-prismic-multi-page": "nuxt_multi_page",
+	"nuxt-starter-prismic-blog": "nuxt_blog",
+	"nuxt-starter-prismic-multi-language": "nuxt_multi_lang",
+};
+
+export const detectStarterId = async (
+	cwd: string,
+): Promise<StarterID | undefined> => {
+	const path = join(cwd, "package.json");
+
+	try {
+		const pkg = JSON.parse(await readFile(path, "utf-8"));
+
+		return STARTERS_REPOSITORY_NAME_TO_ID[pkg.name];
+	} catch (error) {
+		throw new Error(
+			`Failed to read project's \`package.json\` at \`${path}\``,
+			{ cause: error },
+		);
+	}
+};