Skip to content

⬅️ Back to Table of Contents

📄 prefer-optional-chain.ts

📊 Analysis Summary

Metric Count
🔧 Functions 17
📦 Imports 14
📊 Variables & Constants 8

📚 Table of Contents

🛠️ File Location:

📂 packages/eslint-plugin/src/rules/prefer-optional-chain.ts

📦 Imports

Name Source
TSESTree @typescript-eslint/utils
RuleFix @typescript-eslint/utils/ts-eslint
AST_NODE_TYPES @typescript-eslint/utils
ValidOperand ./prefer-optional-chain-utils/gatherLogicalOperands
PreferOptionalChainMessageIds ./prefer-optional-chain-utils/PreferOptionalChainOptions
PreferOptionalChainOptions ./prefer-optional-chain-utils/PreferOptionalChainOptions
createRule ../util
getOperatorPrecedence ../util
getParserServices ../util
OperatorPrecedence ../util
analyzeChain ./prefer-optional-chain-utils/analyzeChain
checkNullishAndReport ./prefer-optional-chain-utils/checkNullishAndReport
gatherLogicalOperands ./prefer-optional-chain-utils/gatherLogicalOperands
OperandValidity ./prefer-optional-chain-utils/gatherLogicalOperands

Variables & Constants

Name Type Kind Value Exported
seenLogicals Set<TSESTree.LogicalExpression> const new Set<TSESTree.LogicalExpression>() ✗
currentChain ValidOperand[] let/var [] ✗
leftNode any const node.left ✗
rightNode any const node.right ✗
parentNode any const node.parent ✗
isRightNodeAnEmptyObjectLiteral boolean const `rightNode.type === AST_NODE_TYPES.ObjectExpression &&
rightNode.properties.length === 0` ✗
maybeWrappedLeftNode any const `isLeftSideLowerPrecedence()
? (${leftNodeText})
: leftNodeText` ✗
maybeWrappedProperty any const `parentNode.computed
? [${propertyToBeOptionalText}]
: propertyToBeOptionalText` ✗

Functions

isLeftSideLowerPrecedence(): boolean

Code 
function isLeftSideLowerPrecedence(): boolean {
          const logicalTsNode = parserServices.esTreeNodeToTSNodeMap.get(node);
          const leftTsNode = parserServices.esTreeNodeToTSNodeMap.get(leftNode);
          const leftPrecedence = getOperatorPrecedence(
            leftTsNode.kind,
            logicalTsNode.operatorToken.kind,
          );

          return leftPrecedence < OperatorPrecedence.LeftHandSide;
        }
  • Return Type: boolean
  • Calls:
  • parserServices.esTreeNodeToTSNodeMap.get
  • getOperatorPrecedence (from ../util)

fix(fixer: any): RuleFix

Code 
(fixer): RuleFix => {
                const leftNodeText = context.sourceCode.getText(leftNode);
                // Any node that is made of an operator with higher or equal precedence,
                const maybeWrappedLeftNode = isLeftSideLowerPrecedence()
                  ? `(${leftNodeText})`
                  : leftNodeText;
                const propertyToBeOptionalText = context.sourceCode.getText(
                  parentNode.property,
                );
                const maybeWrappedProperty = parentNode.computed
                  ? `[${propertyToBeOptionalText}]`
                  : propertyToBeOptionalText;
                return fixer.replaceTextRange(
                  parentNode.range,
                  `${maybeWrappedLeftNode}?.${maybeWrappedProperty}`,
                );
              }
  • Parameters:
  • fixer: any
  • Return Type: RuleFix
  • Calls:
  • context.sourceCode.getText
  • isLeftSideLowerPrecedence
  • fixer.replaceTextRange
  • Internal Comments: 
    // Any node that is made of an operator with higher or equal precedence, (x2)

fix(fixer: any): RuleFix

