core: add public Lighthouse types entrypoint#17028
Open
KirtiRamchandani wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
core/index.jsexports both theAuditclass and the LH namespace types fromtypes/lh.js. TypeScript consumers who need theLH.Auditnamespace currently have to deep-importlighthouse/types/lh.js, which looks like an implementation path.Fixes #16923.
Root cause
The package root has a name collision between the runtime
Auditclass export and the type namespace export. Renaming either export would be breaking, and the existing deep import is not an obvious public API.Solution
Add a top-level type-only
types.jsentrypoint that re-exportstypes/lh.js, include it in the declaration build, and cover the entrypoint in the module test. Consumers can now useimport type { Audit } from 'lighthouse/types.js'without relying on the nested implementation path.Tests
corepack yarn type-checkcorepack yarn build-report --flow --standalonecorepack yarn mocha --testMatch core/test/index-test.jscorepack yarn eslint core/test/index-test.js types.js --quietgit diff --check.tmp/tsbuildinfo/types.d.tsAuditandFlagsfrom the generated roottypes.d.tsshape