Axon Shaft docs
Checklist catalog

Public API

Removed or renamed exports, changed signatures and breaking changes with no major version bump.

  • Check run: Axon Shaft / api-compat
  • How it checks: A script built into the action gathers facts, and the model judges them.
  • Suits: Published packages, Monorepos
  • In templates: Strict review, Library or npm package, Monorepo

What it looks for

  • Removed or renamed exports
  • Changed function signatures
  • Breaking changes with no major version bump

A finding might read: createClient lost its second argument in a minor release

Files it runs on

It runs only when a changed file matches one of these, and is skipped otherwise.

  • **/*.{ts,tsx,mts,cts,js,jsx,mjs,cjs,vue,svelte,astro,py,go,rs,java,kt,kts,swift,m,mm,c,h,cc,cpp,hpp,cs,rb,php,dart,scala,ex,exs,sh}
  • **/package.json

Last updated on