Code 
(fixer): RuleFix => {
                const leftNodeText = context.sourceCode.getText(leftNode);
                // Any node that is made of an operator with higher or equal precedence,
                const maybeWrappedLeftNode = isLeftSideLowerPrecedence()
                  ? `(${leftNodeText})`
                  : leftNodeText;
                const propertyToBeOptionalText = context.sourceCode.getText(
                  parentNode.property,
                );
                const maybeWrappedProperty = parentNode.computed
                  ? `[${propertyToBeOptionalText}]`
                  : propertyToBeOptionalText;
                return fixer.replaceTextRange(
                  parentNode.range,
                  `${maybeWrappedLeftNode}?.${maybeWrappedProperty}`,
                );
              }
  • Parameters:
  • fixer: any
  • Return Type: RuleFix
  • Calls:
  • context.sourceCode.getText
  • isLeftSideLowerPrecedence
  • fixer.replaceTextRange
  • Internal Comments: 
    // Any node that is made of an operator with higher or equal precedence, (x2)

fix(fixer: any): RuleFix

Code 
(fixer): RuleFix => {
                const leftNodeText = context.sourceCode.getText(leftNode);
                // Any node that is made of an operator with higher or equal precedence,
                const maybeWrappedLeftNode = isLeftSideLowerPrecedence()
                  ? `(${leftNodeText})`
                  : leftNodeText;
                const propertyToBeOptionalText = context.sourceCode.getText(
                  parentNode.property,
                );
                const maybeWrappedProperty = parentNode.computed
                  ? `[${propertyToBeOptionalText}]`
                  : propertyToBeOptionalText;
                return fixer.replaceTextRange(
                  parentNode.range,
                  `${maybeWrappedLeftNode}?.${maybeWrappedProperty}`,
                );
              }
  • Parameters:
  • fixer: any
  • Return Type: RuleFix
  • Calls:
  • context.sourceCode.getText
  • isLeftSideLowerPrecedence
  • fixer.replaceTextRange
  • Internal Comments: 
    // Any node that is made of an operator with higher or equal precedence, (x2)

fix(fixer: any): RuleFix

Code 
(fixer): RuleFix => {
                const leftNodeText = context.sourceCode.getText(leftNode);
                // Any node that is made of an operator with higher or equal precedence,
                const maybeWrappedLeftNode = isLeftSideLowerPrecedence()
                  ? `(${leftNodeText})`
                  : leftNodeText;
                const propertyToBeOptionalText = context.sourceCode.getText(
                  parentNode.property,
                );
                const maybeWrappedProperty = parentNode.computed
                  ? `[${propertyToBeOptionalText}]`
                  : propertyToBeOptionalText;
                return fixer.replaceTextRange(
                  parentNode.range,
                  `${maybeWrappedLeftNode}?.${maybeWrappedProperty}`,
                );
              }
  • Parameters:
  • fixer: any
  • Return Type: RuleFix
  • Calls:
  • context.sourceCode.getText
  • isLeftSideLowerPrecedence
  • fixer.replaceTextRange
  • Internal Comments: 
    // Any node that is made of an operator with higher or equal precedence, (x2)

fix(fixer: any): RuleFix

Code 
(fixer): RuleFix => {
                const leftNodeText = context.sourceCode.getText(leftNode);
                // Any node that is made of an operator with higher or equal precedence,
                const maybeWrappedLeftNode = isLeftSideLowerPrecedence()
                  ? `(${leftNodeText})`
                  : leftNodeText;
                const propertyToBeOptionalText = context.sourceCode.getText(
                  parentNode.property,
                );
                const maybeWrappedProperty = parentNode.computed
                  ? `[${propertyToBeOptionalText}]`
                  : propertyToBeOptionalText;
                return fixer.replaceTextRange(
                  parentNode.range,
                  `${maybeWrappedLeftNode}?.${maybeWrappedProperty}`,
                );
              }
  • Parameters:
  • fixer: any
  • Return Type: RuleFix
  • Calls:
  • context.sourceCode.getText
  • isLeftSideLowerPrecedence
  • fixer.replaceTextRange
  • Internal Comments: 
    // Any node that is made of an operator with higher or equal precedence, (x2)

