jsx-eslint/eslint-plugin-react

[Bug]: autofix for jsx-closing-bracket-location deletes comments

Open

#3,793 建立於 2024年8月2日

在 GitHub 查看
 (1 留言) (3 反應) (0 負責人)JavaScript (8,630 star) (2,797 fork)batch import
bughelp wanted

描述

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

When using jsx-closing-bracket-location with "after-props" setting, on autofix it deletes all comments which exist before actual non-comment prop (usually it's commented props).

For example, if run eslint --fix on this file image

it will remove all comments before src prop image

Same goes, of course, for html tags which have both opening and closing tags image

comments will be removed in this case as well

I often find myself commenting some props for testing, and this deleting bothers me. To avoid it, I need to move props here and there so that there's a non-commented line before closing bracket

Expected Behavior

I think the expected behavior should be to make last comment be commented with "/* .... */" and place closing bracket there as shown below. Technically it will be "after props", but will not remove comments which might be needed by developer

image

If maintainers find this issue suitable for fix, I'll try to fix it myself

eslint-plugin-react version

v7.35.0

eslint version

v8.24.0

node version

v16.17.1

貢獻者指南

技術棧
javascriptreact
領域
developer experiencefrontend
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
ESLint plugin developmentJSX syntaxAST comment handling
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
55
研究方向
The bug is in the rule file likely located at `src/rules/jsx closing bracket location.js`. The autofix logic currently moves the closing bracket without preserving comments. Read the ESLint documentation on `fixer.replaceTextRange` and how to handle comments in automatable fixes. Check existing tests for this rule in `tests/lib/rules/jsx closing bracket location.js` to understand the testing patterns. The expected behavior is to keep comments by converting them to block comments or ensuring they are not removed. Investigate how the rule currently handles the last prop and modify the fixer to insert the closing bracket after comments.