jsx-eslint/eslint-plugin-react

prefer-stateless-function should not check a .d.ts for a Stateful Component

Open

#2296 opened on May 31, 2019

View on GitHub
 (3 comments) (2 reactions) (0 assignees)JavaScript (8,630 stars) (2,797 forks)batch import
bughelp wantedtypescript

Description

Imagine that we have a stateful react component and is about to creating a declaration file d.ts for the .js/.jsx file.

declare class StateCom extends React.Component<Props> {}
export default StateCom;

and error/warning occurs that: Component should be written as a pure function eslint(react/prefer-stateless-function)

How can we handle this since the component is a truly Component with state instead of a functional component?

Contributor guide

Tech stack
javascripttypescriptreact
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of ESLint plugin developmentunderstanding of TypeScript declaration files
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Investigate the rule implementation in `lib/rules/prefer stateless function.js`. Look for how the rule checks file extensions or AST node types to determine if a component is stateful. The fix should likely skip `.d.ts` files or skip class declarations within them. Check existing tests in `tests/lib/rules/prefer stateless function.js` for patterns. Consider adding a test case with a `.d.ts` file. Review any comments in the issue for maintainer input.