@savvy-web/silk 2.0.0 → 2.1.0

package/packages/silk-effects/dist/dev/pkg/changesets/changelog/getReleaseLine.js

@@ -1,122 +0,0 @@
-import { resolveCommitType } from "../categories/index.js";
-import { GitHubService } from "../services/github.js";
-import { GitHubInfoSchema } from "../schemas/github.js";
-import { parseCommitMessage } from "../utils/commit-parser.js";
-import { parseIssueReferences } from "../utils/issue-refs.js";
-import { logWarning } from "../utils/logger.js";
-import { parseChangesetSections } from "../utils/section-parser.js";
-import { formatChangelogEntry, formatPRAndUserAttribution } from "./formatting.js";
-import { Effect, Schema } from "effect";
-
-//#region ../silk-effects/dist/dev/pkg/changesets/changelog/getReleaseLine.js
-/**
-* Core formatter: getReleaseLine.
-*
-* Formats a single changeset into a changelog entry. This is the primary
-* formatting function in the changelog pipeline, responsible for transforming
-* a `NewChangesetWithCommit` into structured markdown output.
-*
-* @remarks
-* The formatter supports two distinct input modes:
-*
-* 1. **Section-aware changesets** — When the changeset summary contains h2
-*    headings (e.g., `## Features`, `## Bug Fixes`), each section is rendered
-*    as an h3 heading with list items beneath it. This mode
-*    produces multi-line output suitable for rich changelogs.
-*
-* 2. **Flat-text changesets** — When the summary is plain text without section
-*    headings, the formatter falls back to backward-compatible single-line
-*    output. The conventional commit type is resolved via `resolveCommitType`
-*    to determine the changelog category.
-*
-* In both modes, the formatter:
-* - Fetches GitHub metadata (PR number, author) via {@link GitHubService}
-* - Extracts and renders issue references (Closes, Fixes, Refs)
-* - Appends PR and user attribution when available
-*
-* @see {@link formatChangelogEntry} for the low-level entry formatting
-* @see {@link formatPRAndUserAttribution} for attribution suffix generation
-* @see {@link getDependencyReleaseLine} for the companion dependency formatter
-*
-* @internal
-*/
-/**
-* Format a single changeset into a markdown release line.
-*
-* This is the core Effect program that implements the `getReleaseLine` contract
-* from the Changesets API. It requires {@link GitHubService} in its environment
-* for resolving commit metadata.
-*
-* @remarks
-* The formatting pipeline proceeds in seven steps:
-*
-* 1. **Fetch GitHub info** — If the changeset has a commit hash, query
-*    the {@link GitHubService} for PR number, author, and links. Failures
-*    are caught and logged as warnings (attribution is simply omitted).
-* 2. **Parse sections** — Attempt to split the summary into h2-delimited
-*    sections using `parseChangesetSections`.
-* 3. **Parse conventional commit** — Extract the commit type, scope, and
-*    breaking flag from the first line of the summary.
-* 4. **Extract issue references** — Parse the body for `Closes #N`,
-*    `Fixes #N`, and `Refs #N` patterns.
-* 5. **Build attribution** — Format PR link and user credit from GitHub info.
-* 6. **Section-aware output** — If sections were found, render each as an
-*    h3 heading with list items.
-* 7. **Flat-text fallback** — Otherwise, produce a single `- entry` line
-*    with the resolved category heading.
-*
-* @param changeset - The changeset to format, including commit hash and summary text
-* @param versionType - The semantic version bump type (`major`, `minor`, or `patch`),
-*   used as fallback when no conventional commit type is detected
-* @param options - Validated configuration options (must include `repo` in `owner/repo` format)
-* @returns An `Effect` that resolves to a formatted markdown string
-*/
-function getReleaseLine(changeset, versionType, options) {
-	return Effect.gen(function* () {
-		let commitInfo = null;
-		if (changeset.commit) commitInfo = yield* (yield* GitHubService).getInfo({
-			commit: changeset.commit,
-			repo: options.repo
-		}).pipe(Effect.flatMap((raw) => Schema.decodeUnknown(GitHubInfoSchema)(raw).pipe(Effect.map(() => raw), Effect.catchAll(() => Effect.succeed(raw)))), Effect.catchAll((error) => {
-			logWarning("Could not fetch GitHub info for commit:", changeset.commit ?? "", String(error));
-			return Effect.succeed(null);
-		}));
-		const parsed = parseChangesetSections(changeset.summary);
-		const firstLine = changeset.summary.split("\n")[0];
-		const commitMsg = parseCommitMessage(firstLine);
-		const issueRefs = parseIssueReferences(changeset.summary.split("\n").slice(1).join("\n"));
-		const attribution = commitInfo ? formatPRAndUserAttribution(commitInfo.pull ?? void 0, commitInfo.user ?? void 0, commitInfo.links) : "";
-		if (parsed.sections.length > 0) {
-			const lines = [];
-			if (parsed.preamble) {
-				lines.push(parsed.preamble);
-				lines.push("");
-			}
-			for (const section of parsed.sections) {
-				lines.push(`### ${section.category.heading}`);
-				lines.push("");
-				if (section.content) {
-					const contentLines = section.content.split("\n");
-					const firstContentLine = contentLines[0];
-					if (firstContentLine.startsWith("- ") || firstContentLine.startsWith("* ")) {
-						lines.push(firstContentLine);
-						lines.push(...contentLines.slice(1));
-					} else {
-						lines.push(`- ${firstContentLine}`);
-						lines.push(...contentLines.slice(1).map((line) => line.length > 0 ? `  ${line}` : line));
-					}
-				}
-				lines.push("");
-			}
-			return `${lines.join("\n").trimEnd()}${attribution}`;
-		}
-		return `- ${formatChangelogEntry({
-			type: resolveCommitType(commitMsg.type ?? versionType, commitMsg.scope, commitMsg.breaking).heading,
-			summary: changeset.summary,
-			issues: issueRefs
-		}, { repo: options.repo })}${attribution}`;
-	});
-}
-
-//#endregion
-export { getReleaseLine };

