⬅️ Back to Table of Contents

📄 getForStatementHeadLoc.ts

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	3

📚 Table of Contents

• Imports
• Functions

🛠️ File Location:

📂 packages/eslint-plugin/src/util/getForStatementHeadLoc.ts

📦 Imports

Name	Source
TSESLint	@typescript-eslint/utils
TSESTree	@typescript-eslint/utils
nullThrows	@typescript-eslint/utils/eslint-utils

---

Functions

`getForStatementHeadLoc(sourceCode: TSESLint.SourceCode, node: | TSESTree.ForInStatement

| TSESTree.ForOfStatement
| TSESTree.ForStatement): TSESTree.SourceLocation`

Code

export function getForStatementHeadLoc(
  sourceCode: TSESLint.SourceCode,
  node:
    | TSESTree.ForInStatement
    | TSESTree.ForOfStatement
    | TSESTree.ForStatement,
): TSESTree.SourceLocation {
  const closingParens = nullThrows(
    sourceCode.getTokenBefore(node.body, token => token.value === ')'),
    'for statement must have a closing parenthesis.',
  );
  return {
    end: structuredClone(closingParens.loc.end),
    start: structuredClone(node.loc.start),
  };
}

• JSDoc:

  /**
   * Gets the location of the head of the given for statement variant for reporting.
   *
   * - `for (const foo in bar) expressionOrBlock`
   *    ^^^^^^^^^^^^^^^^^^^^^^
   *
   * - `for (const foo of bar) expressionOrBlock`
   *    ^^^^^^^^^^^^^^^^^^^^^^
   *
   * - `for await (const foo of bar) expressionOrBlock`
   *    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   *
   * - `for (let i = 0; i < 10; i++) expressionOrBlock`
   *    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   */
  

• Parameters:

• sourceCode: TSESLint.SourceCode
• node: | TSESTree.ForInStatement | TSESTree.ForOfStatement | TSESTree.ForStatement
• Return Type: TSESTree.SourceLocation
• Calls:
• nullThrows (from @typescript-eslint/utils/eslint-utils)
• sourceCode.getTokenBefore
• structuredClone

---