-
Type: Improvement
-
Resolution: Unresolved
-
Priority: Minor - P4
-
None
-
Affects Version/s: None
-
Component/s: Tooling
Description
api-extractor can generate a detailed programatic description of our Driver APIs. We should utilize this in testing to assert and get checks on known changes to our public API. Essentially we can diff the current and new API before a release to determine exact changes.
Open Qs
- Can this combine with coverage, somehow proving the public API is completely covered by enumerating possible options to every operation?
- We can likely use api-extractor to protect against cross repo breakages. It's intention is to manage types that are cross packages, if crypt depends on something in the driver, it can be tested that it doesn't change (at least at the TS level).