add API review file and build step #381
Draft
+855
−10
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is just a proof of concept. I wanted an easy way to look at the public API of our library according to what types we expose. I'm using
api-extractor
pointing at the entry-point of our type definitions to generate the API markdown file.Using this would help allow us to easily detect when the API surface changes, areas for improving our documentation, and detects if we've forgotten to export anything that's referenced by our public API.
Also worth going through to make sure we aren't exporting something that's not actually usable/intended to be used.