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

Revive and rework tooling around exported API #2367

Merged
merged 47 commits into from Jan 7, 2024
Merged

Conversation

davidjgoss
Copy link
Contributor

@davidjgoss davidjgoss commented Dec 27, 2023

🤔 What's changed?

  • Upgrade api-extractor to the latest and turn it back on for the api entry point
  • Also turn it on, with more forgiving configuration, for the root entry point
  • Fix a bunch of issues (missing exports etc) flagged by api-extractor
  • Remove api-documenter and the docs it previously generated
  • Add typedoc and have it deploy to GitHub Pages on every commit to main
  • Generally improve some documentation and types

⚡️ What's your motivation?

We added api-extractor and api-documenter a while ago for the new /api entry point, but then disabled them due to some weird compatibility issues with hybrid packages and/or protobuf.

As we add more to the /api entry point soon for plugins, and also look to shrink the exports from the root entry point, we'll get a lot of value from api-extractor as it's very good at finding issues that would cause a poor developer experience for consumers. So I wanted to revive this.

api-documenter on the other hand produces output which is not quite so usable/accessible as an HTML site, and it also doesn't handle multiple entry points. typedoc is better suited on both fronts for us. So I wanted to switch to this.

🏷️ What kind of change is this?

  • 🏦 Refactoring/debt/DX (improvement to code design, tooling, documentation etc. without changing behaviour)
  • 🐛 Bug fix (non-breaking change which fixes a defect)

📋 Checklist:

  • I agree to respect and uphold the Cucumber Community Code of Conduct
  • I've changed the behaviour of the code
    • I have added/updated tests to cover my changes.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
  • Users should know about my change
    • I have added an entry to the "Unreleased" section of the CHANGELOG, linking to this pull request.

This text was originally generated from a template, then edited by hand. You can modify the template here.

@coveralls
Copy link

coveralls commented Dec 27, 2023

Coverage Status

coverage: 98.379% (-0.002%) from 98.381%
when pulling 6289319 on revive-api-extractor
into 0fbe487 on main.

@davidjgoss davidjgoss marked this pull request as ready for review January 7, 2024 13:03
@davidjgoss davidjgoss merged commit 920ee17 into main Jan 7, 2024
8 checks passed
@davidjgoss davidjgoss deleted the revive-api-extractor branch January 7, 2024 14:54
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.

None yet

2 participants