fix(compiler): don't validate references for @Prop, @Method and @Event decorator

[christian-bromann]

What is the current behavior?

It currently seems that we have implemented a validation that would prevent returning a type that collides with the name of any imported Stencil type. As far as I understood the situation is as following: given I have a type name that has the same name as one of Stencils decorators (e.g. Element, Event, Listen, Method, Prop, PropDidChange, PropWillChange, State or Watch) it will throw a meaningless error. This can be easily reproduced in many ways:

// in src/utils/utils.ts
interface Method {}

export function returnSomethingInvalid(): Method {
  return {}
}

Then having the following component decorator will fail:

// in src/components/my-component/my-component.tsx
import { Component, Prop, h, Method, EventEmitter, Event } from '@stencil/core';
import { returnSomethingInvalid } from '../../utils/utils';

@Component({
  tag: 'my-component',
  styleUrl: 'my-component.css',
  shadow: true,
})
export class MyComponent {
  // ...
  @Method()
  async didDismiss() {
    return returnSomethingInvalid()
  }
  // ...
}

This behavior was introduced in ca60073 and was suppose to fix an issue reported in #1352.

What is the new behavior?

Remove this validation as I don't think it makes sense here. I don't totally understand the reasoning behind it but it seems unnecessary to validate if the returning type matches with one of Stencils decorators. It seems safe to me to just remove this completely.

STENCIL-980

Documentation

Does this introduce a breaking change?

• Yes
• No

Testing

I can add some compiler tests for this if we think we want to move forward with this.

Other information

n/a

[github-actions]

--strictNullChecks error report

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

That's 2 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/compiler/transpile/transpile-module.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/mock-doc/test/attribute.spec.ts	12

Our most common errors

Typescript Error Code	Count
TS2322	361
TS2345	347
TS18048	207
TS18047	82
TS2722	37
TS2532	24
TS2531	21
TS2454	14
TS2790	11
TS2352	10
TS2769	8
TS2538	8
TS2416	6
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

[github-actions]

PR built and packed!

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

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

unzip -d ~/Downloads ~/Downloads/stencil-core-4.12.6-dev.1710439629.d761af5.tgz.zip && npm install ~/Downloads/stencil-core-4.12.6-dev.1710439629.d761af5.tgz

[christian-bromann]

This has been released with Stencil 🚞 v4.13.0