cucumber / cucumber-js

Cucumber for JavaScript
https://cucumber.io
MIT License
5.01k stars 1.09k forks source link

Revive and rework tooling around exported API #2367

Closed davidjgoss closed 6 months ago

davidjgoss commented 6 months ago

🤔 What's changed?

⚡️ 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?

📋 Checklist:


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

coveralls commented 6 months ago

Coverage Status

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