package/packages/silk-effects/dist/dev/pkg/changesets/changelog/index.cjs

@@ -1,97 +0,0 @@
-const require_options = require('../schemas/options.cjs');
-const require_github = require('../services/github.cjs');
-const require_markdown = require('../services/markdown.cjs');
-const require_getDependencyReleaseLine = require('./getDependencyReleaseLine.cjs');
-const require_getReleaseLine = require('./getReleaseLine.cjs');
-let effect = require("effect");
-
-//#region ../silk-effects/dist/dev/pkg/changesets/changelog/index.js
-/**
-* Changesets API changelog formatter — `\@savvy-web/changesets/changelog`
-*
-* This module is the default export consumed by the Changesets CLI via the
-* `changelog` field in `.changeset/config.json`. It implements the
-* `ChangelogFunctions` interface from `\@changesets/types`, wiring the
-* Effect-based formatting pipeline into the async API that Changesets expects.
-*
-* @remarks
-* The module composes two Effect programs — {@link getReleaseLine} and
-* {@link getDependencyReleaseLine} — and runs each through
-* `Effect.runPromise` with a merged layer of {@link GitHubLive} (for commit
-* metadata) and {@link MarkdownLive} (for mdast parsing). Options are
-* validated at the boundary via `validateChangesetOptions` before being
-* passed to the formatters.
-*
-* ### Configuration
-*
-* Add the following to your `.changeset/config.json`:
-*
-* ```json
-* {
-*   "changelog": ["\@savvy-web/changesets/changelog", { "repo": "savvy-web/package-name" }]
-* }
-* ```
-*
-* The `repo` option is **required** and must be in `owner/repo` format.
-*
-* ### Pipeline
-*
-* 1. **Options validation** — the raw `options` object from the Changesets
-*    config is decoded through `ChangesetOptionsSchema`.
-* 2. **Release line formatting** — each changeset is formatted by
-*    `getReleaseLine`, which resolves GitHub metadata, parses sections,
-*    and produces structured markdown with attribution.
-* 3. **Dependency table formatting** — bulk dependency updates are
-*    formatted by `getDependencyReleaseLine` into a markdown table.
-*
-* @example Configuring in `.changeset/config.json`
-* ```json
-* {
-*   "$schema": "https://unpkg.com/\@changesets/config\@3.1.1/schema.json",
-*   "changelog": ["\@savvy-web/changesets/changelog", { "repo": "savvy-web/my-package" }],
-*   "commit": false,
-*   "access": "public"
-* }
-* ```
-*
-* @see {@link getReleaseLine} in `./getReleaseLine.ts` for individual changeset formatting
-* @see {@link getDependencyReleaseLine} in `./getDependencyReleaseLine.ts` for dependency table formatting
-*/
-/**
-* Combined layer providing all services needed by the formatters.
-*
-* Merges {@link GitHubLive} and {@link MarkdownLive} into a single layer
-* that satisfies the environment requirements of both `getReleaseLine`
-* (which needs `GitHubService` and `MarkdownService`) and
-* `getDependencyReleaseLine` (which needs `GitHubService`).
-*
-* @internal
-*/
-const MainLayer = effect.Layer.mergeAll(require_github.GitHubLive, require_markdown.MarkdownLive);
-/**
-* Changesets API `ChangelogFunctions` implementation.
-*
-* This object satisfies the `ChangelogFunctions` contract from
-* `\@changesets/types`. Each method validates options, runs the
-* corresponding Effect program with the merged service layer, and
-* returns a `Promise<string>`.
-*
-* @internal
-*/
-const changelogFunctions = {
-	getReleaseLine: async (changeset, versionType, options) => {
-		const program = effect.Effect.gen(function* () {
-			return yield* require_getReleaseLine.getReleaseLine(changeset, versionType, yield* require_options.validateChangesetOptions(options));
-		});
-		return effect.Effect.runPromise(program.pipe(effect.Effect.provide(MainLayer)));
-	},
-	getDependencyReleaseLine: async (changesets, dependenciesUpdated, options) => {
-		const program = effect.Effect.gen(function* () {
-			return yield* require_getDependencyReleaseLine.getDependencyReleaseLine(changesets, dependenciesUpdated, yield* require_options.validateChangesetOptions(options));
-		});
-		return effect.Effect.runPromise(program.pipe(effect.Effect.provide(MainLayer)));
-	}
-};
-
-//#endregion
-exports.default = changelogFunctions;

