publishing_plan.ts

Declarations
#

11 declarations

view source

DependencyUpdate
#

publishing_plan.ts view source

DependencyUpdate

dependent_package

type string

updated_dependency

type string

current_version

type string

new_version

type string

type

type 'dependencies' | 'devDependencies' | 'peerDependencies'

causes_republish

type boolean

generate_publishing_plan
#

publishing_plan.ts view source

(repos: LocalRepo[], options?: GeneratePlanOptions): Promise<PublishingPlan>

Generates a publishing plan showing what would happen during publishing. Shows version changes, dependency updates, and breaking change cascades. Uses fixed-point iteration to resolve transitive cascades.

repos

type LocalRepo[]

options

default {}

returns

Promise<PublishingPlan>

GeneratePlanOptions
#

PublishingPlan
#

publishing_plan.ts view source

PublishingPlan

publishing_order

type Array<string>

version_changes

type Array<VersionChange>

dependency_updates

type Array<DependencyUpdate>

breaking_cascades

type Map<string, Array<string>>

warnings

type Array<string>

info

type Array<string>

errors

type Array<string>

verbose_data

VerboseChangesetDetail
#

publishing_plan.ts view source

VerboseChangesetDetail

package_name

type string

files

type Array<{filename: string; bump_type: BumpType; summary: string}>

VerboseData
#

publishing_plan.ts view source

VerboseData

changeset_details

type Array<VerboseChangesetDetail>

iterations

type Array<VerboseIteration>

propagation_chains

type Array<VerbosePropagationChain>

graph_summary

total_iterations

type number

VerboseGraphSummary
#

publishing_plan.ts view source

VerboseGraphSummary

package_count

type number

internal_dep_count

type number

prod_peer_edges

type Array<{from: string; to: string; type: 'prod' | 'peer'}>

dev_edges

type Array<{from: string; to: string}>

prod_cycle_count

type number

dev_cycle_count

type number

VerboseIteration
#

VerboseIterationPackage
#

publishing_plan.ts view source

VerboseIterationPackage

name

type string

changeset_count

type number

bump_from_changesets

type BumpType | null

required_bump

type BumpType | null

triggering_dep

type string | null

action

type 'publish' | 'auto_changeset' | 'escalation' | 'skip'

version_to

type string | null

is_breaking

type boolean

VerbosePropagationChain
#

publishing_plan.ts view source

VerbosePropagationChain

source

type string

chain

type Array<{pkg: string; dep_type: 'prod' | 'peer'; action: string}>

VersionChange
#

publishing_plan.ts view source

VersionChange

package_name

type string

from

type string

to

type string

bump_type

breaking

type boolean

has_changesets

type boolean

will_generate_changeset

type boolean

needs_bump_escalation

type boolean

existing_bump

required_bump

Depends on
#

Imported by
#