build: upgrade API Extractor - #10230
Conversation
|
Wiz Scan Summary
To detect these findings earlier in the dev lifecycle, try the Wiz Code extension for VS Code, JetBrains, or Visual Studio. |
There was a problem hiding this comment.
Code Review
This pull request updates the API review files and regenerates the devsite documentation for several Firebase packages, including Auth, Firestore, Realtime Database, and Messaging. The changes include consolidating and renaming Firestore documentation paths and updating the updateProfile signature in Auth. The reviewer identified several issues in the generated documentation, such as incorrect parameter listings for updateProfile in auth.md, missing method references/placeholders in firestore.documentreference.md, firestore.documentdata.md, and firestore.firestoredataconverter.md, as well as minor typos in firestore.writebatch.md.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request migrates the API extraction and documentation generation process from the custom api-extractor-me package to the official @microsoft/api-extractor package. To support this migration, the configuration files (api-extractor.json) for the firestore and messaging packages have been updated to remove additionalEntryPoints, and the documentation generation script (docgen.ts) has been enhanced to programmatically merge secondary entry points into the main api.json files. Consequently, several generated documentation files for pipelines have been cleaned up or deleted, and links/types across the devsite documentation have been updated. Additionally, the updateProfile signature in the authentication API has been simplified to use an input parameter. I have no further feedback to provide as there are no review comments.
Upgrades from a custom 2019 fork (
api-extractor-me@0.1.2) to the latest version of@microsoft/api-extractor(7.58.12). Restores multi-entry-point devsite reference documentation without requiring a custom API Extractor fork or schema extensions.Changes:
additionalEntrypointsfrom firestore and messaging API extractor configs, since they are not supported by the official API extractor.appendSecondaryEntryPointsToApiJsonto run API extractor on secondary entry points and merge theirApiEntryPointmembers intoapi.jsonfiles.Reference Documentation Changes:
CollectionReference,Timestamp, etc.) that the old fork generated. Modern API extractor understands import references, so duplicates are not necessary.Validation: We should stage this documentation in devsite to validate the new links work correctly.