@savvy-web/changesets 0.4.2 → 0.5.1

package/README.md

@@ -14,6 +14,7 @@ Custom changelog formatter and markdown processing pipeline for the Silk Suite.
 - **GitHub integration** -- Automatic PR links, commit references, and contributor attribution
 - **Version file syncing** -- Bump version fields in additional JSON files using glob patterns and JSONPath expressions
 - **Editor support** -- markdownlint rules for real-time validation in VS Code and CI
+- **Dependency table format** -- Structured GFM tables for tracking dependency changes with automatic collapse, sort, and aggregation
 - **AI-agent-friendly errors** -- All lint and validation errors include inline fix instructions and documentation links, so AI agents can resolve issues without examining source code
 
 ## Installation
@@ -58,6 +59,21 @@ Added a new authentication system with OAuth2 support.
 - Updated integration test fixtures
 ```
 
+Dependency updates use a structured table format:
+
+```markdown
+---
+"@my/package": patch
+---
+
+## Dependencies
+
+| Dependency | Type | Action | From | To |
+| :--- | :--- | :--- | :--- | :--- |
+| lodash | dependency | updated | ^4.17.20 | ^4.17.21 |
+| prettier | devDependency | added | — | ^3.0.0 |
+```
+
 ## Documentation
 
 - [Section-Aware Pipeline](./docs/section-aware-pipeline.md) -- End-to-end walkthrough of how section-aware changesets flow through the pipeline

package/cjs/changelog.cjs

@@ -165,6 +165,24 @@ var __webpack_modules__ = {
         }
         effect__rspack_import_0.Data.TaggedError("VersionFileError");
     },
+    "./src/schemas/dependency-table.ts" (__unused_rspack_module, __webpack_exports__, __webpack_require__) {
+        __webpack_require__.d(__webpack_exports__, {
+            n8: ()=>DependencyTableRowSchema
+        });
+        var effect__rspack_import_0 = __webpack_require__("effect");
+        var _primitives_js__rspack_import_1 = __webpack_require__("./src/schemas/primitives.ts");
+        const DependencyActionSchema = effect__rspack_import_0.Schema.Literal("added", "updated", "removed");
+        const DependencyTableTypeSchema = effect__rspack_import_0.Schema.Literal("dependency", "devDependency", "peerDependency", "optionalDependency", "workspace", "config");
+        const VersionOrEmptySchema = effect__rspack_import_0.Schema.String.pipe(effect__rspack_import_0.Schema.pattern(/^(\u2014|[~^]?\d+\.\d+\.\d+(?:[-+.][\w.+-]*)?)$/));
+        const DependencyTableRowSchema = effect__rspack_import_0.Schema.Struct({
+            dependency: _primitives_js__rspack_import_1.u,
+            type: DependencyTableTypeSchema,
+            action: DependencyActionSchema,
+            from: VersionOrEmptySchema,
+            to: VersionOrEmptySchema
+        });
+        effect__rspack_import_0.Schema.Array(DependencyTableRowSchema).pipe(effect__rspack_import_0.Schema.minItems(1));
+    },
     "./src/schemas/github.ts" (__unused_rspack_module, __webpack_exports__, __webpack_require__) {
         __webpack_require__.d(__webpack_exports__, {
             lo: ()=>GitHubInfoSchema
@@ -249,10 +267,11 @@ var __webpack_modules__ = {
     },
     "./src/schemas/primitives.ts" (__unused_rspack_module, __webpack_exports__, __webpack_require__) {
         __webpack_require__.d(__webpack_exports__, {
-            e: ()=>PositiveInteger
+            e: ()=>PositiveInteger,
+            u: ()=>NonEmptyString
         });
         var effect__rspack_import_0 = __webpack_require__("effect");
-        effect__rspack_import_0.Schema.String.pipe(effect__rspack_import_0.Schema.minLength(1));
+        const NonEmptyString = effect__rspack_import_0.Schema.String.pipe(effect__rspack_import_0.Schema.minLength(1));
         const PositiveInteger = effect__rspack_import_0.Schema.Number.pipe(effect__rspack_import_0.Schema.int(), effect__rspack_import_0.Schema.positive());
     },
     "./src/schemas/version-files.ts" (__unused_rspack_module, __webpack_exports__, __webpack_require__) {
@@ -312,6 +331,74 @@ var __webpack_modules__ = {
             stringify: (tree)=>effect__rspack_import_0.Effect.sync(()=>(0, _utils_remark_pipeline_js__rspack_import_1.FH)(tree))
         });
     },
+    "./src/utils/dependency-table.ts" (__unused_rspack_module, __webpack_exports__, __webpack_require__) {
+        __webpack_require__.d(__webpack_exports__, {
+            S8: ()=>serializeDependencyTableToMarkdown
+        });
+        var effect__rspack_import_0 = __webpack_require__("effect");
+        __webpack_require__("mdast-util-to-string");
+        var remark_gfm__rspack_import_2 = __webpack_require__("remark-gfm");
+        var remark_gfm__rspack_import_2_default = /*#__PURE__*/ __webpack_require__.n(remark_gfm__rspack_import_2);
+        var remark_stringify__rspack_import_3 = __webpack_require__("remark-stringify");
+        var remark_stringify__rspack_import_3_default = /*#__PURE__*/ __webpack_require__.n(remark_stringify__rspack_import_3);
+        var unified__rspack_import_4 = __webpack_require__("unified");
+        var _schemas_dependency_table_js__rspack_import_5 = __webpack_require__("./src/schemas/dependency-table.ts");
+        const COLUMN_HEADERS = [
+            "Dependency",
+            "Type",
+            "Action",
+            "From",
+            "To"
+        ];
+        const COLUMN_KEYS = [
+            "dependency",
+            "type",
+            "action",
+            "from",
+            "to"
+        ];
+        effect__rspack_import_0.Schema.decodeUnknownSync(_schemas_dependency_table_js__rspack_import_5.n8);
+        function makeCell(text) {
+            return {
+                type: "tableCell",
+                children: [
+                    {
+                        type: "text",
+                        value: text
+                    }
+                ]
+            };
+        }
+        function makeRow(texts) {
+            return {
+                type: "tableRow",
+                children: texts.map(makeCell)
+            };
+        }
+        function serializeDependencyTable(rows) {
+            const headerRow = makeRow([
+                ...COLUMN_HEADERS
+            ]);
+            const dataRows = rows.map((row)=>makeRow(COLUMN_KEYS.map((key)=>row[key])));
+            return {
+                type: "table",
+                children: [
+                    headerRow,
+                    ...dataRows
+                ]
+            };
+        }
+        function serializeDependencyTableToMarkdown(rows) {
+            const table = serializeDependencyTable(rows);
+            const tree = {
+                type: "root",
+                children: [
+                    table
+                ]
+            };
+            return (0, unified__rspack_import_4.unified)().use(remark_gfm__rspack_import_2_default()).use(remark_stringify__rspack_import_3_default()).stringify(tree).trim();
+        }
+    },
     "./src/utils/markdown-link.ts" (__unused_rspack_module, __webpack_exports__, __webpack_require__) {
         __webpack_require__.d(__webpack_exports__, {
             W: ()=>extractUrlFromMarkdown,
@@ -416,44 +503,45 @@ var __webpack_exports__ = {};
     var schemas_options = __webpack_require__("./src/schemas/options.ts");
     var services_github = __webpack_require__("./src/services/github.ts");
     var markdown = __webpack_require__("./src/services/markdown.ts");
-    function logWarning(message, ...args) {
-        if ("u" > typeof process && process.env.VITEST) return;
-        if ("u" > typeof process && "true" === process.env.GITHUB_ACTIONS) {
-            const text = args.length > 0 ? `${message} ${args.join(" ")}` : message;
-            console.warn(`::warning::${text}`);
-        } else console.warn(message, ...args);
+    var dependency_table = __webpack_require__("./src/utils/dependency-table.ts");
+    const FIELD_MAP = [
+        [
+            "dependencies",
+            "dependency"
+        ],
+        [
+            "devDependencies",
+            "devDependency"
+        ],
+        [
+            "peerDependencies",
+            "peerDependency"
+        ],
+        [
+            "optionalDependencies",
+            "optionalDependency"
+        ]
+    ];
+    function inferDependencyType(dep) {
+        const pkg = dep.packageJson;
+        for (const [field, type] of FIELD_MAP){
+            const section = pkg[field];
+            if ("object" == typeof section && null !== section && dep.name in section) return type;
+        }
+        return "dependency";
     }
-    function getDependencyReleaseLine(changesets, dependenciesUpdated, options) {
+    function getDependencyReleaseLine(_changesets, dependenciesUpdated, _options) {
         return external_effect_.Effect.gen(function*() {
             if (0 === dependenciesUpdated.length) return "";
-            const github = yield* services_github.Xx;
-            let apiFailures = 0;
-            const totalWithCommit = changesets.filter((cs)=>cs.commit).length;
-            const commitLinks = yield* external_effect_.Effect.forEach(changesets, (cs)=>{
-                const commit = cs.commit;
-                if (!commit) return external_effect_.Effect.succeed(null);
-                return github.getInfo({
-                    commit,
-                    repo: options.repo
-                }).pipe(external_effect_.Effect.map((info)=>info.links.commit), external_effect_.Effect.catchAll((error)=>{
-                    apiFailures++;
-                    logWarning(`Failed to fetch GitHub info for commit ${commit}:`, String(error));
-                    return external_effect_.Effect.succeed(`[\`${commit.substring(0, 7)}\`](https://github.com/${options.repo}/commit/${commit})`);
+            yield* services_github.Xx;
+            const rows = dependenciesUpdated.map((dep)=>({
+                    dependency: dep.name,
+                    type: inferDependencyType(dep),
+                    action: "updated",
+                    from: dep.oldVersion,
+                    to: dep.newVersion
                 }));