fix(fixer: any): RuleFix

Code 
(fixer): RuleFix => {
                const leftNodeText = context.sourceCode.getText(leftNode);
                // Any node that is made of an operator with higher or equal precedence,
                const maybeWrappedLeftNode = isLeftSideLowerPrecedence()
                  ? `(${leftNodeText})`
                  : leftNodeText;
                const propertyToBeOptionalText = context.sourceCode.getText(
                  parentNode.property,
                );
                const maybeWrappedProperty = parentNode.computed
                  ? `[${propertyToBeOptionalText}]`
                  : propertyToBeOptionalText;
                return fixer.replaceTextRange(
                  parentNode.range,
                  `${maybeWrappedLeftNode}?.${maybeWrappedProperty}`,
                );
              }
  • Parameters:
  • fixer: any
  • Return Type: RuleFix
  • Calls:
  • context.sourceCode.getText
  • isLeftSideLowerPrecedence
  • fixer.replaceTextRange
  • Internal Comments: 
    // Any node that is made of an operator with higher or equal precedence, (x2)

fix(fixer: any): RuleFix

Code 
(fixer): RuleFix => {
                const leftNodeText = context.sourceCode.getText(leftNode);
                // Any node that is made of an operator with higher or equal precedence,
                const maybeWrappedLeftNode = isLeftSideLowerPrecedence()
                  ? `(${leftNodeText})`
                  : leftNodeText;
                const propertyToBeOptionalText = context.sourceCode.getText(
                  parentNode.property,
                );
                const maybeWrappedProperty = parentNode.computed
                  ? `[${propertyToBeOptionalText}]`
                  : propertyToBeOptionalText;
                return fixer.replaceTextRange(
                  parentNode.range,
                  `${maybeWrappedLeftNode}?.${maybeWrappedProperty}`,
                );
              }
  • Parameters:
  • fixer: any
  • Return Type: RuleFix
  • Calls:
  • context.sourceCode.getText
  • isLeftSideLowerPrecedence
  • fixer.replaceTextRange
  • Internal Comments: 
    // Any node that is made of an operator with higher or equal precedence, (x2)

fix(fixer: any): RuleFix

Code 
(fixer): RuleFix => {
                const leftNodeText = context.sourceCode.getText(leftNode);
                // Any node that is made of an operator with higher or equal precedence,
                const maybeWrappedLeftNode = isLeftSideLowerPrecedence()
                  ? `(${leftNodeText})`
                  : leftNodeText;
                const propertyToBeOptionalText = context.sourceCode.getText(
                  parentNode.property,
                );
                const maybeWrappedProperty = parentNode.computed
                  ? `[${propertyToBeOptionalText}]`
                  : propertyToBeOptionalText;
                return fixer.replaceTextRange(
                  parentNode.range,
                  `${maybeWrappedLeftNode}?.${maybeWrappedProperty}`,
                );
              }
  • Parameters:
  • fixer: any
  • Return Type: RuleFix
  • Calls:
  • context.sourceCode.getText
  • isLeftSideLowerPrecedence
  • fixer.replaceTextRange
  • Internal Comments: 
    // Any node that is made of an operator with higher or equal precedence, (x2)

fix(fixer: any): RuleFix

Code 
(fixer): RuleFix => {
                const leftNodeText = context.sourceCode.getText(leftNode);
                // Any node that is made of an operator with higher or equal precedence,
                const maybeWrappedLeftNode = isLeftSideLowerPrecedence()
                  ? `(${leftNodeText})`
                  : leftNodeText;
                const propertyToBeOptionalText = context.sourceCode.getText(
                  parentNode.property,
                );
                const maybeWrappedProperty = parentNode.computed
                  ? `[${propertyToBeOptionalText}]`
                  : propertyToBeOptionalText;
                return fixer.replaceTextRange(
                  parentNode.range,
                  `${maybeWrappedLeftNode}?.${maybeWrappedProperty}`,
                );
              }
  • Parameters:
  • fixer: any
  • Return Type: RuleFix
  • Calls:
  • context.sourceCode.getText
  • isLeftSideLowerPrecedence
  • fixer.replaceTextRange
  • Internal Comments: 
    // Any node that is made of an operator with higher or equal precedence, (x2)

