Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add api-extractor to dev workflow #222

Open
wants to merge 3 commits into
base: development
Choose a base branch
from
Open

Conversation

Egge21M
Copy link
Collaborator

@Egge21M Egge21M commented Dec 10, 2024

Description

This PR adds the api-extractor library to the development workflow. api-extractor will extract the public API from the generated index.d.ts file and verify wether it was changed. The CI pipeline will error if a commit changes the public API surface without including a new api-report.

This allows maintainers to quickly see wether a PR changes something about the public API.

Changes

  • Add api-extractor lib
  • Add api-extractor to npm scripts and CI
  • Add PR Task

testing pipeline

fixed api

suppressed warnings

changed api to test

fixed api to test

excluded api-extractor from prettier

adjustments
@Egge21M Egge21M changed the base branch from main to development December 10, 2024 09:54
@Egge21M Egge21M marked this pull request as ready for review December 10, 2024 09:54
Copy link
Collaborator

@gandlafbtc gandlafbtc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

api-extractor.json has a lot of commented config, do you want to clean it up a bit? I don't mind checking it in like that if you think it's helpful though

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants