stenciljs/eslint-plugin

decorators-style conflicts with Prettier

Open

#27 opened on Apr 30, 2021

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

Repository metrics

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

Description

We're using default Prettier options and default @stencil/decorators-style options.

Prettier formats code like this:

class AxsTreeViewItem {
  @Event({ bubbles: true, composed: true })
  axsTreeItemSelected: EventEmitter<any>;
}

but @stencil/decorators-style says The @Event decorator can only be applied as inline.

I expect @stencil/decorators-style to work with Prettier and to not cause warnings.

Contributor guide

Research direction
Investigate the decorators style ESLint rule's logic to determine why it flags inline decorators formatted by Prettier, and consider modifying the rule to accept multi line decorator patterns or to align with Prettier's formatting options.
Tech stack
typescript
Domain
developer experiencetooling
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ESLintPrettier
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70