fix(fixer: any): RuleFix

Code 
(fixer): RuleFix => {
                const leftNodeText = context.sourceCode.getText(leftNode);
                // Any node that is made of an operator with higher or equal precedence,
                const maybeWrappedLeftNode = isLeftSideLowerPrecedence()
                  ? `(${leftNodeText})`
                  : leftNodeText;
                const propertyToBeOptionalText = context.sourceCode.getText(
                  parentNode.property,
                );
                const maybeWrappedProperty = parentNode.computed
                  ? `[${propertyToBeOptionalText}]`
                  : propertyToBeOptionalText;
                return fixer.replaceTextRange(
                  parentNode.range,
                  `${maybeWrappedLeftNode}?.${maybeWrappedProperty}`,
                );
              }
  • Parameters:
  • fixer: any
  • Return Type: RuleFix
  • Calls:
  • context.sourceCode.getText
  • isLeftSideLowerPrecedence
  • fixer.replaceTextRange
  • Internal Comments: 
    // Any node that is made of an operator with higher or equal precedence, (x2)

fix(fixer: any): RuleFix

Code 
(fixer): RuleFix => {
                const leftNodeText = context.sourceCode.getText(leftNode);
                // Any node that is made of an operator with higher or equal precedence,
                const maybeWrappedLeftNode = isLeftSideLowerPrecedence()
                  ? `(${leftNodeText})`
                  : leftNodeText;
                const propertyToBeOptionalText = context.sourceCode.getText(
                  parentNode.property,
                );
                const maybeWrappedProperty = parentNode.computed
                  ? `[${propertyToBeOptionalText}]`
                  : propertyToBeOptionalText;
                return fixer.replaceTextRange(
                  parentNode.range,
                  `${maybeWrappedLeftNode}?.${maybeWrappedProperty}`,
                );
              }
  • Parameters:
  • fixer: any
  • Return Type: RuleFix
  • Calls:
  • context.sourceCode.getText
  • isLeftSideLowerPrecedence
  • fixer.replaceTextRange
  • Internal Comments: 
    // Any node that is made of an operator with higher or equal precedence, (x2)

fix(fixer: any): RuleFix

Code 
(fixer): RuleFix => {
                const leftNodeText = context.sourceCode.getText(leftNode);
                // Any node that is made of an operator with higher or equal precedence,
                const maybeWrappedLeftNode = isLeftSideLowerPrecedence()
                  ? `(${leftNodeText})`
                  : leftNodeText;
                const propertyToBeOptionalText = context.sourceCode.getText(
                  parentNode.property,
                );
                const maybeWrappedProperty = parentNode.computed
                  ? `[${propertyToBeOptionalText}]`
                  : propertyToBeOptionalText;
                return fixer.replaceTextRange(
                  parentNode.range,
                  `${maybeWrappedLeftNode}?.${maybeWrappedProperty}`,
                );
              }
  • Parameters:
  • fixer: any
  • Return Type: RuleFix
  • Calls:
  • context.sourceCode.getText
  • isLeftSideLowerPrecedence
  • fixer.replaceTextRange
  • Internal Comments: 
    // Any node that is made of an operator with higher or equal precedence, (x2)

fix(fixer: any): RuleFix

