stenciljs/eslint-plugin

TODO rules

Open

#1 opened on Jun 17, 2019

View on GitHub
 (5 comments) (7 reactions) (0 assignees)TypeScript (37 forks)auto 404
Good First IssueHelp Wanted

Repository metrics

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

Description

Pending rules:

  • public apis must be documented
  • order of properties/methods following the stencil’s style guide https://stenciljs.com/docs/style-guide
  • validation of the component’s tag
  • validation of the component’s class name
  • enforce tag-name prefix
  • ban certain tag-name prefixes (like stencil-, stncl-, sc-...) configurable
  • @Element() 's type must be HTML{tag-name}Element
  • mutation of Prop()
  • side mutation of objects and arrays in @State() and @Prop()
  • prefer <Host> vs returning array in render()
  • always prefer <Host>
  • reusage or JSX nodes (not possible in stencil's render)
  • @Watch decorators listens to existing prop or state

Naming:

  • Consistent naming of Props / Events and method

Code quality

  • Too many methods?

Contributor guide

Research direction
Implement each TODO item by creating new ESLint rules following the Stencil style guide and existing rule patterns.
Tech stack
typescript
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
ESLintStencilJSTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50