jsx-eslint/eslint-plugin-react

require-default-props: Allow disabling "must have default value" warning but keeping "forbid defaults for required props"

Open

#3660 opened on Dec 1, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (8,630 stars) (2,797 forks)batch import
enhancementhelp wanted

Description

Right now there doesn't seem to be a way to do this.

  • Having to specify a null/undefined default for a prop where you're perfectly fine with it being undefined when not specified feels a bit pointless
  • This is made worse for a prop where you want to allow null, because a required prop will fail runtime proptypes validation when its value is null (even if it's explicitly set to null

So I'd like to just ditch the part of having to specify default for optional props, but still prohibit setting defaults for required ones.

Contributor guide

Tech stack
javascriptreact
Domain
frontend
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.
half day
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
Familiarity with eslint plugin reactUnderstanding of React PropTypes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Examine the current implementation of the require default props rule in the eslint plugin react codebase (likely src/rules/require default props.js). The goal is to add a new option that disables the warning for missing default values on optional props while retaining the check that forbids defaults on required props. Review existing test files (e.g., tests/rules/require default props.js) to understand the expected behavior and ensure backward compatibility. Consider the configuration schema and how the new option can be integrated with existing rule options.