surfacenotes/package.json
caelum0x 507427c4ae feat: verified-breaking-change changelog generator for TypeScript SDKs
Surfacenotes generates CHANGELOG.md/RELEASE_NOTES.md from a git commit
range like other changelog tools, but it also parses the package's
public entry file with the real TypeScript compiler at both refs,
structurally diffs the exported API surface, and cross-checks that
against the conventional-commit labels in the same range. A mislabeled
"fix:" that actually removes an export or adds a required parameter
gets a loud warning banner instead of a quiet lie.

Verified against the real git history of the usesend-js SDK
(v1.6.0..v1.7.2, 73 real commits) and against a small synthetic repo
built to prove the breaking-change detector fires correctly.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-26 15:54:44 +03:00

46 lines
1.0 KiB
JSON

{
"name": "surfacenotes",
"version": "0.1.0",
"description": "Changelog and release-notes generator for TypeScript library and SDK maintainers that verifies every breaking-change claim against a real diff of the package's public API surface, instead of trusting conventional-commit labels.",
"license": "MIT",
"type": "module",
"bin": {
"surfacenotes": "dist/cli.js"
},
"main": "dist/index.js",
"types": "dist/index.d.ts",
"files": [
"dist"
],
"engines": {
"node": ">=18.17"
},
"scripts": {
"build": "tsc -p tsconfig.json",
"dev": "tsx src/cli.ts",
"start": "node dist/cli.js"
},
"keywords": [
"changelog",
"release-notes",
"changelog-generator",
"api-breaking-changes",
"semver",
"typescript",
"sdk",
"conventional-commits",
"git"
],
"repository": {
"type": "git",
"url": "https://github.com/caelum0x/surfacenotes.git"
},
"dependencies": {
"typescript": "^5.6.3"
},
"devDependencies": {
"@types/node": "^22.7.5",
"tsx": "^4.19.1"
}
}