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

package/src/custom-type-add-field-uid.ts

@@ -19,14 +19,11 @@ ARGUMENTS
   type-id                Custom type identifier (required)
   field-id               Field identifier (required)
 
-Types are generated by default after changes. Use --no-types to skip.
-
 FLAGS
   -t, --tab string       Target tab (default: first existing tab, or "Main")
   -l, --label string     Display label for the field (inferred from field-id if omitted)
   -p, --placeholder string Placeholder text
       --types string   Output file for generated types (default: "prismicio-types.d.ts")
-      --no-types       Skip type generation
   -h, --help             Show help for command
 
 EXAMPLES
@@ -46,7 +43,7 @@ const CustomTypeSchema = v.object({
 
 export async function customTypeAddFieldUid(): Promise<void> {
 	const {
-		values: { help, tab, label, placeholder, types, "no-types": noTypes },
+		values: { help, tab, label, placeholder, types },
 		positionals: [typeId, fieldId],
 	} = parseArgs({
 		args: process.argv.slice(5), // skip: node, script, "custom-type", "add-field", "uid"
@@ -55,7 +52,6 @@ export async function customTypeAddFieldUid(): Promise<void> {
 			label: { type: "string", short: "l" },
 			placeholder: { type: "string", short: "p" },
 			types: { type: "string" },
-			"no-types": { type: "boolean" },
 			help: { type: "boolean", short: "h" },
 		},
 		allowPositionals: true,
@@ -162,13 +158,11 @@ export async function customTypeAddFieldUid(): Promise<void> {
 
 	console.info(`Added field "${fieldId}" (UID) to "${targetTab}" tab in ${typeId}`);
 
-	if (!noTypes) {
-		try {
-			await buildTypes({ output: types });
-			console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
-		} catch (error) {
-			console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
-		}
+	try {
+		await buildTypes({ output: types });
+		console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
+	} catch (error) {
+		console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
 	}
 
 	console.info();

package/src/custom-type-connect-slice.ts

@@ -23,12 +23,9 @@ ARGUMENTS
   type-id                Custom type identifier (required)
   slice-id               Slice identifier (required)
 
-Types are generated by default after changes. Use --no-types to skip.
-
 FLAGS
   -z, --slice-zone string  Target slice zone field ID (default: "slices")
       --types string   Output file for generated types (default: "prismicio-types.d.ts")
-      --no-types       Skip type generation
   -h, --help               Show help for command
 
 EXAMPLES
@@ -48,14 +45,13 @@ const CustomTypeSchema = v.object({
 
 export async function customTypeConnectSlice(): Promise<void> {
 	const {
-		values: { help, "slice-zone": sliceZoneId, types, "no-types": noTypes },
+		values: { help, "slice-zone": sliceZoneId, types },
 		positionals: [typeId, sliceId],
 	} = parseArgs({
 		args: process.argv.slice(4), // skip: node, script, "custom-type", "connect-slice"
 		options: {
 			"slice-zone": { type: "string", short: "z" },
 			types: { type: "string" },
-			"no-types": { type: "boolean" },
 			help: { type: "boolean", short: "h" },
 		},
 		allowPositionals: true,
@@ -209,12 +205,10 @@ export async function customTypeConnectSlice(): Promise<void> {
 
 	console.info(`Connected slice "${sliceId}" to slice zone "${sliceZoneFieldId}" in ${typeId}`);
 
-	if (!noTypes) {
-		try {
-			await buildTypes({ output: types });
-			console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
-		} catch (error) {
-			console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
-		}
+	try {
+		await buildTypes({ output: types });
+		console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
+	} catch (error) {
+		console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
 	}
 }

package/src/custom-type-create.ts

@@ -16,13 +16,10 @@ USAGE
 ARGUMENTS
   id       Custom type identifier (required)
 
-Types are generated by default after changes. Use --no-types to skip.
-
 FLAGS
   -n, --name string   Display name for the custom type
       --single        Create as a singleton (non-repeatable) type
       --types string   Output file for generated types (default: "prismicio-types.d.ts")
-      --no-types       Skip type generation
   -h, --help          Show help for command
 
 LEARN MORE
@@ -31,7 +28,7 @@ LEARN MORE
 
 export async function customTypeCreate(): Promise<void> {
 	const {
-		values: { help, name, single, types, "no-types": noTypes },
+		values: { help, name, single, types },
 		positionals: [id],
 	} = parseArgs({
 		args: process.argv.slice(4), // skip: node, script, "custom-type", "create"
@@ -39,7 +36,6 @@ export async function customTypeCreate(): Promise<void> {
 			name: { type: "string", short: "n" },
 			single: { type: "boolean" },
 			types: { type: "string" },
-			"no-types": { type: "boolean" },
 			help: { type: "boolean", short: "h" },
 		},
 		allowPositionals: true,
@@ -100,13 +96,11 @@ export async function customTypeCreate(): Promise<void> {
 
 	console.info(`Created custom type at ${modelPath.href}`);
 
-	if (!noTypes) {
-		try {
-			await buildTypes({ output: types });
-			console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
-		} catch (error) {
-			console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
-		}
+	try {
+		await buildTypes({ output: types });
+		console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
+	} catch (error) {
+		console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
 	}
 
 	console.info();

package/src/custom-type-disconnect-slice.ts

@@ -18,12 +18,9 @@ ARGUMENTS
   type-id                Custom type identifier (required)
   slice-id               Slice identifier (required)
 
-Types are generated by default after changes. Use --no-types to skip.
-
 FLAGS
   -z, --slice-zone string  Target slice zone field ID (default: "slices")
       --types string   Output file for generated types (default: "prismicio-types.d.ts")
-      --no-types       Skip type generation
   -h, --help               Show help for command
 
 EXAMPLES
@@ -43,14 +40,13 @@ const CustomTypeSchema = v.object({
 
 export async function customTypeDisconnectSlice(): Promise<void> {
 	const {
-		values: { help, "slice-zone": sliceZoneId, types, "no-types": noTypes },
+		values: { help, "slice-zone": sliceZoneId, types },
 		positionals: [typeId, sliceId],
 	} = parseArgs({
 		args: process.argv.slice(4), // skip: node, script, "custom-type", "disconnect-slice"
 		options: {
 			"slice-zone": { type: "string", short: "z" },
 			types: { type: "string" },
-			"no-types": { type: "boolean" },
 			help: { type: "boolean", short: "h" },
 		},
 		allowPositionals: true,
@@ -166,12 +162,10 @@ export async function customTypeDisconnectSlice(): Promise<void> {
 		`Disconnected slice "${sliceId}" from slice zone "${sliceZoneFieldId}" in ${typeId}`,
 	);
 
-	if (!noTypes) {
-		try {
-			await buildTypes({ output: types });
-			console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
-		} catch (error) {
-			console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
-		}
+	try {
+		await buildTypes({ output: types });
+		console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
+	} catch (error) {
+		console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
 	}
 }

package/src/custom-type-remove-field.ts

@@ -18,12 +18,9 @@ ARGUMENTS
   type-id      Custom type identifier (required)
   field-id     Field identifier (required)
 
-Types are generated by default after changes. Use --no-types to skip.
-
 FLAGS
   --tab string  Specific tab (searches all tabs if not specified)
       --types string   Output file for generated types (default: "prismicio-types.d.ts")
-      --no-types       Skip type generation
   -h, --help    Show help for command
 
 EXAMPLES
@@ -42,14 +39,13 @@ const CustomTypeSchema = v.object({
 
 export async function customTypeRemoveField(): Promise<void> {
 	const {
-		values: { help, tab, types, "no-types": noTypes },
+		values: { help, tab, types },
 		positionals: [typeId, fieldId],
 	} = parseArgs({
 		args: process.argv.slice(4), // skip: node, script, "custom-type", "remove-field"
 		options: {
 			tab: { type: "string" },
 			types: { type: "string" },
-			"no-types": { type: "boolean" },
 			help: { type: "boolean", short: "h" },
 		},
 		allowPositionals: true,
@@ -166,12 +162,10 @@ export async function customTypeRemoveField(): Promise<void> {
 
 	console.info(`Removed field "${fieldId}" from tab "${foundTab}" in custom type "${typeId}"`);
 
-	if (!noTypes) {
-		try {
-			await buildTypes({ output: types });
-			console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
-		} catch (error) {
-			console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
-		}
+	try {
+		await buildTypes({ output: types });
+		console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
+	} catch (error) {
+		console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
 	}
 }

package/src/custom-type-remove.ts

@@ -16,12 +16,9 @@ USAGE
 ARGUMENTS
   type-id      Custom type identifier (required)
 
-Types are generated by default after changes. Use --no-types to skip.
-
 FLAGS
   -y           Confirm removal
       --types string   Output file for generated types (default: "prismicio-types.d.ts")
-      --no-types       Skip type generation
   -h, --help   Show help for command
 
 EXAMPLES
@@ -40,14 +37,13 @@ const CustomTypeSchema = v.object({
 
 export async function customTypeRemove(): Promise<void> {
 	const {
-		values: { help, y, types, "no-types": noTypes },
+		values: { help, y, types },
 		positionals: [typeId],
 	} = parseArgs({
 		args: process.argv.slice(4), // skip: node, script, "custom-type", "remove"
 		options: {
 			y: { type: "boolean", short: "y" },
 			types: { type: "string" },
-			"no-types": { type: "boolean" },
 			help: { type: "boolean", short: "h" },
 		},
 		allowPositionals: true,
@@ -133,12 +129,10 @@ export async function customTypeRemove(): Promise<void> {
 
 	console.info(`Removed custom type "${typeId}"`);
 
-	if (!noTypes) {
-		try {
-			await buildTypes({ output: types });
-			console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
-		} catch (error) {
-			console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
-		}
+	try {
+		await buildTypes({ output: types });
+		console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
+	} catch (error) {
+		console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
 	}
 }

package/src/custom-type-set-name.ts

@@ -18,11 +18,8 @@ ARGUMENTS
   type-id      Custom type identifier (required)
   new-name     New display name (required)
 
-Types are generated by default after changes. Use --no-types to skip.
-
 FLAGS
       --types string   Output file for generated types (default: "prismicio-types.d.ts")
-      --no-types       Skip type generation
   -h, --help   Show help for command
 
 EXAMPLES
@@ -41,13 +38,12 @@ const CustomTypeSchema = v.object({
 
 export async function customTypeSetName(): Promise<void> {
 	const {
-		values: { help, types, "no-types": noTypes },
+		values: { help, types },
 		positionals: [typeId, newName],
 	} = parseArgs({
 		args: process.argv.slice(4), // skip: node, script, "custom-type", "set-name"
 		options: {
 			types: { type: "string" },
-			"no-types": { type: "boolean" },
 			help: { type: "boolean", short: "h" },
 		},
 		allowPositionals: true,
@@ -133,12 +129,10 @@ export async function customTypeSetName(): Promise<void> {
 
 	console.info(`Renamed custom type "${typeId}" to "${newName}"`);
 
-	if (!noTypes) {
-		try {
-			await buildTypes({ output: types });
-			console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
-		} catch (error) {
-			console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
-		}
+	try {
+		await buildTypes({ output: types });
+		console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
+	} catch (error) {
+		console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
 	}
 }

package/src/docs.ts

@@ -0,0 +1,149 @@
+import { parseArgs } from "node:util";
+
+const HELP = `
+Fetch and display documentation from Prismic's docs site.
+
+USAGE
+  prismic docs <path> [flags]
+
+ARGUMENTS
+  path    Documentation path with optional anchor (e.g., "nextjs" or "nextjs#set-up-a-prismic-client")
+
+FLAGS
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic docs nextjs
+  prismic docs nextjs#set-up-a-prismic-client
+
+LEARN MORE
+  Visit https://prismic.io/docs for the full documentation.
+`.trim();
+
+function parsePathAndAnchor(input: string): { path: string; anchor?: string } {
+	const hashIndex = input.indexOf("#");
+	if (hashIndex === -1) {
+		return { path: input };
+	}
+	return {
+		path: input.slice(0, hashIndex),
+		anchor: input.slice(hashIndex + 1),
+	};
+}
+
+async function fetchMarkdown(
+	url: string,
+): Promise<{ ok: true; content: string } | { ok: false; error: string }> {
+	try {
+		const response = await fetch(url);
+		if (response.status === 404) {
+			return { ok: false, error: `Documentation not found: ${url}` };
+		}
+		if (!response.ok) {
+			return {
+				ok: false,
+				error: `Failed to fetch documentation: ${response.status}`,
+			};
+		}
+		const content = await response.text();
+		return { ok: true, content };
+	} catch (error) {
+		const message = error instanceof Error ? error.message : String(error);
+		return { ok: false, error: `Network error: ${message}` };
+	}
+}
+
+function anchorToHeadingPattern(anchor: string): RegExp {
+	// Convert kebab-case anchor to a pattern that matches the heading text
+	// Each hyphen/space becomes a flexible match for hyphens or spaces
+	const pattern = anchor
+		.split("-")
+		.map((word) => word.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"))
+		.join("[\\s-]+");
+	return new RegExp(`^(#{1,6})\\s+${pattern}\\s*$`, "im");
+}
+
+function extractSection(
+	markdown: string,
+	anchor: string,
+): { ok: true; content: string } | { ok: false; error: string } {
+	const lines = markdown.split("\n");
+	const headingPattern = anchorToHeadingPattern(anchor);
+
+	let startIndex = -1;
+	let headingLevel = 0;
+
+	// Find the matching heading
+	for (let i = 0; i < lines.length; i++) {
+		const match = lines[i].match(headingPattern);
+		if (match) {
+			startIndex = i;
+			headingLevel = match[1].length;
+			break;
+		}
+	}
+
+	if (startIndex === -1) {
+		return { ok: false, error: `Anchor not found: #${anchor}` };
+	}
+
+	// Find the end of this section (next heading of equal or lower level number)
+	let endIndex = lines.length;
+	for (let i = startIndex + 1; i < lines.length; i++) {
+		const headingMatch = lines[i].match(/^(#{1,6})\s/);
+		if (headingMatch && headingMatch[1].length <= headingLevel) {
+			endIndex = i;
+			break;
+		}
+	}
+
+	const content = lines.slice(startIndex, endIndex).join("\n").trim();
+	return { ok: true, content };
+}
+
+export async function docs(): Promise<void> {
+	const {
+		positionals: [pathArg],
+		values: { help },
+	} = parseArgs({
+		args: process.argv.slice(3),
+		options: {
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!pathArg) {
+		console.info(HELP);
+		return;
+	}
+
+	const { path, anchor } = parsePathAndAnchor(pathArg);
+	const url = `https://prismic.io/docs/${path}.md`;
+
+	const fetchResult = await fetchMarkdown(url);
+	if (!fetchResult.ok) {
+		console.error(fetchResult.error);
+		process.exitCode = 1;
+		return;
+	}
+
+	let output = fetchResult.content;
+
+	if (anchor) {
+		const extractResult = extractSection(output, anchor);
+		if (!extractResult.ok) {
+			console.error(extractResult.error);
+			process.exitCode = 1;
+			return;
+		}
+		output = extractResult.content;
+	}
+
+	console.info(output);
+}

package/src/index.ts

@@ -5,6 +5,7 @@ import { parseArgs } from "node:util";
 import packageJson from "../package.json" with { type: "json" };
 import { codegen } from "./codegen";
 import { customType } from "./custom-type";
+import { docs } from "./docs";
 import { init } from "./init";
 import { locale } from "./locale";
 import { login } from "./login";
@@ -40,6 +41,7 @@ COMMANDS
   pull        Pull types and slices from Prismic
   push        Push types and slices to Prismic
   codegen     Generate code from Prismic models
+  docs        Fetch documentation from Prismic
   preview     Manage preview configurations
   token       Manage API tokens in a repository
   webhook     Manage webhooks in a repository
@@ -107,6 +109,9 @@ if (version) {
 		case "codegen":
 			await codegen();
 			break;
+		case "docs":
+			await docs();
+			break;
 		case "preview":
 			await preview();
 			break;

package/src/page-type-add-field-boolean.ts

@@ -19,8 +19,6 @@ ARGUMENTS
   type-id                Page type identifier (required)
   field-id               Field identifier (required)
 
-Types are generated by default after changes. Use --no-types to skip.
-
 FLAGS
   -t, --tab string       Target tab (default: first existing tab, or "Main")
   -l, --label string     Display label for the field (inferred from field-id if omitted)
@@ -28,7 +26,6 @@ FLAGS
       --true-label string Label shown when toggle is on
       --false-label string Label shown when toggle is off
       --types string   Output file for generated types (default: "prismicio-types.d.ts")
-      --no-types       Skip type generation
   -h, --help             Show help for command
 
 EXAMPLES
@@ -56,7 +53,6 @@ export async function pageTypeAddFieldBoolean(): Promise<void> {
 			"true-label": trueLabel,
 			"false-label": falseLabel,
 			types,
-			"no-types": noTypes,
 		},
 		positionals: [typeId, fieldId],
 	} = parseArgs({
@@ -68,7 +64,6 @@ export async function pageTypeAddFieldBoolean(): Promise<void> {
 			"true-label": { type: "string" },
 			"false-label": { type: "string" },
 			types: { type: "string" },
-			"no-types": { type: "boolean" },
 			help: { type: "boolean", short: "h" },
 		},
 		allowPositionals: true,
@@ -177,13 +172,11 @@ export async function pageTypeAddFieldBoolean(): Promise<void> {
 
 	console.info(`Added field "${fieldId}" (Boolean) to "${targetTab}" tab in ${typeId}`);
 
-	if (!noTypes) {
-		try {
-			await buildTypes({ output: types });
-			console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
-		} catch (error) {
-			console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
-		}
+	try {
+		await buildTypes({ output: types });
+		console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
+	} catch (error) {
+		console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
 	}
 
 	console.info();

package/src/page-type-add-field-color.ts

@@ -19,14 +19,11 @@ ARGUMENTS
   type-id                Page type identifier (required)
   field-id               Field identifier (required)
 
-Types are generated by default after changes. Use --no-types to skip.
-
 FLAGS
   -t, --tab string       Target tab (default: first existing tab, or "Main")
   -l, --label string     Display label for the field (inferred from field-id if omitted)
   -p, --placeholder string Placeholder text
       --types string   Output file for generated types (default: "prismicio-types.d.ts")
-      --no-types       Skip type generation
   -h, --help             Show help for command
 
 EXAMPLES
@@ -46,7 +43,7 @@ const CustomTypeSchema = v.object({
 
 export async function pageTypeAddFieldColor(): Promise<void> {
 	const {
-		values: { help, tab, label, placeholder, types, "no-types": noTypes },
+		values: { help, tab, label, placeholder, types },
 		positionals: [typeId, fieldId],
 	} = parseArgs({
 		args: process.argv.slice(5), // skip: node, script, "page-type", "add-field", "color"
@@ -55,7 +52,6 @@ export async function pageTypeAddFieldColor(): Promise<void> {
 			label: { type: "string", short: "l" },
 			placeholder: { type: "string", short: "p" },
 			types: { type: "string" },
-			"no-types": { type: "boolean" },
 			help: { type: "boolean", short: "h" },
 		},
 		allowPositionals: true,
@@ -162,13 +158,11 @@ export async function pageTypeAddFieldColor(): Promise<void> {
 
 	console.info(`Added field "${fieldId}" (Color) to "${targetTab}" tab in ${typeId}`);
 
-	if (!noTypes) {
-		try {
-			await buildTypes({ output: types });
-			console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
-		} catch (error) {
-			console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
-		}
+	try {
+		await buildTypes({ output: types });
+		console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
+	} catch (error) {
+		console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
 	}
 
 	console.info();

package/src/page-type-add-field-date.ts

@@ -19,15 +19,12 @@ ARGUMENTS
   type-id                Page type identifier (required)
   field-id               Field identifier (required)
 
-Types are generated by default after changes. Use --no-types to skip.
-
 FLAGS
   -t, --tab string       Target tab (default: first existing tab, or "Main")
   -l, --label string     Display label for the field (inferred from field-id if omitted)
   -p, --placeholder string Placeholder text
       --default string   Default date value (YYYY-MM-DD format)
       --types string   Output file for generated types (default: "prismicio-types.d.ts")
-      --no-types       Skip type generation
   -h, --help             Show help for command
 
 EXAMPLES
@@ -47,7 +44,7 @@ const CustomTypeSchema = v.object({
 
 export async function pageTypeAddFieldDate(): Promise<void> {
 	const {
-		values: { help, tab, label, placeholder, default: defaultValue, types, "no-types": noTypes },
+		values: { help, tab, label, placeholder, default: defaultValue, types },
 		positionals: [typeId, fieldId],
 	} = parseArgs({
 		args: process.argv.slice(5), // skip: node, script, "page-type", "add-field", "date"
@@ -57,7 +54,6 @@ export async function pageTypeAddFieldDate(): Promise<void> {
 			placeholder: { type: "string", short: "p" },
 			default: { type: "string" },
 			types: { type: "string" },
-			"no-types": { type: "boolean" },
 			help: { type: "boolean", short: "h" },
 		},
 		allowPositionals: true,
@@ -165,13 +161,11 @@ export async function pageTypeAddFieldDate(): Promise<void> {
 
 	console.info(`Added field "${fieldId}" (Date) to "${targetTab}" tab in ${typeId}`);
 
-	if (!noTypes) {
-		try {
-			await buildTypes({ output: types });
-			console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
-		} catch (error) {
-			console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
-		}
+	try {
+		await buildTypes({ output: types });
+		console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
+	} catch (error) {
+		console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
 	}
 
 	console.info();