feat(compiler): generate export maps on build #5809

tanner-reits · 2024-06-04T15:20:24Z

What is the current behavior?

Stencil does not generate export maps for any entry points.

GitHub Issue Number: N/A

What is the new behavior?

Stencil will generate export maps at build time. This include the default entry point, entry points for the lazy-loader (if applicable), and each custom element (if applicable).

This behavior is gated behind a new config flag.

Documentation

ionic-team/stencil-site#1443

Does this introduce a breaking change?

Yes
No

Testing

Unit tests were added for the new behavior.

This feature can be manually tested by installing a build of this branch into the component starter and enabling the generateExportMaps config flag.

Other information

github-actions · 2024-06-04T15:22:08Z

@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 1080 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/compiler/prerender/prerender-optimize.ts	14
src/compiler/sys/stencil-sys.ts	14
src/runtime/connected-callback.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	351
TS2345	330
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	485	WaitForEventOptions
src/compiler/sys/fetch/write-fetch-success.ts	7	writeFetchSuccessSync

github-actions · 2024-06-04T15:22:15Z

PR built and packed!

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

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

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

christian-bromann

Some minor comments but overall very cool stuff!

christian-bromann · 2024-06-11T14:39:11Z

src/compiler/types/validate-primary-package-output-target.ts

@@ -38,25 +49,32 @@ export const PRIMARY_PACKAGE_TARGET_CONFIGS = {
  dist: {
    getModulePath: (rootDir: string, outputTargetDir: string) =>
      normalizePath(relative(rootDir, join(outputTargetDir, 'index.js'))),
-    getTypesPath: (rootDir: string, outputTargetConfig: d.OutputTargetDist) =>
+    getTypesPath: (rootDir: string, outputTargetConfig: any) =>


Any reason we have to type this as any?

Yes, this was intentional. I'll add a comment

src/compiler/build/write-export-maps.ts

christian-bromann

LGTM 👍

### Release Notes <details> <summary>ionic-team/stencil (@stencil/core)</summary> ### [`v4.19.0`](https://togithub.com/ionic-team/stencil/blob/HEAD/CHANGELOG.md#-4190-2024-06-26) [Compare Source](https://togithub.com/ionic-team/stencil/compare/v4.18.3...v4.19.0) ### Bug Fixes * **compiler:** support rollup's external input option ([#3227](ionic-team/stencil#3227)) ([2c68849](ionic-team/stencil@2c68849)), fixes [#3226](ionic-team/stencil#3226) * **emit:** don't emit test files ([#5789](ionic-team/stencil#5789)) ([50892f1](ionic-team/stencil@50892f1)), fixes [#5788](ionic-team/stencil#5788) * **hyrdate:** support vdom annotation in nested dsd structures ([#5856](ionic-team/stencil#5856)) ([61bb5e3](ionic-team/stencil@61bb5e3)) * label attribute not toggling input ([#3474](ionic-team/stencil#3474)) ([13db920](ionic-team/stencil@13db920)), fixes [#3473](ionic-team/stencil#3473) * **mock-doc:** expose ShadowRoot and DocumentFragment globals ([#5827](ionic-team/stencil#5827)) ([98bbd7c](ionic-team/stencil@98bbd7c)), fixes [#3260](ionic-team/stencil#3260) * **runtime:** allow watchers to fire w/ no Stencil members ([#5855](ionic-team/stencil#5855)) ([850ad4f](ionic-team/stencil@850ad4f)), fixes [#5854](ionic-team/stencil#5854) * **runtime:** catch errors in async lifecycle methods ([#5826](ionic-team/stencil#5826)) ([87e5b33](ionic-team/stencil@87e5b33)), fixes [#5824](ionic-team/stencil#5824) * **runtime:** don't register listener before connected to DOM ([#5844](ionic-team/stencil#5844)) ([9d7021f](ionic-team/stencil@9d7021f)), fixes [#4067](ionic-team/stencil#4067) * **runtime:** properly assign style declarations ([#5838](ionic-team/stencil#5838)) ([5c10ebf](ionic-team/stencil@5c10ebf)) * **testing:** allow to re-use pages across it blocks ([#5830](ionic-team/stencil#5830)) ([561eab4](ionic-team/stencil@561eab4)), fixes [#3720](ionic-team/stencil#3720) * **typescript:** remove unsupported label property ([#5840](ionic-team/stencil#5840)) ([d26ea2b](ionic-team/stencil@d26ea2b)), fixes [#3473](ionic-team/stencil#3473) ### Features * **cli:** support generation of sass and less files ([#5857](ionic-team/stencil#5857)) ([1883812](ionic-team/stencil@1883812)), closes [#2155](ionic-team/stencil#2155) * **compiler:** generate export maps on build ([#5809](ionic-team/stencil#5809)) ([b6d2404](ionic-team/stencil@b6d2404)) * **complier:** support type import aliasing ([#5836](ionic-team/stencil#5836)) ([7ffb25d](ionic-team/stencil@7ffb25d)), closes [#2335](ionic-team/stencil#2335) * **runtime:** support declarative shadow DOM ([#5792](ionic-team/stencil#5792)) ([c837063](ionic-team/stencil@c837063)), closes [#4010](ionic-team/stencil#4010) * **testing:** add `toHaveLastReceivedEventDetail` event spy matcher ([#5829](ionic-team/stencil#5829)) ([63491de](ionic-team/stencil@63491de)), closes [#2488](ionic-team/stencil#2488) * **testing:** allow to disable network error logging via 'logFailingNetworkRequests' option ([#5839](ionic-team/stencil#5839)) ([dac3e33](ionic-team/stencil@dac3e33)), closes [#2572](ionic-team/stencil#2572) * **testing:** expose captureBeyondViewport in pageCompareScreenshot ([#5828](ionic-team/stencil#5828)) ([cf6a450](ionic-team/stencil@cf6a450)), closes [#3188](ionic-team/stencil#3188) </details>

tanner-reits added 5 commits May 6, 2024 15:32

generate export maps in package.json on build

7a67745

npm cli commands

9788577

add config flag & generation conditionals

47111a7

wip(tests)

6bbc699

add tests

f552582

tanner-reits added 2 commits June 4, 2024 12:33

remove log

7ce1ff2

account for primary output target

2aec107

tanner-reits mentioned this pull request Jun 10, 2024

docs(config): document generateExportMaps config option & function ionic-team/stencil-site#1443

Merged

tanner-reits marked this pull request as ready for review June 10, 2024 17:52

tanner-reits requested a review from a team as a code owner June 10, 2024 17:52

tanner-reits requested review from christian-bromann and gnbm and removed request for gnbm June 10, 2024 17:52

christian-bromann reviewed Jun 11, 2024

View reviewed changes

type comment & SNCs

bfb89ec

tanner-reits requested a review from christian-bromann June 11, 2024 18:52

christian-bromann approved these changes Jun 11, 2024

View reviewed changes

tanner-reits added this pull request to the merge queue Jun 12, 2024

Merged via the queue into main with commit b6d2404 Jun 12, 2024
93 checks passed

tanner-reits deleted the tr/generate-export-maps branch June 12, 2024 15:27

brandyscarney mentioned this pull request Jun 26, 2024

chore(deps): update dependency @stencil/core to v4.19.0 ionic-team/ionic-framework#29666

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(compiler): generate export maps on build #5809

feat(compiler): generate export maps on build #5809

tanner-reits commented Jun 4, 2024 •

edited

Loading

github-actions bot commented Jun 4, 2024 •

edited

Loading

github-actions bot commented Jun 4, 2024 •

edited

Loading

christian-bromann left a comment

christian-bromann Jun 11, 2024

tanner-reits Jun 11, 2024

christian-bromann left a comment

feat(compiler): generate export maps on build #5809

feat(compiler): generate export maps on build #5809

Conversation

tanner-reits commented Jun 4, 2024 • edited Loading

What is the current behavior?

What is the new behavior?

Documentation

Does this introduce a breaking change?

Testing

Other information

github-actions bot commented Jun 4, 2024 • edited Loading

--strictNullChecks error report

reports and statistics

Unused exports report

github-actions bot commented Jun 4, 2024 • edited Loading

PR built and packed!

christian-bromann left a comment

Choose a reason for hiding this comment

christian-bromann Jun 11, 2024

Choose a reason for hiding this comment

tanner-reits Jun 11, 2024

Choose a reason for hiding this comment

christian-bromann left a comment

Choose a reason for hiding this comment

tanner-reits commented Jun 4, 2024 •

edited

Loading

github-actions bot commented Jun 4, 2024 •

edited

Loading

`--strictNullChecks` error report

github-actions bot commented Jun 4, 2024 •

edited

Loading