jsx-eslint/eslint-plugin-react

Rule idea: no-mutation-props

Open

#1,113 opened on Mar 14, 2017

View on GitHub
 (6 comments) (8 reactions) (0 assignees)JavaScript (8,630 stars) (2,797 forks)batch import
help wantednew rulequestion

Description

A component is never meant to modify its own props (https://facebook.github.io/react/docs/components-and-props.html#props-are-read-only).

I suggest we had a no-mutation-props rule to check for mutations of a components own props. It looks like we could likely copy the logic used in no-direct-mutation-state.js.

Contributor guide

Tech stack
javascriptreactnodejs
Domain
toolingdeveloper 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-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
ESLint plugin developmentReact props immutabilityAST manipulation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Look at the existing rule no direct mutation state.js in the same repository (lib/rules/no direct mutation state.js) to understand the logic for detecting mutations. Adapt it to detect mutations of props instead of state. Consider edge cases like nested props and object spread. Review the React documentation link provided in the issue. Check the issue comments for any additional discussion on implementation details or scope.