Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(compiler): account for package imports in aliasing #5862

Merged
merged 1 commit into from
Jun 27, 2024

Conversation

tanner-reits
Copy link
Member

What is the current behavior?

7ffb25d introduced a regression when generating the components.d.ts file. The logic for import aliasing did not account for external packages, resulting in broken import/export statements like import { as MyType } from 'external-package';

Fixes #5859

What is the new behavior?

The compiler will now generate a stub id for external packages so we can keep track of the original type name.

Documentation

N/A

Does this introduce a breaking change?

  • Yes
  • No

Testing

Verified fix on the reproduction case

Other information

This does technically change the output generated for the docs-json output target. Previously, the id for imports in these cases would be an empty string, now it will be a mocked id in the form of `node_modules::<type_name>'

Copy link
Contributor

@stencil/core@4.19.0 ts
tsc --noEmit --project scripts/tsconfig.json && tsx scripts/tech-debt-burndown-report.ts

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1079 errors on this branch.

That's the same number of errors on main, so at least we're not creating new ones!

reports and statistics

Our most error-prone files
Path Error Count
src/dev-server/index.ts 37
src/dev-server/server-process.ts 32
src/compiler/prerender/prerender-main.ts 22
src/runtime/vdom/vdom-render.ts 22
src/runtime/client-hydrate.ts 20
src/runtime/vdom/test/patch.spec.ts 19
src/runtime/vdom/test/util.spec.ts 19
src/screenshot/connector-base.ts 19
src/testing/puppeteer/puppeteer-element.ts 19
src/dev-server/request-handler.ts 15
src/runtime/connected-callback.ts 15
src/compiler/prerender/prerender-optimize.ts 14
src/compiler/sys/stencil-sys.ts 14
src/sys/node/node-sys.ts 14
src/compiler/prerender/prerender-queue.ts 13
src/compiler/sys/in-memory-fs.ts 13
src/runtime/set-value.ts 13
src/compiler/output-targets/output-www.ts 12
src/compiler/transformers/test/parse-vdom.spec.ts 12
src/compiler/transformers/transform-utils.ts 12
Our most common errors
Typescript Error Code Count
TS2322 338
TS2345 329
TS18048 188
TS18047 99
TS2722 27
TS2532 23
TS2531 19
TS2790 11
TS2454 10
TS2352 9
TS2769 8
TS2416 7
TS2538 4
TS2493 3
TS18046 2
TS2684 1
TS2430 1

Unused exports report

There are 15 unused exports on this PR. That's the same number of errors on main, so at least we're not creating new ones!

Unused exports
File Line Identifier
src/runtime/bootstrap-lazy.ts 22 setNonce
src/screenshot/screenshot-fs.ts 18 readScreenshotData
src/testing/testing-utils.ts 198 withSilentWarn
src/utils/index.ts 145 CUSTOM
src/utils/index.ts 245 NODE_TYPES
src/utils/index.ts 269 normalize
src/utils/index.ts 7 escapeRegExpSpecialCharacters
src/compiler/app-core/app-data.ts 25 BUILD
src/compiler/app-core/app-data.ts 116 Env
src/compiler/app-core/app-data.ts 118 NAMESPACE
src/compiler/fs-watch/fs-watch-rebuild.ts 123 updateCacheFromRebuild
src/compiler/types/validate-primary-package-output-target.ts 82 satisfies
src/compiler/types/validate-primary-package-output-target.ts 82 Record
src/testing/puppeteer/puppeteer-declarations.ts 496 WaitForEventOptions
src/compiler/sys/fetch/write-fetch-success.ts 7 writeFetchSuccessSync

Copy link
Contributor

PR built and packed!

Download the tarball here: https://github.com/ionic-team/stencil/actions/runs/9699836753/artifacts/1645401635

If your browser saves files to ~/Downloads you can install it like so:

unzip -d ~/Downloads ~/Downloads/stencil-core-4.19.0-dev.1719504056.dfa50d0.tgz.zip && npm install ~/Downloads/stencil-core-4.19.0-dev.1719504056.dfa50d0.tgz

@tanner-reits tanner-reits marked this pull request as ready for review June 27, 2024 16:11
@tanner-reits tanner-reits requested a review from a team as a code owner June 27, 2024 16:11
@christian-bromann christian-bromann added this pull request to the merge queue Jun 27, 2024
Merged via the queue into main with commit 02b41d3 Jun 27, 2024
93 checks passed
@christian-bromann christian-bromann deleted the tr/import-alias-regression branch June 27, 2024 16:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug: Generation of src/components.d.ts typing broken in latest build
2 participants