fleetlint Policy for a fleet of repositories
v0.8
Getting started

release/api-compatibility/node

A library checks its API against the previous release

Implements release/api-compatibility for node.

Severityinfo
Tiers1
Stacksnode
Scoperoot
Kindoutcome
Sourcelibrary v0.5.0
Selected byfleetlint-recommended@v0.5.0

Requirement

A package.json that is not private and has main, exports or types runs API Extractor with a committed API report.

Why

A breaking change in a minor release is found by every user at once; the check finds it before the tag.

Applies when

json("package.json") != null && !(has(json("package.json").private) && json("package.json").private == true) && (has(json("package.json").main) || has(json("package.json").exports) || has(json("package.json").types))

Fix

Add @microsoft/api-extractor with a committed report (api-extractor run fails on an unreviewed change).

Agent instruction: Add the stack’s API compatibility tool to the release workflow, comparing against the latest tag; on a breaking change bump the major version instead of silencing the tool.

A finding of this rule points at api-extractor.json.

Sources


Generated by fleetlint docs from catalog v0.5.0.