@slicemachine/init 2.4.3 → 2.4.4-dev-next-release.1

package/src/SliceMachineInitProcess.ts

@@ -8,6 +8,7 @@ import { execaCommand, type ExecaChildProcess } from "execa";
 import open from "open";
 import logSymbols from "log-symbols";
 import { globby } from "globby";
+import { downloadTemplate } from "giget";
 
 import {
 	createSliceMachineManager,
@@ -32,11 +33,18 @@ import {
 import { listr, listrRun } from "./lib/listr";
 import { prompt } from "./lib/prompt";
 import { assertExists } from "./lib/assertExists";
-import { START_SCRIPT_KEY, START_SCRIPT_VALUE } from "./constants";
+import {
+	GIGET_ORGANIZATION,
+	GIGET_PROVIDER,
+	START_SCRIPT_KEY,
+	START_SCRIPT_VALUE,
+} from "./constants";
 import { detectStarterId } from "./lib/starters";
 
 export type SliceMachineInitProcessOptions = {
 	repository?: string;
+	starter?: string;
+	directoryName?: string;
 	push?: boolean;
 	pushSlices?: boolean;
 	pushCustomTypes?: boolean;
@@ -94,30 +102,40 @@ export class SliceMachineInitProcess {
 		console.log(
 			`\n${chalk.bgGray(` ${chalk.bold.white("Slice Machine")} `)} ${chalk.dim(
 				"→",
-			)} Init command started\n`,
+			)} Initializing\n`,
 		);
 
-		if (await this.manager.telemetry.checkIsTelemetryEnabled()) {
-			// We prefer to manually allow console logs despite the app being a CLI to catch wild/unwanted console logs better
-			// eslint-disable-next-line no-console
-			console.log(
-				`${
-					logSymbols.info
-				} We collect telemetry data to improve user experience.\n  Learn more: ${chalk.cyan(
-					"https://prismic.dev/slice-machine/telemetry",
-				)}\n`,
-			);
-		}
-		await this.manager.telemetry.initTelemetry({
-			appName: pkg.name,
-			appVersion: pkg.version,
-		});
-		await this.manager.telemetry.track({
-			event: "command:init:start",
-			repository: this.options.repository,
-		});
-
 		try {
+			if (this.options.starter) {
+				await this.copyStarter();
+			} else if (this.options.directoryName) {
+				// We prefer to manually allow console logs despite the app being a CLI to catch wild/unwanted console logs better
+				// eslint-disable-next-line no-console
+				console.log(
+					`${logSymbols.warning} --directory-name has no effect because --starter is not specified\n`,
+				);
+			}
+
+			if (await this.manager.telemetry.checkIsTelemetryEnabled()) {
+				// We prefer to manually allow console logs despite the app being a CLI to catch wild/unwanted console logs better
+				// eslint-disable-next-line no-console
+				console.log(
+					`${
+						logSymbols.info
+					} We collect telemetry data to improve user experience.\n  Learn more: ${chalk.cyan(
+						"https://prismic.dev/slice-machine/telemetry",
+					)}\n`,
+				);
+			}
+			await this.manager.telemetry.initTelemetry({
+				appName: pkg.name,
+				appVersion: pkg.version,
+			});
+			await this.manager.telemetry.track({
+				event: "command:init:start",
+				repository: this.options.repository,
+			});
+
 			await this.detectEnvironment();
 
 			assertExists(
@@ -174,7 +192,7 @@ export class SliceMachineInitProcess {
 		console.log(
 			`\n${chalk.bgGreen(` ${chalk.bold.white("Slice Machine")} `)} ${chalk.dim(
 				"→",
-			)} Init command successful!`,
+			)} Initialization successful!`,
 		);
 
 		try {
@@ -193,15 +211,49 @@ export class SliceMachineInitProcess {
 				script: "dev",
 			});
 
+			const apiEndpoints = this.manager.getAPIEndpoints();
+			const wroomHost = new URL(apiEndpoints.PrismicWroom).host;
+
+			const dashboardURL = new URL(
+				`https://${this.context.repository.domain}.${wroomHost}`,
+			)
+				.toString()
+				.replace(/\/$/, "");
+			const apiURL = new URL(
+				"./api/v2",
+				`https://${this.context.repository.domain}.cdn.${wroomHost}`,
+			).toString();
+
 			// We prefer to manually allow console logs despite the app being a CLI to catch wild/unwanted console logs better
 			// eslint-disable-next-line no-console
 			console.log(`
-GETTING STARTED
-  Run Slice Machine    ${chalk.cyan(runSmCommand)}
-  Run your project     ${chalk.cyan(runProjectCommand)}
+  YOUR REPOSITORY
+    Dashboard            ${chalk.cyan(dashboardURL)}
+    API                  ${chalk.cyan(apiURL)}
+
+  RESOURCES
+    Documentation        ${chalk.cyan(
+			this.context.framework.prismicDocumentation,
+		)}
+    Getting help         ${chalk.cyan("https://community.prismic.io")}
+
+  GETTING STARTED
+    Run Slice Machine    ${chalk.cyan(runSmCommand)}
+    Run your project     ${chalk.cyan(runProjectCommand)}
 	`);
 
-			if (this.options.startSlicemachine) {
+			if (this.options.starter && this.options.repository) {
+				const { openDashboard } = await prompt<boolean, "openDashboard">({
+					type: "confirm",
+					name: "openDashboard",
+					message: "Would you like to open your repository dashboard?",
+					initial: true,
+				});
+
+				if (openDashboard) {
+					open(dashboardURL);
+				}
+			} else if (this.options.startSlicemachine) {
 				const pkgJSONPath = path.join(this.manager.cwd, "package.json");
 				const pkg = JSON.parse(await fs.readFile(pkgJSONPath, "utf-8"));
 				const scripts = pkg.scripts || {};
@@ -214,13 +266,13 @@ GETTING STARTED
 					) {
 						return {
 							command: runProjectCommand,
-							message: `Would you like to launch your project + Slicemachine (${runProjectCommand})?`,
+							message: `Would you like to run your project and Slice Machine concurrently (${runProjectCommand})?`,
 						};
 					}
 
 					return {
 						command: runSmCommand,
-						message: `Would you like to launch Slicemachine (${runSmCommand})?`,
+						message: `Would you like to run Slice Machine (${runSmCommand})?`,
 					};
 				})();
 				const { startSlicemachine } = await prompt<
@@ -291,6 +343,71 @@ GETTING STARTED
 		});
 	};
 
