jsx-eslint/eslint-plugin-react

[Bug]: jsx-curly-newline and comments

Open

#3,584 opened on Jun 7, 2023

View on GitHub
 (6 comments) (0 reactions) (0 assignees)JavaScript (2,797 forks)batch import
bughelp wanted

Repository metrics

Stars
 (8,630 stars)
PR merge metrics
 (No merged PRs in 30d)

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

jsx-curly-newline reports an error when using multiline comments in JSX.

      {/* <FormGroup
        helperTextInvalid={helperText}
        inputProps={inputProps}
        type="password"
      /> */}

  134:7   error  Unexpected newline after '{'                             react/jsx-curly-newline
  138:12  error  Unexpected newline before '}'                            react/jsx-curly-newline

$ eslint --ext .js,.jsx,.ts,.tsx .

Expected Behavior

I would expect no error.

Rule options

"react/jsx-curly-newline": ["error", { "multiline": "forbid", "singleline": "forbid" }],

eslint-plugin-react version

7.32.2

eslint version

7.32.0

node version

14.21.3

Contributor guide

Research direction
Understand how ESLint rules process AST nodes, specifically JSXExpressionContainer. Investigate the rule source code at eslint plugin react/lib/rules/jsx curly newline.js. Check how it handles comments within JSX curly braces. The fix likely requires ignoring comments when calculating newline positions or adjusting the logic to allow newlines around multiline comments.
Tech stack
javascriptreact
Domain
frontend
Issue type
Bug
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
ESLint plugin development basicsAST (Abstract Syntax Tree) understanding
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40