a2aproject / a2aproject/a2a-js
[Test]: Research options for build-time breaking changes detection
- Dominant language
- TypeScript
- Stars
- 613
- Forks
- 169
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 21
Description
Similar to https://github.com/VerifyTests/Verify from .NET, it would be beneficial to highlight breaking changes introduced in exported types (function signatures, interfaces, etc.)
Given that Typescript type system is Turing Complete, it may be possible only to some extent, however anything will help.
https://api-extractor.com/ looks promising.
Contributor guide
Research direction
Research tools like api-extractor.com and VerifyTests/Verify for detecting breaking changes in TypeScript exported types. Examine the project's build configuration and existing tests to understand the current type exports. Determine how to integrate a detection tool into the build process and define what constitutes a breaking change for this SDK.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- testing, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100