Functions
- The programmatic API - (Outline, Contents)
- readDistribution - (Outline, Contents)
- inspectExtends - (Outline, Contents)
- findFloorViolations - (Outline, Contents)
- submodules - (Outline, Contents)
- inspect - (Outline, Contents)
- target - (Outline, Contents)
The programmatic API
Everything the CLI does is available programmatically, for a build script or a test that would rather assert than parse output.
Outline
- Sections:
- Distributions
- Submodules
- Scaffolding and git
readDistribution
Reads what a distribution ships.
Outline
- Sections:
- Where modules come from
- Returns
inspectExtends
How a distribution stands against the one it extends.
Outline
- Sections:
- Returns
- Related
findFloorViolations
Modules a distribution ships older than its parent, or not at all.
Outline
- Sections:
- How versions compare
- Reasons
submodules
The modules a repository ships, as .gitmodules records them.
Outline
- Sections:
- Returns
- Related
inspect
Compares one module's pinned commit against the versions its repository has.
Outline
- Sections:
- Returns
- Fetching
target
The version a bump would move to, or undefined when there is
nothing to do.
Outline
- Sections:
- Why majors are held back
- Returns