stenciljs/eslint-plugin

bug: ESLint Warning with reflect: true Annotation and JSDoc Type in Stencil

Open

#115 opened on Aug 29, 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

Stencil ESLint Version

0.8.0

Current Behavior

Hello everyone,

I am encountering an issue and I'm not sure if it's something I'm doing wrong or a problem with the tooling.

When a property is annotated with reflect: true, I receive a warning in ESLint as soon as I define the type in the JSDocs.

  /**
   * The last name
   * @type {boolean}
   * @default true
   */
  @Prop({ reflect: true }) last: boolean = false;

/home/projects/stencil-template-aiden/src/components/my-component/my-component.tsx
15:3  error  The @Prop decorator have not valid tags (type, memberof)  @stencil-community/required-jsdoc

Expected Behavior

There should be no error/warning in the console.

Steps to Reproduce

  1. Open the page: StackBlitz Example
  2. Run npm run lint
  3. See the error:

Code Reproduction URL

https://stackblitz.com/edit/stencil-template-aiden-puukdx

Additional Information

No response

Contributor guide

Research direction
Examine the ESLint rule implementation for `required jsdoc` and understand why `reflect: true` triggers the warning. Look for how the rule parses JSDoc tags and handles `@type` in the presence of `reflect: true`.
Tech stack
typescript
Domain
toolingdeveloper experience
Issue type
Bug
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