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

chore(runtime): set exports field in client runtime package.json #5842

Merged
merged 6 commits into from
Jun 21, 2024

Conversation

christian-bromann
Copy link
Member

What is the current behavior?

fixes #5275

What is the new behavior?

Set an exports field in the package.json for the client runtime so it can be imported by ESM.

Documentation

Does this introduce a breaking change?

  • Yes
  • No

Testing

n/a

Other information

n/a

Copy link
Contributor

@stencil/[email protected] ts
tsc --noEmit --project scripts/tsconfig.json && tsx scripts/tech-debt-burndown-report.ts

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1084 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 21
src/runtime/client-hydrate.ts 20
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
src/mock-doc/test/attribute.spec.ts 12
src/compiler/build/compiler-ctx.ts 11
Our most common errors
Typescript Error Code Count
TS2322 352
TS2345 333
TS18048 193
TS18047 76
TS2722 27
TS2532 24
TS2531 19
TS2454 14
TS2790 11
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 21 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

github-actions bot commented Jun 18, 2024

PR built and packed!

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

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

unzip -d ~/Downloads ~/Downloads/stencil-core-4.18.3-dev.1718908983.20ac44b.tgz.zip && npm install ~/Downloads/stencil-core-4.18.3-dev.1718908983.20ac44b.tgz

Comment on lines +27 to +44
"import": "./internal/stencil-core/index.js",
"require": "./internal/stencil-core/index.cjs"
},
"./internal": {
"import": "./internal/index.js"
},
"./internal/client": {
"import": "./internal/client/index.js"
},
"./internal/testing": {
"import": "./internal/testing/index.js"
},
"./internal/testing/*": {
"import": "./internal/testing/*"
},
"./internal/app-data": {
"import": "./internal/app-data/index.js",
"require": "./internal/app-data/index.cjs"
Copy link
Member

Choose a reason for hiding this comment

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

Still think it's so weird we expose things under "internal" 😅

Copy link
Member Author

Choose a reason for hiding this comment

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

Totally! These aren't user interfaces though , they are all just import references that Stencil is using.

Choose a reason for hiding this comment

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

you could remove them, but then your imports should use relative paths, with js extension

Copy link
Member Author

Choose a reason for hiding this comment

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

Yep, we will do more optimizations in this direction, e.g. move to ESM

@christian-bromann christian-bromann added this pull request to the merge queue Jun 21, 2024
Merged via the queue into main with commit a2fa93b Jun 21, 2024
93 checks passed
@christian-bromann christian-bromann deleted the cb/client-export branch June 21, 2024 17:48
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: Stencil is generating invalid ESM COde
3 participants