Skip to content

chore(developer): consolidate api-extractor usage in Developer#16135

Open
mcdurdin wants to merge 2 commits into
masterfrom
chore/developer/14838-consolidate-api-extractor
Open

chore(developer): consolidate api-extractor usage in Developer#16135
mcdurdin wants to merge 2 commits into
masterfrom
chore/developer/14838-consolidate-api-extractor

Conversation

@mcdurdin

@mcdurdin mcdurdin commented Jun 24, 2026

Copy link
Copy Markdown
Member
  • Centralize the api-extractor.json files, update usage
  • Support @since
  • Tidy up a few warnings relating to API documentation content

Fixes: #14838
Test-bot: skip

@keymanapp-test-bot

keymanapp-test-bot Bot commented Jun 24, 2026

Copy link
Copy Markdown

User Test Results

Test specification and instructions

User tests are not required

Test Artifacts

* Centralize the api-extractor.json files, update usage
* Support @SInCE
* Tidy up a few warnings relating to API documentation content

Fixes: #14838
Test-bot: skip
@mcdurdin mcdurdin force-pushed the chore/developer/14838-consolidate-api-extractor branch from 407ce71 to d866049 Compare June 24, 2026 12:45

@ermshiperete ermshiperete left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, except I think the paths are wrong in most of the modified build.sh files.

Comment thread common/tools/api-extractor/README.md Outdated

# Notes

These files are used by `typescript_run_api_extractor()` in typescript.inc.sh.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We might want to move this sentence to the top of the file. Also, a sentence what api-extractor does or why we do it might be helpful. I guess we're talking about https://api-extractor.com/ ?

We could also reference .github/workflows/api-verification.yml which maybe does a similar thing for the desktop platforms.

@@ -0,0 +1,15 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"extends": "$keyman_root/common/tools/api-extractor/api-extractor.base.json",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

If we would put the variables we replace in uppercase they would be easier to spot.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

True, but fairly low priority? I will leave that this time because keyman_root vs KEYMAN_ROOT 😁

Comment thread developer/src/kmc-generate/build.sh Outdated
builder_run_action configure node_select_version_and_npm_ci
builder_run_action build do_build
builder_run_action api api-extractor run --local --verbose
builder_run_action api typescript_run_api_extractor developer/src/kmc-copy main.d.ts

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'd guess this should be

Suggested change
builder_run_action api typescript_run_api_extractor developer/src/kmc-copy main.d.ts
builder_run_action api typescript_run_api_extractor developer/src/kmc-generate main.d.ts

(similarly in the other build.sh files...)

Test-bot: skip
Build-bot: skip release:developer
@mcdurdin mcdurdin requested a review from ermshiperete June 29, 2026 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

chore(developer): api target has some warnings

2 participants