jsx-eslint/eslint-plugin-react

[Docs]: Add docs for `customValidators`

Open

#3664 opened on Dec 12, 2023

View on GitHub
 (5 comments) (4 reactions) (0 assignees)JavaScript (8,630 stars) (2,797 forks)batch import
documentationhelp wanted

Description

Is there an existing issue for this?

  • I have searched the existing issues and my issue is unique
  • My issue appears in the command-line and not only in the text editor

Description Overview

@JoshuaKGoldberg suggested I should post an issue here 🙃

Expected Behavior

A code example on how to use customVAlidators

eslint-plugin-react version

n/a

eslint version

n/a

node version

n/a

Contributor guide

Tech stack
javascriptreact
Domain
documentation
Issue type
documentation
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.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of ESLint pluginsUnderstanding of customValidatorsMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Investigate the existing mentions of customValidators in the docs (e.g., no unstable nested components.md). Review the source code where customValidators is implemented to understand its usage. Then write a clear documentation section with a code example. Consider adding to a shared docs file or creating a new page.