@angeloashmore/prismic-cli-poc 0.0.0-canary.2ff9563

package/src/slice-add-variation.ts

@@ -0,0 +1,137 @@
+import type { SharedSlice } from "@prismicio/types-internal/lib/customtypes";
+
+import { writeFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+
+import { stringify } from "./lib/json";
+import { findSliceModel, pascalCase } from "./lib/slice";
+
+const HELP = `
+Add a new variation to a slice.
+
+USAGE
+  prismic slice add-variation <slice-id> <variation-id> [flags]
+
+ARGUMENTS
+  slice-id       Slice identifier (required)
+  variation-id   New variation identifier (required)
+
+FLAGS
+  --name string       Display name for the variation
+  --copy-from string  Copy fields from an existing variation
+  -h, --help          Show help for command
+
+EXAMPLES
+  prismic slice add-variation MySlice withImage
+  prismic slice add-variation MySlice withImage --name "With Image"
+  prismic slice add-variation MySlice withImage --copy-from default
+`.trim();
+
+export async function sliceAddVariation(): Promise<void> {
+	const {
+		values: { help, name, "copy-from": copyFrom },
+		positionals: [sliceId, variationId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "slice", "add-variation"
+		options: {
+			name: { type: "string" },
+			"copy-from": { type: "string" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!sliceId) {
+		console.error("Missing required argument: slice-id\n");
+		console.error(
+			"Usage: prismic slice add-variation <slice-id> <variation-id>",
+		);
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!variationId) {
+		console.error("Missing required argument: variation-id\n");
+		console.error(
+			"Usage: prismic slice add-variation <slice-id> <variation-id>",
+		);
+		process.exitCode = 1;
+		return;
+	}
+
+	const result = await findSliceModel(sliceId);
+	if (!result.ok) {
+		console.error(result.error);
+		process.exitCode = 1;
+		return;
+	}
+
+	const { model, modelPath } = result;
+
+	// Check if variation already exists
+	if (model.variations.some((v) => v.id === variationId)) {
+		console.error(`Variation "${variationId}" already exists in slice "${sliceId}"`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Build new variation
+	let newVariation: SharedSlice["variations"][number];
+
+	if (copyFrom) {
+		const sourceVariation = model.variations.find((v) => v.id === copyFrom);
+		if (!sourceVariation) {
+			console.error(`Source variation not found: ${copyFrom}`);
+			console.error(
+				`Available variations: ${model.variations.map((v) => v.id).join(", ")}`,
+			);
+			process.exitCode = 1;
+			return;
+		}
+
+		newVariation = {
+			...structuredClone(sourceVariation),
+			id: variationId,
+			name: name ?? pascalCase(variationId),
+		};
+	} else {
+		newVariation = {
+			id: variationId,
+			name: name ?? pascalCase(variationId),
+			description: variationId,
+			imageUrl: "",
+			docURL: "",
+			version: "initial",
+			primary: {},
+			items: {},
+		};
+	}
+
+	// Add variation to model
+	const updatedModel = {
+		...model,
+		variations: [...model.variations, newVariation],
+	};
+
+	// Write updated model
+	try {
+		await writeFile(modelPath, stringify(updatedModel as SharedSlice));
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to update slice: ${error.message}`);
+		} else {
+			console.error("Failed to update slice");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(
+		`Added variation "${variationId}" to slice "${sliceId}"`,
+	);
+}

package/src/slice-create.ts

@@ -0,0 +1,129 @@
+import type { SharedSlice } from "@prismicio/types-internal/lib/customtypes";
+
+import { mkdir, readFile, writeFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+import * as v from "valibot";
+
+import { exists, findUpward } from "./lib/file";
+import { stringify } from "./lib/json";
+
+const HELP = `
+Create a new slice in a Prismic project.
+
+USAGE
+  prismic slice create <id> [flags]
+
+ARGUMENTS
+  id       Slice identifier (required)
+
+FLAGS
+  -n, --name string   Display name for the slice
+  -h, --help          Show help for command
+
+LEARN MORE
+  Use \`prismic slice <command> --help\` for more information about a command.
+`.trim();
+
+export async function sliceCreate(): Promise<void> {
+	const {
+		values: { help, name },
+		positionals: [id],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "slice", "create"
+		options: {
+			name: { type: "string", short: "n" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!id) {
+		console.error("Missing required argument: id");
+		process.exitCode = 1;
+		return;
+	}
+
+	const model: SharedSlice = {
+		id,
+		type: "SharedSlice",
+		name: name ?? pascalCase(id),
+		description: "",
+		variations: [
+			{
+				id: "default",
+				name: "Default",
+				description: "Default",
+				imageUrl: "",
+				docURL: "",
+				version: "initial",
+				primary: {},
+				items: {},
+			},
+		],
+	};
+
+	const slicesDirectory = await getSlicesDirectory();
+	const sliceDirectory = new URL(pascalCase(model.name) + "/", slicesDirectory);
+	const modelPath = new URL("model.json", sliceDirectory);
+
+	try {
+		await mkdir(new URL(".", modelPath), { recursive: true });
+		await writeFile(modelPath, stringify(model));
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to create slice: ${error.message}`);
+		} else {
+			console.error(`Failed to create slice`);
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(`Created slice at ${modelPath.href}`);
+}
+
+async function getSlicesDirectory(): Promise<URL> {
+	const framework = await detectFramework();
+	const projectRoot = await findUpward("package.json");
+	switch (framework) {
+		case "next": {
+			const hasSrcDir = await exists(new URL("src", projectRoot));
+			if (hasSrcDir) return new URL("src/slices/", projectRoot);
+		}
+		case "nuxt": {
+			const hasAppDir = await exists(new URL("app", projectRoot));
+			if (hasAppDir) return new URL("app/slices/", projectRoot);
+		}
+		case "sveltekit": {
+			return new URL("src/slices/", projectRoot);
+		}
+	}
+	return new URL("slices/", projectRoot);
+}
+
+const PackageJsonSchema = v.object({
+	dependencies: v.optional(v.record(v.string(), v.string())),
+});
+
+type Framework = "next" | "nuxt" | "sveltekit";
+
+async function detectFramework(): Promise<Framework | undefined> {
+	const packageJsonPath = await findUpward("package.json");
+	if (!packageJsonPath) return;
+	try {
+		const contents = await readFile(packageJsonPath, "utf8");
+		const { dependencies = {} } = v.parse(PackageJsonSchema, JSON.parse(contents));
+		if ("next" in dependencies) return "next";
+		if ("nuxt" in dependencies) return "nuxt";
+		if ("@sveltejs/kit" in dependencies) return "sveltekit";
+	} catch {}
+}
+
+function pascalCase(input: string): string {
+	return input.toLowerCase().replace(/(^|[-_\s]+)(.)?/g, (_, __, c) => c?.toUpperCase() ?? "");
+}

package/src/slice-list-variations.ts

@@ -0,0 +1,67 @@
+import { parseArgs } from "node:util";
+
+import { findSliceModel } from "./lib/slice";
+
+const HELP = `
+List all variations for a slice.
+
+USAGE
+  prismic slice list-variations <slice-id> [flags]
+
+ARGUMENTS
+  slice-id     Slice identifier (required)
+
+FLAGS
+  --json       Output as JSON
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic slice list-variations MySlice
+  prismic slice list-variations MySlice --json
+`.trim();
+
+export async function sliceListVariations(): Promise<void> {
+	const {
+		values: { help, json },
+		positionals: [sliceId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "slice", "list-variations"
+		options: {
+			json: { type: "boolean" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!sliceId) {
+		console.error("Missing required argument: slice-id\n");
+		console.error("Usage: prismic slice list-variations <slice-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	const result = await findSliceModel(sliceId);
+	if (!result.ok) {
+		console.error(result.error);
+		process.exitCode = 1;
+		return;
+	}
+
+	const { model } = result;
+	const variations = model.variations.map((v) => ({ id: v.id, name: v.name }));
+
+	if (json) {
+		console.info(JSON.stringify(variations, null, 2));
+		return;
+	}
+
+	console.info("ID\tNAME");
+	for (const variation of variations) {
+		console.info(`${variation.id}\t${variation.name}`);
+	}
+}

package/src/slice-list.ts

@@ -0,0 +1,88 @@
+import { readdir, readFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+import * as v from "valibot";
+
+import { getSlicesDirectory, SharedSliceSchema } from "./lib/slice";
+
+const HELP = `
+List all slices in a Prismic project.
+
+USAGE
+  prismic slice list [flags]
+
+FLAGS
+  --json       Output as JSON
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic slice list
+  prismic slice list --json
+`.trim();
+
+export async function sliceList(): Promise<void> {
+	const {
+		values: { help, json },
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "slice", "list"
+		options: {
+			json: { type: "boolean" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	const slicesDirectory = await getSlicesDirectory();
+
+	let entries: string[];
+	try {
+		entries = (await readdir(slicesDirectory, {
+			withFileTypes: false,
+		})) as unknown as string[];
+	} catch {
+		if (json) {
+			console.info(JSON.stringify([]));
+		} else {
+			console.info("No slices found.");
+		}
+		return;
+	}
+
+	const slices: { id: string; name: string }[] = [];
+
+	for (const entry of entries) {
+		const modelPath = new URL(`${entry}/model.json`, slicesDirectory);
+		try {
+			const contents = await readFile(modelPath, "utf8");
+			const parsed = JSON.parse(contents);
+			const result = v.safeParse(SharedSliceSchema, parsed);
+			if (result.success) {
+				slices.push({ id: result.output.id, name: result.output.name });
+			}
+		} catch {
+			// Skip directories without valid model.json
+		}
+	}
+
+	if (slices.length === 0) {
+		if (json) {
+			console.info(JSON.stringify([]));
+		} else {
+			console.info("No slices found.");
+		}
+		return;
+	}
+
+	if (json) {
+		console.info(JSON.stringify(slices, null, 2));
+	} else {
+		console.info("ID\tNAME");
+		for (const slice of slices) {
+			console.info(`${slice.id}\t${slice.name}`);
+		}
+	}
+}

package/src/slice-remove-field.ts

@@ -0,0 +1,117 @@
+import { writeFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+
+import { stringify } from "./lib/json";
+import { findSliceModel } from "./lib/slice";
+
+const HELP = `
+Remove a field from a slice variation.
+
+USAGE
+  prismic slice remove-field <slice-id> <field-id> [flags]
+
+ARGUMENTS
+  slice-id     Slice identifier (required)
+  field-id     Field identifier (required)
+
+FLAGS
+  --variation string  Target variation (default: "default")
+  --zone string       Field zone: "primary" or "items" (default: "primary")
+  -h, --help          Show help for command
+
+EXAMPLES
+  prismic slice remove-field MySlice title
+  prismic slice remove-field MySlice title --variation withImage
+  prismic slice remove-field MySlice item_title --zone items
+`.trim();
+
+export async function sliceRemoveField(): Promise<void> {
+	const {
+		values: { help, variation, zone },
+		positionals: [sliceId, fieldId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "slice", "remove-field"
+		options: {
+			variation: { type: "string", default: "default" },
+			zone: { type: "string", default: "primary" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!sliceId) {
+		console.error("Missing required argument: slice-id\n");
+		console.error("Usage: prismic slice remove-field <slice-id> <field-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!fieldId) {
+		console.error("Missing required argument: field-id\n");
+		console.error("Usage: prismic slice remove-field <slice-id> <field-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (zone !== "primary" && zone !== "items") {
+		console.error(`Invalid zone: ${zone}. Must be "primary" or "items".`);
+		process.exitCode = 1;
+		return;
+	}
+
+	const result = await findSliceModel(sliceId);
+	if (!result.ok) {
+		console.error(result.error);
+		process.exitCode = 1;
+		return;
+	}
+
+	const { model, modelPath } = result;
+
+	// Find the variation
+	const targetVariation = model.variations.find((v) => v.id === variation);
+	if (!targetVariation) {
+		console.error(`Variation not found: ${variation}`);
+		console.error(
+			`Available variations: ${model.variations.map((v) => v.id).join(", ")}`,
+		);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check if field exists
+	const zoneFields =
+		zone === "primary" ? targetVariation.primary : targetVariation.items;
+	if (!zoneFields || !(fieldId in zoneFields)) {
+		console.error(
+			`Field "${fieldId}" not found in ${zone} zone of variation "${variation}"`,
+		);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Remove the field
+	delete zoneFields[fieldId];
+
+	// Write updated model
+	try {
+		await writeFile(modelPath, stringify(model));
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to update slice: ${error.message}`);
+		} else {
+			console.error("Failed to update slice");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(
+		`Removed field "${fieldId}" from ${zone} zone in variation "${variation}" of slice "${sliceId}"`,
+	);
+}

package/src/slice-remove-variation.ts

@@ -0,0 +1,108 @@
+import type { SharedSlice } from "@prismicio/types-internal/lib/customtypes";
+
+import { writeFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+
+import { stringify } from "./lib/json";
+import { findSliceModel } from "./lib/slice";
+
+const HELP = `
+Remove a variation from a slice.
+
+USAGE
+  prismic slice remove-variation <slice-id> <variation-id> [flags]
+
+ARGUMENTS
+  slice-id       Slice identifier (required)
+  variation-id   Variation to remove (required)
+
+FLAGS
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic slice remove-variation MySlice withImage
+`.trim();
+
+export async function sliceRemoveVariation(): Promise<void> {
+	const {
+		values: { help },
+		positionals: [sliceId, variationId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "slice", "remove-variation"
+		options: {
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!sliceId) {
+		console.error("Missing required argument: slice-id\n");
+		console.error(
+			"Usage: prismic slice remove-variation <slice-id> <variation-id>",
+		);
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!variationId) {
+		console.error("Missing required argument: variation-id\n");
+		console.error(
+			"Usage: prismic slice remove-variation <slice-id> <variation-id>",
+		);
+		process.exitCode = 1;
+		return;
+	}
+
+	const result = await findSliceModel(sliceId);
+	if (!result.ok) {
+		console.error(result.error);
+		process.exitCode = 1;
+		return;
+	}
+
+	const { model, modelPath } = result;
+
+	// Check if variation exists
+	const variationExists = model.variations.some((v) => v.id === variationId);
+	if (!variationExists) {
+		console.error(`Variation not found: ${variationId}`);
+		console.error(
+			`Available variations: ${model.variations.map((v) => v.id).join(", ")}`,
+		);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Prevent removing the last variation
+	if (model.variations.length === 1) {
+		console.error("Cannot remove the last variation from a slice.");
+		process.exitCode = 1;
+		return;
+	}
+
+	// Remove the variation
+	const updatedModel = {
+		...model,
+		variations: model.variations.filter((v) => v.id !== variationId),
+	};
+
+	// Write updated model
+	try {
+		await writeFile(modelPath, stringify(updatedModel as SharedSlice));
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to update slice: ${error.message}`);
+		} else {
+			console.error("Failed to update slice");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(`Removed variation "${variationId}" from slice "${sliceId}"`);
+}