@savvy-web/silk-effects 5.0.1 → 5.1.0

package/changesets/services/release-planner.js

@@ -49,7 +49,7 @@ function makeShape(inspector, fs) {
 			reason: errMsg(e)
 		})
 	});
-	const preview = (root) => previewEffect(root, fs);
+	const preview = (root, options) => previewEffect(root, options?.changelogModules, fs);
 	const apply = (root, options) => applyEffect(root, options?.dryRun ?? false, options?.changelogModules, inspector, fs);
 	return {
 		plan,
@@ -78,6 +78,44 @@ function makeReleasePlannerTest(fixed) {
 		apply: () => fixed.apply ? Effect.succeed(fixed.apply) : fail("apply")
 	});
 }
+/**
+* Rewrite the engine config for a caller that supplies its own changelog module
+* paths: `config.changelog[0]` becomes the mapped absolute path and the engine's
+* `format` integration is switched off.
+*
+* @remarks
+* Shared by `preview` and `apply` — both hand the result to
+* `applyReleasePlan`, and both are called from no-`node_modules` contexts where
+* neither the configured id nor a formatter can be resolved. An unmapped id
+* fails typed (naming the supported keys) rather than reaching
+* `import-meta-resolve`, which reports it as `expected to be defined`.
+*
+* Exported for tests only — not re-exported from the package index, so it is
+* not public API. Driving it directly is the only deterministic way to assert
+* the `format: false` half: every formatter the changesets config accepts
+* either shells out through `npx` (network) or to an ambient binary, so a
+* fixture that names one passes or fails on what the machine happens to have
+* installed rather than on this rewrite.
+*/
+function withChangelogModules(config, changelogModules, phase) {
+	const unformatted = {
+		...config,
+		format: false
+	};
+	if (!Array.isArray(config.changelog)) return Effect.succeed(unformatted);
+	const configuredId = config.changelog[0];
+	if (!Object.hasOwn(changelogModules, configuredId)) {
+		const supported = Object.keys(changelogModules).join(", ");
+		return Effect.fail(new ReleasePlanError({
+			phase,
+			reason: `changelog id "${configuredId}" is not in changelogModules (supported: ${supported})`
+		}));
+	}
+	return Effect.succeed({
+		...unformatted,
+		changelog: [changelogModules[configuredId], config.changelog[1]]
+	});
+}
 /** Extract the `## <version>` block (down to the next H2 or EOF) from a changelog. */
 function extractVersionBlock(changelog, version) {
 	const lines = changelog.split("\n");
@@ -105,7 +143,7 @@ function maintenanceReasons(plan, config) {
 * scope-managed temp directory (cleaned up automatically when the scope
 * closes) and reading the generated CHANGELOG blocks back.
 */
-function previewEffect(root, fs) {
+function previewEffect(root, changelogModules, fs) {
 	const program = Effect.gen(function* () {
 		const [plan, packages] = yield* Effect.tryPromise({
 			try: () => Promise.all([getReleasePlan(root), getPackages(root)]),
@@ -128,6 +166,7 @@ function previewEffect(root, fs) {
 		});
 		yield* Effect.forEach(warnings, (w) => Effect.logWarning(w));
 		const reasonByName = maintenanceReasons(plan, config);
+		const engineConfig = changelogModules ? yield* withChangelogModules(config, changelogModules, "preview") : config;
 		const preMode = plan.preState ? plan.preState.mode : null;
 		const changesets = plan.changesets.map((cs) => ({
 			id: cs.id,
@@ -180,7 +219,7 @@ function previewEffect(root, fs) {
 		const rootCl = join(packages.rootDir, "CHANGELOG.md");
 		if (yield* fs.exists(rootCl)) yield* fs.copyFile(rootCl, join(tempRoot, "CHANGELOG.md"));
 		yield* Effect.tryPromise({
-			try: () => applyReleasePlan(plan, tempPackages, config, void 0, root),
+			try: () => applyReleasePlan(plan, tempPackages, engineConfig, void 0, root),
 			catch: (e) => new ReleasePlanError({
 				phase: "preview",
 				reason: errMsg(e)
@@ -250,28 +289,7 @@ function applyEffect(root, dryRun, changelogModules, inspector, fs) {
 			})
 		});
 		yield* Effect.forEach(warnings, (w) => Effect.logWarning(w));
-		let engineConfig = config;
-		if (changelogModules) {
-			engineConfig = {
-				...config,
-				format: false
-			};
-			if (Array.isArray(config.changelog)) {
-				const configuredId = config.changelog[0];
-				const mapped = changelogModules[configuredId];
-				if (mapped === void 0) {
-					const supported = Object.keys(changelogModules).join(", ");
-					return yield* Effect.fail(new ReleasePlanError({
-						phase: "apply",
-						reason: `changelog id "${configuredId}" is not in changelogModules (supported: ${supported})`
-					}));
-				}
-				engineConfig = {
-					...engineConfig,
-					changelog: [mapped, config.changelog[1]]
-				};
-			}
-		}
+		const engineConfig = changelogModules ? yield* withChangelogModules(config, changelogModules, "apply") : config;
 		const releases = plan.releases.filter((r) => r.type !== "none").map((r) => ({
 			name: r.name,
 			type: r.type,
@@ -337,4 +355,4 @@ function applyEffect(root, dryRun, changelogModules, inspector, fs) {
 }
 
 //#endregion
-export { ReleasePlanner, ReleasePlannerLive, extractVersionBlock, makeReleasePlannerTest };
+export { ReleasePlanner, ReleasePlannerLive, extractVersionBlock, makeReleasePlannerTest, withChangelogModules };

package/index.d.ts

@@ -3899,8 +3899,22 @@ type AppliedRelease = Schema.Schema.Type<typeof AppliedReleaseSchema>;
 interface ReleasePlannerShape {
   /** Compute the in-memory release plan (read-only). */
   readonly plan: (root: string) => Effect.Effect<ReleasePlan, ReleasePlanError>;
-  /** Render a non-destructive preview of the next release. */
-  readonly preview: (root: string) => Effect.Effect<ChangesetPreview, ReleasePlanError>;
+  /**
+   * Render a non-destructive preview of the next release.
+   *
+   * @remarks
+   * Rendering `changelogEntry` means resolving the configured changelog module,
+   * so `changelogModules` matters here for the same reason it does on `apply`.
+   */
+  readonly preview: (root: string, options?: {
+    /**
+     * Map configured changelog ids to absolute module paths. When set,
+     * `config.changelog[0]` must be a key of this map (rewritten before the
+     * engine call; unmapped ids fail) and the engine's `format` integration
+     * is disabled — callers in no-`node_modules` contexts own formatting.
+     */
+    readonly changelogModules?: Readonly<Record<string, string>>;
+  }) => Effect.Effect<ChangesetPreview, ReleasePlanError>;
   /** Natively apply the release (destructive unless `dryRun`). */
   readonly apply: (root: string, options?: {
     readonly dryRun?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@savvy-web/silk-effects",
-	"version": "5.0.1",
+	"version": "5.1.0",
 	"private": false,
 	"description": "Shared Effect library for Silk Suite conventions",
 	"homepage": "https://github.com/savvy-web/systems/tree/main/packages/silk-effects",