-            }, {
-                concurrency: 10
-            });
-            if (apiFailures > 0) {
-                const successRate = ((totalWithCommit - apiFailures) / totalWithCommit * 100).toFixed(1);
-                logWarning(`GitHub API calls completed with ${apiFailures}/${totalWithCommit} failures (${successRate}% success rate)`);
-            }
-            const validLinks = commitLinks.filter(Boolean);
-            const changesetLink = validLinks.length > 0 ? `- Updated dependencies [${validLinks.join(", ")}]:` : "- Updated dependencies:";
-            const updatedDependenciesList = dependenciesUpdated.map((dep)=>`  - ${dep.name}@${dep.newVersion}`);
-            return [
-                changesetLink,
-                ...updatedDependenciesList
-            ].join("\n");
+            return (0, dependency_table.S8)(rows);
         });
     }
     var categories = __webpack_require__("./src/categories/index.ts");
@@ -495,6 +583,13 @@ var __webpack_exports__ = {};
             refs: extractIssueNumbers(REFS_ISSUE_PATTERN, commitMessage)
         };
     }
+    function logWarning(message, ...args) {
+        if ("u" > typeof process && process.env.VITEST) return;
+        if ("u" > typeof process && "true" === process.env.GITHUB_ACTIONS) {
+            const text = args.length > 0 ? `${message} ${args.join(" ")}` : message;
+            console.warn(`::warning::${text}`);
+        } else console.warn(message, ...args);
+    }
     var external_mdast_util_to_string_ = __webpack_require__("mdast-util-to-string");
     var remark_pipeline = __webpack_require__("./src/utils/remark-pipeline.ts");
     function parseChangesetSections(summary) {

package/cjs/changelog.d.cts

@@ -1,8 +1,22 @@
 /**
- * Changesets API changelog formatter.
+ * Changesets API changelog formatter — `\@savvy-web/changesets/changelog`
  *
- * This module exports the `ChangelogFunctions` required by the Changesets API.
- * Configure in `.changeset/config.json`:
+ * 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
  * {
@@ -10,11 +24,46 @@
  * }
  * ```
  *
+ * 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 commit links and 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
+ *
  * @packageDocumentation
  */
 
 import { ChangelogFunctions } from '@changesets/types';
 
+/**
+ * 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
+ */
 declare const changelogFunctions: ChangelogFunctions;
 export default changelogFunctions;