package/packages/silk-effects/dist/dev/pkg/changesets/changelog/index.js

@@ -1,97 +0,0 @@
-import { validateChangesetOptions } from "../schemas/options.js";
-import { GitHubLive } from "../services/github.js";
-import { MarkdownLive } from "../services/markdown.js";
-import { getDependencyReleaseLine } from "./getDependencyReleaseLine.js";
-import { getReleaseLine } from "./getReleaseLine.js";
-import { Effect, Layer } from "effect";
-
-//#region ../silk-effects/dist/dev/pkg/changesets/changelog/index.js
-/**
-* Changesets API changelog formatter — `\@savvy-web/changesets/changelog`
-*
-* This module is the default export consumed by the Changesets CLI via the
-* `changelog` field in `.changeset/config.json`. It implements the
-* `ChangelogFunctions` interface from `\@changesets/types`, wiring the
-* Effect-based formatting pipeline into the async API that Changesets expects.
-*
-* @remarks
-* The module composes two Effect programs — {@link getReleaseLine} and
-* {@link getDependencyReleaseLine} — and runs each through
-* `Effect.runPromise` with a merged layer of {@link GitHubLive} (for commit
-* metadata) and {@link MarkdownLive} (for mdast parsing). Options are
-* validated at the boundary via `validateChangesetOptions` before being
-* passed to the formatters.
-*
-* ### Configuration
-*
-* Add the following to your `.changeset/config.json`:
-*
-* ```json
-* {
-*   "changelog": ["\@savvy-web/changesets/changelog", { "repo": "savvy-web/package-name" }]
-* }
-* ```
-*
-* The `repo` option is **required** and must be in `owner/repo` format.
-*
-* ### Pipeline
-*
-* 1. **Options validation** — the raw `options` object from the Changesets
-*    config is decoded through `ChangesetOptionsSchema`.
-* 2. **Release line formatting** — each changeset is formatted by
-*    `getReleaseLine`, which resolves GitHub metadata, parses sections,
-*    and produces structured markdown with attribution.
-* 3. **Dependency table formatting** — bulk dependency updates are
-*    formatted by `getDependencyReleaseLine` into a markdown table.
-*
-* @example Configuring in `.changeset/config.json`
-* ```json
-* {
-*   "$schema": "https://unpkg.com/\@changesets/config\@3.1.1/schema.json",
-*   "changelog": ["\@savvy-web/changesets/changelog", { "repo": "savvy-web/my-package" }],
-*   "commit": false,
-*   "access": "public"
-* }
-* ```
-*
-* @see {@link getReleaseLine} in `./getReleaseLine.ts` for individual changeset formatting
-* @see {@link getDependencyReleaseLine} in `./getDependencyReleaseLine.ts` for dependency table formatting
-*/
-/**
-* Combined layer providing all services needed by the formatters.
-*
-* Merges {@link GitHubLive} and {@link MarkdownLive} into a single layer
-* that satisfies the environment requirements of both `getReleaseLine`
-* (which needs `GitHubService` and `MarkdownService`) and
-* `getDependencyReleaseLine` (which needs `GitHubService`).
-*
-* @internal
-*/
-const MainLayer = Layer.mergeAll(GitHubLive, MarkdownLive);
-/**
-* Changesets API `ChangelogFunctions` implementation.
-*
-* This object satisfies the `ChangelogFunctions` contract from
-* `\@changesets/types`. Each method validates options, runs the
-* corresponding Effect program with the merged service layer, and
-* returns a `Promise<string>`.
-*
-* @internal
-*/
-const changelogFunctions = {
-	getReleaseLine: async (changeset, versionType, options) => {
-		const program = Effect.gen(function* () {
-			return yield* getReleaseLine(changeset, versionType, yield* validateChangesetOptions(options));
-		});
-		return Effect.runPromise(program.pipe(Effect.provide(MainLayer)));
-	},
-	getDependencyReleaseLine: async (changesets, dependenciesUpdated, options) => {
-		const program = Effect.gen(function* () {
-			return yield* getDependencyReleaseLine(changesets, dependenciesUpdated, yield* validateChangesetOptions(options));
-		});
-		return Effect.runPromise(program.pipe(Effect.provide(MainLayer)));
-	}
-};
-
-//#endregion
-export { changelogFunctions as default };

