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(mock-doc): resolve type issue for localName #5595

Merged
merged 3 commits into from
Mar 27, 2024

Conversation

christian-bromann
Copy link
Member

What is the current behavior?

We see a breaking nightly build in https://github.com/ionic-team/ionic-framework/actions/runs/8338316083/job/22818424122 which happened due to the fact that I initially had to set localName different for Document and Element types. This fails because Document inherits from Element (wrongly IMHO) and so TypeScript complains because it overwrites localName in Document to a property that returns undefined when the parent class Element expects a string return type.

An initial fix for this was proposed in #5543. However it seems a bit too invasive to make that change outside of a major semver update. This patch resolves the issue while not breaking any typings in MockDoc as they are right now.

What is the new behavior?

No type issue that let's Stencils nightly build failing.

Documentation

n/a

Does this introduce a breaking change?

  • Yes
  • No

I expect no breaking changes technically but can't guarantee.

Testing

I will make a dev build an re-run this in framework to double check.

Other information

Copy link
Contributor

github-actions bot commented Mar 26, 2024

--strictNullChecks error report

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

That's 4 fewer than on main! 🎉🎉🎉

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/testing/puppeteer/puppeteer-element.ts 22
src/runtime/client-hydrate.ts 20
src/screenshot/connector-base.ts 19
src/runtime/vdom/vdom-render.ts 17
src/dev-server/request-handler.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/connected-callback.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/compiler/transpile/transpile-module.ts 12
src/mock-doc/test/attribute.spec.ts 12
Our most common errors
Typescript Error Code Count
TS2322 362
TS2345 344
TS18048 204
TS18047 82
TS2722 37
TS2532 24
TS2531 21
TS2454 14
TS2790 11
TS2352 10
TS2769 8
TS2538 8
TS2416 7
TS2493 3
TS18046 2
TS2684 1
TS2430 1

Unused exports report

There are 14 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 269 normalize
src/utils/index.ts 7 escapeRegExpSpecialCharacters
src/compiler/app-core/app-data.ts 25 BUILD
src/compiler/app-core/app-data.ts 115 Env
src/compiler/app-core/app-data.ts 117 NAMESPACE
src/compiler/fs-watch/fs-watch-rebuild.ts 123 updateCacheFromRebuild
src/compiler/types/validate-primary-package-output-target.ts 61 satisfies
src/compiler/types/validate-primary-package-output-target.ts 61 Record
src/testing/puppeteer/puppeteer-declarations.ts 485 WaitForEventOptions
src/compiler/sys/fetch/write-fetch-success.ts 7 writeFetchSuccessSync

Copy link
Contributor

github-actions bot commented Mar 26, 2024

PR built and packed!

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

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

unzip -d ~/Downloads ~/Downloads/stencil-core-4.13.0-dev.1711558403.0bf19c6.tgz.zip && npm install ~/Downloads/stencil-core-4.13.0-dev.1711558403.0bf19c6.tgz

@christian-bromann christian-bromann added this pull request to the merge queue Mar 27, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 27, 2024
@christian-bromann christian-bromann added this pull request to the merge queue Mar 27, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 27, 2024
@christian-bromann christian-bromann added this pull request to the merge queue Mar 27, 2024
Merged via the queue into main with commit d91af87 Mar 27, 2024
123 checks passed
@christian-bromann christian-bromann deleted the cb/localname-fix branch March 27, 2024 17:33
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.

None yet

3 participants