Skip to content

Commit cc9578c

Browse files
ROSSROSALESljharb
ROSSROSALES
authored and
ljharb
committed
[Fix] sort-prop-types: avoid crash when autofixing
Fixes #3470.
1 parent dfd64ae commit cc9578c

4 files changed

Lines changed: 70 additions & 19 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
1313

1414
### Fixed
1515
* configs: avoid legacy config system error ([#3461][] @ljharb)
16-
* [`sort-prop-types`]: restore autofixing ([#3452][] @ROSSROSALES)
16+
* [`sort-prop-types`]: restore autofixing ([#3452][], [#3471][] @ROSSROSALES)
1717
* [`no-unknown-property`]: do not check `fbs` elements ([#3494][] @brianogilvie)
1818
* [`jsx-newline`]: No newline between comments and jsx elements ([#3493][] @justmejulian)
1919
* [`jsx-no-leaked-render`]: Don't report errors on empty strings if React >= v18 ([#3488][] @himanshu007-creator)
@@ -24,6 +24,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
2424
[#3494]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3494
2525
[#3493]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3493
2626
[#3488]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3488
27+
[#3471]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3471
2728
[#3468]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3468
2829
[#3461]: https://github.com/jsx-eslint/eslint-plugin-react/issues/3461
2930
[#3452]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3452

‎docs/rules/sort-prop-types.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
<!-- end auto-generated rule header -->
66

7+
🔧 This rule is automatically fixable using the `--fix` [flag](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) on the command line.
8+
79
Some developers prefer to sort prop type declarations alphabetically to be able to find necessary declaration easier at the later time. Others feel that it adds complexity and becomes burden to maintain.
810

911
## Rule Details

‎lib/util/propTypesSort.js‎

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -127,29 +127,27 @@ function fixPropTypesSort(fixer, context, declarations, ignoreCase, requiredFirs
127127
const node = allNodes[i];
128128
let commentAfter = [];
129129
let commentBefore = [];
130+
let newStart = 0;
131+
let newEnd = 0;
130132
try {
131133
commentBefore = sourceCode.getCommentsBefore(node);
132134
commentAfter = sourceCode.getCommentsAfter(node);
133135
} catch (e) { /**/ }
134-
if (commentAfter.length === 0 && commentBefore.length === 0) {
135-
commentnodeMap.set(node, { start: node.range[0], end: node.range[1], hasComment: false });
136-
} else {
137-
const firstCommentBefore = commentBefore[0];
138-
if (commentBefore.length === 1) {
139-
commentnodeMap.set(node, { start: firstCommentBefore.range[0], end: node.range[1], hasComment: true });
140-
}
141-
const firstCommentAfter = commentAfter[0];
142-
if (commentAfter.length === 1) {
143-
commentnodeMap.set(node, { start: node.range[0], end: firstCommentAfter.range[1], hasComment: true });
144-
}
145-
if (commentBefore.length === 1 && commentAfter.length === 1) {
146-
commentnodeMap.set(node, {
147-
start: firstCommentBefore.range[0],
148-
end: firstCommentAfter.range[1],
149-
hasComment: true,
150-
});
151-
}
136+
137+
if (commentAfter.length === 0 || commentBefore.length === 0) {
138+
newStart = node.range[0];
139+
newEnd = node.range[1];
140+
}
141+
142+
const firstCommentBefore = commentBefore[0];
143+
if (commentBefore.length >= 1) {
144+
newStart = firstCommentBefore.range[0];
145+
}
146+
const lastCommentAfter = commentAfter[commentAfter.length - 1];
147+
if (commentAfter.length >= 1) {
148+
newEnd = lastCommentAfter.range[1];
152149
}
150+
commentnodeMap.set(node, { start: newStart, end: newEnd, hasComment: true });
153151
}
154152
const nodeGroups = allNodes.reduce((acc, curr) => {
155153
if (curr.type === 'ExperimentalSpreadProperty' || curr.type === 'SpreadElement') {

‎tests/lib/rules/sort-prop-types.js‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2098,6 +2098,56 @@ ruleTester.run('sort-prop-types', rule, {
20982098
type: 'Property',
20992099
},
21002100
],
2101+
} : [],
2102+
semver.satisfies(eslintPkg.version, '> 3') ? {
2103+
code: `
2104+
var First = createReactClass({
2105+
propTypes: {
2106+
/* z */
2107+
/* z */
2108+
z: PropTypes.string /* z */,
2109+
/* a */
2110+
a: PropTypes.any /* a */
2111+
/* a */
2112+
/* a */,
2113+
b: PropTypes.any
2114+
},
2115+
render: function() {
2116+
return <div />;
2117+
}
2118+
});
2119+
`,
2120+
output: `
2121+
var First = createReactClass({
2122+
propTypes: {
2123+
/* a */
2124+
a: PropTypes.any /* a */
2125+
/* a */
2126+
/* a */,
2127+
b: PropTypes.any,
2128+
/* z */
2129+
/* z */
2130+
z: PropTypes.string /* z */
2131+
},
2132+
render: function() {
2133+
return <div />;
2134+
}
2135+
});
2136+
`,
2137+
errors: [
2138+
{
2139+
messageId: 'propsNotSorted',
2140+
line: 8,
2141+
column: 13,
2142+
type: 'Property',
2143+
},
2144+
{
2145+
messageId: 'propsNotSorted',
2146+
line: 11,
2147+
column: 13,
2148+
type: 'Property',
2149+
},
2150+
],
21012151
} : []
21022152
)),
21032153
});

0 commit comments

Comments
 (0)