Code 
(fixer): RuleFix => {
                const leftNodeText = context.sourceCode.getText(leftNode);
                // Any node that is made of an operator with higher or equal precedence,
                const maybeWrappedLeftNode = isLeftSideLowerPrecedence()
                  ? `(${leftNodeText})`
                  : leftNodeText;
                const propertyToBeOptionalText = context.sourceCode.getText(
                  parentNode.property,
                );
                const maybeWrappedProperty = parentNode.computed
                  ? `[${propertyToBeOptionalText}]`
                  : propertyToBeOptionalText;
                return fixer.replaceTextRange(
                  parentNode.range,
                  `${maybeWrappedLeftNode}?.${maybeWrappedProperty}`,
                );
              }
  • Parameters:
  • fixer: any
  • Return Type: RuleFix
  • Calls:
  • context.sourceCode.getText
  • isLeftSideLowerPrecedence
  • fixer.replaceTextRange
  • Internal Comments: 
    // Any node that is made of an operator with higher or equal precedence, (x2)

fix(fixer: any): RuleFix

Code 
(fixer): RuleFix => {
                const leftNodeText = context.sourceCode.getText(leftNode);
                // Any node that is made of an operator with higher or equal precedence,
                const maybeWrappedLeftNode = isLeftSideLowerPrecedence()
                  ? `(${leftNodeText})`
                  : leftNodeText;
                const propertyToBeOptionalText = context.sourceCode.getText(
                  parentNode.property,
                );
                const maybeWrappedProperty = parentNode.computed
                  ? `[${propertyToBeOptionalText}]`
                  : propertyToBeOptionalText;
                return fixer.replaceTextRange(
                  parentNode.range,
                  `${maybeWrappedLeftNode}?.${maybeWrappedProperty}`,
                );
              }
  • Parameters:
  • fixer: any
  • Return Type: RuleFix
  • Calls:
  • context.sourceCode.getText
  • isLeftSideLowerPrecedence
  • fixer.replaceTextRange
  • Internal Comments: 
    // Any node that is made of an operator with higher or equal precedence, (x2)

fix(fixer: any): RuleFix

Code 
(fixer): RuleFix => {
                const leftNodeText = context.sourceCode.getText(leftNode);
                // Any node that is made of an operator with higher or equal precedence,
                const maybeWrappedLeftNode = isLeftSideLowerPrecedence()
                  ? `(${leftNodeText})`
                  : leftNodeText;
                const propertyToBeOptionalText = context.sourceCode.getText(
                  parentNode.property,
                );
                const maybeWrappedProperty = parentNode.computed
                  ? `[${propertyToBeOptionalText}]`
                  : propertyToBeOptionalText;
                return fixer.replaceTextRange(
                  parentNode.range,
                  `${maybeWrappedLeftNode}?.${maybeWrappedProperty}`,
                );
              }
  • Parameters:
  • fixer: any
  • Return Type: RuleFix
  • Calls:
  • context.sourceCode.getText
  • isLeftSideLowerPrecedence
  • fixer.replaceTextRange
  • Internal Comments: 
    // Any node that is made of an operator with higher or equal precedence, (x2)

fix(fixer: any): RuleFix

Code 
(fixer): RuleFix => {
                const leftNodeText = context.sourceCode.getText(leftNode);
                // Any node that is made of an operator with higher or equal precedence,
                const maybeWrappedLeftNode = isLeftSideLowerPrecedence()
                  ? `(${leftNodeText})`
                  : leftNodeText;
                const propertyToBeOptionalText = context.sourceCode.getText(
                  parentNode.property,
                );
                const maybeWrappedProperty = parentNode.computed
                  ? `[${propertyToBeOptionalText}]`
                  : propertyToBeOptionalText;
                return fixer.replaceTextRange(
                  parentNode.range,
                  `${maybeWrappedLeftNode}?.${maybeWrappedProperty}`,
                );
              }
  • Parameters:
  • fixer: any
  • Return Type: RuleFix
  • Calls:
  • context.sourceCode.getText
  • isLeftSideLowerPrecedence
  • fixer.replaceTextRange
  • Internal Comments: 
    // Any node that is made of an operator with higher or equal precedence, (x2)