stenciljs/eslint-plugin

feat: Compiler should support union types for the @Element decorator

Open

#89 opened on Mar 19, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (37 forks)auto 404
Help Wanted

Repository metrics

Stars
 (71 stars)
PR merge metrics
 (PR metrics pending)

Description

Prerequisites

Describe the Feature Request

Right now, the ESlint Compiler throws an exception when I define a union type for my element:

@Element() element: HTMLMyComponentElement | undefined;

To satisfy my "strict": true Typescript config I have to define it like so. Pretending element! exists is not the right solution since it will be undefined until it's rendered.

Describe the Use Case

It's required when using Typescript strict mode.

Describe Preferred Solution

No response

Describe Alternatives

No response

Related Code

No response

Additional Information

No response

Contributor guide

Research direction
Check the ESLint rule responsible for validating @Element decorator and add support for TypeScript union types. Ensure the rule does not throw when the element type is a union like `HTMLMyComponentElement | undefined`.
Tech stack
typescript
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptESLintStencil
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80