+	protected async copyStarter(): Promise<void> {
+		return listrRun([
+			{
+				title: "Copying starter...\n",
+				task: async () => {
+					const starter = this.options.starter;
+					const dir = await this.getStarterDirectoryName();
+
+					await downloadTemplate(
+						`${GIGET_PROVIDER}:${GIGET_ORGANIZATION}/${starter}#HEAD`,
+						{
+							dir,
+						},
+					);
+
+					process.chdir(dir);
+					this.manager.cwd = process.cwd();
+				},
+			},
+		]);
+	}
+
+	protected async getStarterDirectoryName(): Promise<string> {
+		let directoryName: string;
+		const folderNames = await fs.readdir(process.cwd());
+
+		if (
+			this.options.directoryName &&
+			!folderNames.includes(this.options.directoryName)
+		) {
+			// Use provided directory
+			directoryName = this.options.directoryName;
+		} else if (
+			this.options.repository &&
+			!folderNames.includes(this.options.repository)
+		) {
+			// Use repository name
+			directoryName = this.options.repository;
+		} else {
+			// Use random name
+			let suggestedName: string;
+			do {
+				suggestedName = getRandomRepositoryDomain();
+			} while (folderNames.includes(suggestedName));
+
+			const { selectedDirectory } = await prompt<string, "selectedDirectory">({
+				type: "text",
+				name: "selectedDirectory",
+				message: "Your starter directory name",
+				initial: suggestedName,
+				validate: async (rawDirectory: string) => {
+					if (folderNames.includes(rawDirectory)) {
+						return "Directory name already exists";
+					}
+
+					return true;
+				},
+			});
+
+			directoryName = selectedDirectory;
+		}
+
+		return directoryName;
+	}
+
 	protected detectEnvironment(): Promise<void> {
 		return listrRun([
 			{
@@ -654,26 +771,26 @@ GETTING STARTED
 			}
 		};
 
-		// 1. Try to suggest name after package name
-		try {
-			const pkgJSONPath = path.join(this.manager.cwd, "package.json");
-			const pkg = JSON.parse(await fs.readFile(pkgJSONPath, "utf-8"));
-
-			const maybeSuggestion = await trySuggestName(pkg.name);
-			if (maybeSuggestion) {
-				suggestedName = maybeSuggestion;
-			}
-		} catch {
-			// Noop
+		// 1. Try to suggest name after directory name
+		const maybeSuggestion = await trySuggestName(
+			path.basename(this.manager.cwd),
+		);
+		if (maybeSuggestion) {
+			suggestedName = maybeSuggestion;
 		}
 
-		// 2. Try to suggest name after directory name
+		// 2. Try to suggest name after package name
 		if (!suggestedName) {
-			const maybeSuggestion = await trySuggestName(
-				path.basename(this.manager.cwd),
-			);
-			if (maybeSuggestion) {
-				suggestedName = maybeSuggestion;
+			try {
+				const pkgJSONPath = path.join(this.manager.cwd, "package.json");
+				const pkg = JSON.parse(await fs.readFile(pkgJSONPath, "utf-8"));
+
+				const maybeSuggestion = await trySuggestName(pkg.name);
+				if (maybeSuggestion) {
+					suggestedName = maybeSuggestion;
+				}
+			} catch {
+				// Noop
 			}
 		}
 

package/src/cli.ts

@@ -5,7 +5,7 @@ import { createSliceMachineInitProcess } from "./SliceMachineInitProcess";
 
 const cli = meow(
 	`
-Prismic Slice Machine Init CLI
+Slice Machine init CLI help
 
 DOCUMENTATION
   https://prismic.io/docs
@@ -17,13 +17,15 @@ USAGE
   $ npx @slicemachine/init
 
 OPTIONS
-  --repository, -r        Specify a Prismic repository to use
+  --repository, -r         Specify a Prismic repository to use
+  --starter, -s            Specify a starter to use
+  --directory-name, -d     Name of a new directory for the starter
 
-  --no-push               For starters, prevent anything from being pushed
-  --no-push-slices        For starters, prevent slices from being pushed
-  --no-push-custom-types  For starters, prevent types from being pushed
-  --no-push-documents     For starters, prevent documents from being pushed
-  --no-start-slicemachine Prevents init from running SliceMachine
+  --no-push                Don't push anything to Prismic
+  --no-push-slices         Don't push slices to Prismic
+  --no-push-custom-types   Don't push types to Prismic
+  --no-push-documents      Don't push documents to Prismic
+  --no-start-slicemachine  Don't run Slice Machine
 
   --help, -h              Display CLI help
   --version, -v           Display CLI version
@@ -35,6 +37,14 @@ OPTIONS
 				type: "string",
 				alias: "r",
 			},
+			starter: {
+				type: "string",
+				alias: "s",
+			},
+			directoryName: {
+				type: "string",
+				alias: "d",
+			},
 			push: {
 				type: "boolean",
 				default: true,

package/src/constants.ts

@@ -1,3 +1,5 @@
 // Those contants should be unique to the init script, if they are needed elsewhere then they should be extracted to the manager
 export const START_SCRIPT_KEY = "slicemachine";
 export const START_SCRIPT_VALUE = "start-slicemachine";
+export const GIGET_PROVIDER = "github";
+export const GIGET_ORGANIZATION = "prismicio-community";