better opt dependency handling

Author: claytercek

.changeset/many-brooms-lay.md

@@ -0,0 +1,5 @@
+---
+"@bluecadet/launchpad-content": patch
+---
+
+Better optional dependency handling, with more descriptive error messages

package-lock.json

@@ -29,8 +29,6 @@
   "homepage": "https://github.com/bluecadet/launchpad/packages/content",
   "dependencies": {
     "@bluecadet/launchpad-utils": "~2.0.1",
-    "@portabletext/to-html": "2.0.0",
-    "@sanity/block-content-to-markdown": "^0.0.5",
     "chalk": "^5.0.0",
     "glob": "^11.0.0",
     "jsonpath-plus": "^10.3.0",
@@ -43,13 +41,21 @@
     "zod": "^3.23.8"
   },
   "peerDependencies": {
+    "@portabletext/to-html": "2.0.0",
+    "@sanity/block-content-to-markdown": "^0.0.5",
     "@sanity/client": "^6.4.9",
     "@sanity/image-url": "^1.1.0",
     "airtable": "^0.11.1",
     "contentful": "^9.0.0",
     "sharp": "^0.33.5"
   },
   "peerDependenciesMeta": {
+    "@portabletext/to-html": {
+      "optional": true
+    },
+    "@sanity/block-content-to-markdown": {
+      "optional": true
+    },
     "@sanity/client": {
       "optional": true
     },
@@ -69,6 +75,8 @@
   "devDependencies": {
     "@bluecadet/launchpad-testing": "0.1.0",
     "@bluecadet/launchpad-tsconfig": "0.1.0",
+    "@portabletext/to-html": "2.0.0",
+    "@sanity/block-content-to-markdown": "^0.0.5",
     "@sanity/client": "^6.4.9",
     "@sanity/image-url": "^1.1.0",
     "@types/markdown-it": "^14.1.2",

packages/content/package.json

@@ -1,4 +1,3 @@
-import imageUrlBuilder from "@sanity/image-url";
 import type { ImageUrlBuilder } from "@sanity/image-url/lib/types/builder.js";
 import type {
 	SanityAsset,
@@ -36,6 +35,19 @@ const sanityImageUrlTransformSchema = z.object({
 		.describe("Function to build the image URL"),
 });
 
+
+function tryImportSanityImage() {
+	try {
+		return import("@sanity/image-url");
+	} catch (e) {
+		throw new Error(
+			'Could not find peer dependency "@sanity/image-url". Make sure you have installed it.',
+			{ cause: e },
+		);
+	}
+}
+
+
 export default function sanityImageUrlTransform(
 	options: z.input<typeof sanityImageUrlTransformSchema>,
 ) {
@@ -45,12 +57,15 @@ export default function sanityImageUrlTransform(
 		options,
 	);
 
-	const builder = imageUrlBuilder(rest);
-
 	return defineContentPlugin({
 		name: "sanity-to-html",
 		hooks: {
 			async onContentFetchDone(ctx) {
+				
+				const { default: imageUrlBuilder } = await tryImportSanityImage();
+
+				const builder = imageUrlBuilder(rest);
+
 				let transformCount = 0;
 
 				ctx.logger.info("Transforming URLs using Sanity Image URL Transform...");

packages/content/src/plugins/sanity-image-url-transform.ts

@@ -1,5 +1,3 @@
-import { toHTML } from "@portabletext/to-html";
-
 import { z } from "zod";
 import { defineContentPlugin } from "../content-plugin-driver.js";
 import { applyTransformToFiles, isBlockContent } from "../utils/content-transform-utils.js";
@@ -13,13 +11,29 @@ const sanityToHtmlSchema = z.object({
 	keys: dataKeysSchema.optional(),
 });
 
+
+function tryImportPortableText() {
+	try {
+		return import("@portabletext/to-html");
+	} catch (e) {
+		throw new Error(
+			'Could not find peer dependency "@portabletext/to-html". Make sure you have installed it.',
+			{ cause: e },
+		);
+	}
+}
+
+
 export default function sanityToHtml(options: z.input<typeof sanityToHtmlSchema>) {
 	const { path, keys } = parsePluginConfig("sanityToHtml", sanityToHtmlSchema, options);
 
 	return defineContentPlugin({
 		name: "sanity-to-html",
 		hooks: {
 			async onContentFetchDone(ctx) {
+
+				const { toHTML } = await tryImportPortableText();
+
 				let transformCount = 0;
 				ctx.logger.info("Transforming sanity blocks to HTML...");
 

packages/content/src/plugins/sanity-to-html.ts

@@ -1,5 +1,4 @@
-// @ts-expect-error - no types from this lib
-import toMarkdown from "@sanity/block-content-to-markdown";
+
 import { z } from "zod";
 import { defineContentPlugin } from "../content-plugin-driver.js";
 import { applyTransformToFiles, isBlockContent } from "../utils/content-transform-utils.js";
@@ -13,13 +12,29 @@ const sanityToMdSchema = z.object({
 	keys: dataKeysSchema.optional(),
 });
 
+
+function tryImportBlockToMd() {
+	try {
+		// @ts-expect-error - no types from this lib
+		return import("@sanity/block-content-to-markdown");
+	} catch (e) {
+		throw new Error(
+			'Could not find peer dependency "@sanity/block-content-to-markdown". Make sure you have installed it.',
+			{ cause: e },
+		);
+	}
+}
+
+
 export default function sanityToMd(options: z.input<typeof sanityToMdSchema>) {
 	const { path, keys } = parsePluginConfig("sanityToMd", sanityToMdSchema, options);
 
 	return defineContentPlugin({
 		name: "sanity-to-markdown",
 		hooks: {
 			async onContentFetchDone(ctx) {
+				const { toMarkdown } = await tryImportBlockToMd();
+
 				let transformCount = 0;
 				ctx.logger.info("Transforming sanity blocks to markdown...");
 

packages/content/src/plugins/sanity-to-markdown.ts

@@ -3,7 +3,7 @@ import path from "node:path";
 import { pipeline } from "node:stream/promises";
 import chalk from "chalk";
 import PQueue from "p-queue";
-import Sharp from "sharp";
+import type SharpType from "sharp";
 import { z } from "zod";
 import { defineContentPlugin } from "../content-plugin-driver.js";
 import { getMatchingDocuments, regexToJSONPathQuery } from "../utils/content-transform-utils.js";
@@ -38,15 +38,29 @@ const sharpPluginSchema = z.object({
 		.describe("Update URLs in the content to point to the transformed images"),
 	/** The sharp transform to apply to the images. */
 	buildTransform: z
-		.function(z.tuple([z.custom<Sharp.Sharp>()]))
-		.returns(z.custom<Sharp.Sharp>())
+		.function(z.tuple([z.custom<SharpType.Sharp>()]))
+		.returns(z.custom<SharpType.Sharp>())
 		.describe("The sharp transform to apply to the images."),
 	/** The number of images to transform concurrently. Defaults to 4. */
 	concurrency: z.number().default(4).describe("The number of images to transform concurrently."),
 });
 
+
+
+function tryImportSharp() {
+	try {
+		return import("sharp");
+	} catch (e) {
+		throw new Error(
+			'Could not find peer dependency "sharp". Make sure you have installed it.',
+			{ cause: e },
+		);
+	}
+}
+
+
 async function transformImage(
-	sharpTransform: Sharp.Sharp,
+	sharpTransform: SharpType.Sharp,
 	sourceImagePath: string,
 	outputImagePath: string,
 	backupImagePath: string,
@@ -101,6 +115,8 @@ export default function sharp(options: z.input<typeof sharpPluginSchema>) {
 		name: "sharp",
 		hooks: {
 			async onContentFetchDone(ctx) {
+				const { default: Sharp } = await tryImportSharp();
+
 				const matchingDocuments = getMatchingDocuments(ctx.data, resolvedConfig.keys);
 
 				if (matchingDocuments.isErr()) {
@@ -208,7 +224,7 @@ export default function sharp(options: z.input<typeof sharpPluginSchema>) {
 	});
 }
 
-function getOutputFilename(inputPath: string, sharpTransform: Sharp.Sharp) {
+function getOutputFilename(inputPath: string, sharpTransform: SharpType.Sharp) {
 	const { dir, name, ext } = path.parse(inputPath);
 
 	// 'options' is a private property, so we need to use Object.getOwnPropertyDescriptor