package/packages/silk-effects/dist/dev/pkg/changesets/constants.cjs

@@ -1,43 +0,0 @@
-
-//#region ../silk-effects/dist/dev/pkg/changesets/constants.js
-/**
-* Constants for changeset lint rule documentation URLs.
-*
-* @remarks
-* Each lint rule in the \@savvy-web/changesets remark-lint plugin has a
-* corresponding documentation page hosted on GitHub. These URLs are
-* referenced in lint diagnostic messages to help users understand and
-* resolve validation errors.
-*
-* Rule codes follow the `CSH` prefix convention:
-* - `CSH001` -- Changeset heading validation
-* - `CSH002` -- Changeset summary validation
-* - `CSH003` -- Dependency table structure validation
-* - `CSH004` -- Changeset body content validation
-* - `CSH005` -- Frontmatter validation
-*
-* @internal
-*/
-/** Base URL for rule documentation on GitHub. */
-const DOCS_BASE = "https://github.com/savvy-web/changesets/blob/main/docs/rules";
-/**
-* Documentation URLs for each changeset lint rule.
-*
-* @remarks
-* Keyed by rule code (`CSH001`--`CSH005`). Each value is a full URL
-* pointing to the rule's documentation page on GitHub. Used by the
-* remark-lint plugins to attach documentation links to diagnostic
-* messages.
-*
-* @internal
-*/
-const RULE_DOCS = {
-	CSH001: `${DOCS_BASE}/CSH001.md`,
-	CSH002: `${DOCS_BASE}/CSH002.md`,
-	CSH003: `${DOCS_BASE}/CSH003.md`,
-	CSH004: `${DOCS_BASE}/CSH004.md`,
-	CSH005: `${DOCS_BASE}/CSH005.md`
-};
-
-//#endregion
-exports.RULE_DOCS = RULE_DOCS;

package/packages/silk-effects/dist/dev/pkg/changesets/constants.js

@@ -1,42 +0,0 @@
-//#region ../silk-effects/dist/dev/pkg/changesets/constants.js
-/**
-* Constants for changeset lint rule documentation URLs.
-*
-* @remarks
-* Each lint rule in the \@savvy-web/changesets remark-lint plugin has a
-* corresponding documentation page hosted on GitHub. These URLs are
-* referenced in lint diagnostic messages to help users understand and
-* resolve validation errors.
-*
-* Rule codes follow the `CSH` prefix convention:
-* - `CSH001` -- Changeset heading validation
-* - `CSH002` -- Changeset summary validation
-* - `CSH003` -- Dependency table structure validation
-* - `CSH004` -- Changeset body content validation
-* - `CSH005` -- Frontmatter validation
-*
-* @internal
-*/
-/** Base URL for rule documentation on GitHub. */
-const DOCS_BASE = "https://github.com/savvy-web/changesets/blob/main/docs/rules";
-/**
-* Documentation URLs for each changeset lint rule.
-*
-* @remarks
-* Keyed by rule code (`CSH001`--`CSH005`). Each value is a full URL
-* pointing to the rule's documentation page on GitHub. Used by the
-* remark-lint plugins to attach documentation links to diagnostic
-* messages.
-*
-* @internal
-*/
-const RULE_DOCS = {
-	CSH001: `${DOCS_BASE}/CSH001.md`,
-	CSH002: `${DOCS_BASE}/CSH002.md`,
-	CSH003: `${DOCS_BASE}/CSH003.md`,
-	CSH004: `${DOCS_BASE}/CSH004.md`,
-	CSH005: `${DOCS_BASE}/CSH005.md`
-};
-
-//#endregion
-export { RULE_DOCS };