stenciljs/eslint-plugin

feat: Enforce `implements ComponentInterface`

Open

#102 opened on Jan 2, 2024

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

Enforce the usage of the ComponentInterface

Describe the Use Case

Some IDE's mark the lifecycle hooks as unused when the ComponentInterface is not implemented

Describe Preferred Solution

No response

Describe Alternatives

No response

Related Code

No response

Additional Information

No response

Contributor guide

Research direction
Examine existing ESLint rules in this plugin to understand the pattern for creating rules. Then create a rule that detects when a Stencil component class does not implement ComponentInterface from @stencil/core. Look at the AST to check for class declaration and see if it has an implements clause containing ComponentInterface.
Tech stack
typescript
Domain
tooling
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.
1-3 hours
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
TypeScriptESLint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65