-
-
Notifications
You must be signed in to change notification settings - Fork 367
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
686 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Disallow nested ternary expressions with repeated alternatives | ||
|
||
💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/sindresorhus/eslint-plugin-unicorn#preset-configs-eslintconfigjs). | ||
|
||
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix). | ||
|
||
<!-- end auto-generated rule header --> | ||
<!-- Do not manually modify this header. Run: `npm run fix:eslint-docs` --> | ||
|
||
Disallow nested ternary expressions with repeated alternatives, and simplify to a more readable format with logical operators. | ||
|
||
## Examples | ||
|
||
```js | ||
a ? b ? c : 1 : 1; // ❌ | ||
a && b ? c : 1; // ✅ | ||
``` | ||
|
||
```js | ||
a ? b ? c : { foo } : { foo }; // ❌ | ||
a && b ? c : { foo }; // ✅ | ||
``` | ||
|
||
```js | ||
a ? b ? c : sameReference : sameReference; // ❌ | ||
a && b ? c : sameReference; // ✅ | ||
``` | ||
|
||
```js | ||
a ? b ? c : foo.bar() : foo.bar(); // ❌ | ||
a && b ? c : foo.bar(); // ✅ | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
'use strict'; | ||
|
||
const {isNodesEqual, findIndexOfQuestionMarkInConditionalExpression, getParenthesizedRange} = require('./utils/index.js'); | ||
|
||
const MESSAGE_ID = 'no-identical-alternatives-in-ternary'; | ||
const messages = { | ||
[MESSAGE_ID]: | ||
'Replace repeated alternatives of ternary expressions with a logical expression.', | ||
}; | ||
|
||
/** @param {import('eslint').Rule.RuleContext} context */ | ||
const create = context => ({ | ||
/** @param {import('estree').ConditionalExpression} node */ | ||
ConditionalExpression(node) { | ||
// Check if the alternate is a ConditionalExpression | ||
if (node.alternate && node.consequent.type === 'ConditionalExpression') { | ||
const {test: _outerTest, consequent: _outerConsequent, alternate: outerAlternate} = node; | ||
const {test: _innerTest, consequent: _innerConsequent, alternate: innerAlternate} = node.consequent; | ||
|
||
const {sourceCode} = context; | ||
|
||
if (isNodesEqual(outerAlternate, innerAlternate)) { | ||
context.report({ | ||
node, | ||
messageId: MESSAGE_ID, | ||
* fix(fixer) { | ||
// Find the index of the question mark in the outer ConditionalExpression | ||
const questionMarkIndex = findIndexOfQuestionMarkInConditionalExpression(node, sourceCode); | ||
|
||
// Replace the ? with && | ||
yield fixer.replaceTextRange([questionMarkIndex, questionMarkIndex + 1], '&&'); | ||
|
||
// Remove the repeated alternative | ||
const [alternativeStart, alternativeEnd] = getParenthesizedRange(innerAlternate, sourceCode); | ||
yield fixer.replaceTextRange([alternativeStart, node.range[1]], sourceCode.getText().slice(alternativeStart, alternativeEnd)); | ||
}, | ||
}); | ||
} | ||
} | ||
}, | ||
}); | ||
|
||
/** @type {import('eslint').Rule.RuleModule} */ | ||
module.exports = { | ||
create, | ||
meta: { | ||
type: 'problem', | ||
docs: { | ||
description: 'Disallow nested ternary expressions with repeated alternatives.', | ||
recommended: true, | ||
}, | ||
fixable: 'code', | ||
messages, | ||
}, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
'use strict'; | ||
|
||
/** | ||
Find the index of the question mark in a ConditionalExpression node | ||
@param {import('estree').ConditionalExpression} node | ||
@param {import('eslint').SourceCode} sourceCode | ||
@returns {number} | ||
*/ | ||
function findIndexOfQuestionMarkInConditionalExpression(node, sourceCode) { | ||
const testAfterComments = sourceCode.getCommentsAfter(node.test); | ||
const consequentBeforeComments = sourceCode.getCommentsBefore(node.consequent); | ||
|
||
let start = node.test.range[1]; | ||
let end = node.consequent.range[0]; | ||
|
||
if (testAfterComments.length > 0) { | ||
const lastComment = testAfterComments.at(-1); | ||
|
||
start = lastComment.range[1]; | ||
} | ||
|
||
if (consequentBeforeComments.length > 0) { | ||
const firstComment = consequentBeforeComments.at(0); | ||
|
||
end = firstComment.range[0]; | ||
} | ||
|
||
return start + sourceCode.getText().slice(start, end).indexOf('?'); | ||
} | ||
|
||
module.exports = { | ||
findIndexOfQuestionMarkInConditionalExpression, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
'use strict'; | ||
|
||
const ignoreKeys = new Set(['loc', 'start', 'end', 'parent', 'range']); | ||
|
||
/** | ||
Compare two AST nodes for equality by structure and value. | ||
Different from `deepStrictEqual` in that it ignores `loc`, `start`, `end`, `parent`, and `range` properties. | ||
Different from `isSameReference` in that `isSameReference` just checks if the nodes are the same reference, but cannot compare two identical data. | ||
eg.: | ||
```js | ||
const node1 = { foo: bar } | ||
const node2 = { foo: bar } | ||
``` | ||
isNodesEqual(node1, node2) => true | ||
isSameReference(node1, node2) => false | ||
@param {import('estree').Node} node1 - The first AST node. | ||
@param {import('estree').Node} node2 - The second AST node. | ||
@returns {boolean} - True if the nodes are structurally and value-wise equal, false otherwise. | ||
*/ | ||
function isNodesEqual(node1, node2) { | ||
if (node1 === node2) { | ||
return true; | ||
} | ||
|
||
if (typeof node1 === 'string' || typeof node1 === 'boolean' || typeof node1 === 'number') { | ||
return node1 === node2; | ||
} | ||
|
||
// If one of them is null or undefined, they are not equal | ||
if (!node1 || !node2) { | ||
return false; | ||
} | ||
|
||
// If they are of different types, they are not equal | ||
if (node1.type !== node2.type) { | ||
return false; | ||
} | ||
|
||
if (node1.type === 'Literal') { | ||
return node1.value === node2.value; | ||
} | ||
|
||
// Compare properties recursively | ||
for (const key in node1) { | ||
if (Object.hasOwn(node1, key) && !ignoreKeys.has(key) && !isNodesEqual(node1[key], node2[key])) { | ||
return false; | ||
} | ||
} | ||
|
||
return true; | ||
} | ||
|
||
module.exports = isNodesEqual; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
import {outdent} from 'outdent'; | ||
import {getTester} from './utils/test.mjs'; | ||
|
||
const {test} = getTester(import.meta); | ||
|
||
test.snapshot({ | ||
valid: [ | ||
'a ? b ? c : 1 : 2', | ||
'a && b ? c : 1', | ||
], | ||
invalid: [ | ||
'a ? b ? c : 1 : 1', | ||
'a ? b ? c : "str" : "str"', | ||
'a ? b ? c : sameReference : sameReference', | ||
'a ? b ? c : { foo: 1 } : { foo: 1 }', | ||
outdent` | ||
const foo = { bar: 1 }; | ||
a ? b ? c : foo.bar : foo.bar | ||
`, | ||
// With comments | ||
'/** comment before a */ a /** comment after a */ ? b ? c : 1 : 1', | ||
outdent` | ||
/** comment before a */ | ||
a ? | ||
/** comment after a */ b ? c : 1 : 1 | ||
`, | ||
outdent` | ||
/** comment before a */ | ||
a ? | ||
/** comment after a */ b /** comment after b */ ? c /** comment after c */ : 1 : 1 /** comment after value */ | ||
`, | ||
'/** comment includes ? */ a /** comment includes ? */ ? b ? c : 1 : 1', | ||
|
||
// Don't use outdent for the following cases, outdent will causes eslint parsing errors | ||
` | ||
a ? | ||
b ? | ||
c : | ||
1 : | ||
1 | ||
`, | ||
` | ||
a ? // comment a | ||
b ? // comment b | ||
c : // comment c | ||
1 : // comment 1 | ||
1 // comment repeat 1 | ||
`, | ||
` | ||
/** comment before a */ a ? // comment a | ||
/** comment before b */ b ? // comment b | ||
/** comment before c */ c : // comment c | ||
/** comment before 1 */ 1 : // comment 1 | ||
/** comment before repeat 1 */ 1 // comment repeat 1 | ||
`, | ||
|
||
// Edge cases | ||
'a ? b ? c : (1, 2) : (1, 2)', | ||
'a ? b ? c : a === 100 : a === 100', | ||
outdent` | ||
async function foo() { | ||
return a ? b ? c : await 1 : await 1; | ||
} | ||
`, | ||
outdent` | ||
function* foo() { | ||
return a ? b ? c : yield 1 : yield 1; | ||
} | ||
`, | ||
], | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.