gajus/eslint-plugin-flowtype

Add rule to enforce error codes on flow suppressions

Open

#453 opened on Aug 19, 2020

View on GitHub
 (2 comments) (2 reactions) (0 assignees)JavaScript (1,078 stars) (167 forks)batch import
enhancementhelp wanted

Description

Flow version 0.121.0 allows for more specific error suppressions: https://medium.com/flow-type/making-flow-error-suppressions-more-specific-280aa4e3c95c

It would be wonderful if we could have a rule which requires these specific error suppressions:

  • // $FlowFixMe would fail since it has no valid error code specified
  • // $FlowFixMe[incompatible-type] would pass since it does have a valid error code

Contributor guide

Tech stack
javascript
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ESLint plugin developmentFlow error suppression syntax
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Review existing rules in eslint plugin flowtype for pattern. Implement a new rule using ESLint rule API that checks $FlowFixMe comments. Ensure the rule can be configured with a list of valid error codes. Look at linked Medium article for context.