changeset_generator.ts

Declarations
#

Auto-generation of changesets for dependency updates during publishing.

Creates changesets when packages need to republish due to updated dependencies. For parsing existing changesets, see changeset_reader.ts.

4 declarations

view source

create_changeset_for_dependency_updates
#

changeset_generator.ts view source

(repo: LocalRepo, updates: DependencyVersionChange[], options?: { log?: Logger | undefined; }): Promise<string>

Creates a changeset file for dependency updates. Returns the path to the created changeset file.

repo

updates

type DependencyVersionChange[]

options

type { log?: Logger | undefined; }
default {}

returns

Promise<string>

create_dependency_updates
#

changeset_generator.ts view source

(dependencies: Map<string, string>, published_versions: Map<string, PublishedVersion>): DependencyVersionChange[]

dependencies

type Map<string, string>

published_versions

type Map<string, PublishedVersion>

returns

DependencyVersionChange[]

DependencyVersionChange
#

changeset_generator.ts view source

DependencyVersionChange

package_name

type string

from_version

type string

to_version

type string

bump_type

type 'major' | 'minor' | 'patch'

breaking

type boolean

generate_changeset_content
#

changeset_generator.ts view source

(package_name: string, updates: DependencyVersionChange[], bump_type: "major" | "minor" | "patch"): string

Generates markdown changeset content for dependency updates.

Creates properly formatted changeset with YAML frontmatter, summary, and categorized list of breaking vs regular updates. Output format matches changesets CLI for consistency.

package_name

package receiving the dependency updates

type string

updates

list of dependency changes with version info

type DependencyVersionChange[]

bump_type

required bump type (calculated from breaking changes)

type "major" | "minor" | "patch"

returns

string

markdown content ready to write to .changeset/*.md file

Depends on
#

Imported by
#