cucumber / cucumber/common

Use API Extractor for TypeScript modules

Open
#1,664 1 comment 2 reactions 0 assignees View on GitHub
:wrench: build language: javascript
Dominant language
No language data
Stars
3.4k
Forks
679
PR merge metrics
No merged PRs in 30d

Description

**Is your feature request related to a problem? Please describe.**

Exposing the right API from TypeScript modules is tricky as we've discussed in https://github.com/cucumber/common/pull/1660#pullrequestreview-708109485

**Describe the solution you'd like**

Adopt [API Extractor](https://api-extractor.com) which solves this problem

**Describe alternatives you've considered**

Using a homegrown namespace as currently implemented in https://github.com/cucumber/common/pull/1660, but that doesn't really solve the "we forgot to export this file" problem.

**Additional context**

This is also related to @mpkorstanje's recent soapbox talks about having stable public APIs.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.