⬅️ Back to Table of Contents

📄 convert-comments.ts

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	3
📊 Variables & Constants	5

📚 Table of Contents

• Imports
• Variables & Constants
• Functions

🛠️ File Location:

📂 packages/typescript-estree/src/convert-comments.ts

📦 Imports

Name	Source
TSESTree	./ts-estree
getLocFor	./node-utils
AST_TOKEN_TYPES	./ts-estree

---

Variables & Constants

Name	Type	Kind	Value	Exported
comments	TSESTree.Comment[]	const	[]	✗
type	any	const	`comment.kind === ts.SyntaxKind.SingleLineCommentTrivia
? AST_TOKEN_TYPES.Line
: AST_TOKEN_TYPES.Block`	✗
range	TSESTree.Range	const	[comment.pos, comment.end]	✗
textStart	any	const	range[0] + 2	✗
textEnd	number	const	`comment.kind === ts.SyntaxKind.SingleLineCommentTrivia
? // single line comments end at the end
range[1] - textStart
: // multiline comments end 2 characters early
range[1] - textStart - 2`	✗

---

Functions

convertComments(ast: ts.SourceFile, code: string): TSESTree.Comment[]

Code

export function convertComments(
  ast: ts.SourceFile,
  code: string,
): TSESTree.Comment[] {
  const comments: TSESTree.Comment[] = [];

  tsutils.forEachComment(
    ast,
    (_, comment) => {
      const type =
        comment.kind === ts.SyntaxKind.SingleLineCommentTrivia
          ? AST_TOKEN_TYPES.Line
          : AST_TOKEN_TYPES.Block;
      const range: TSESTree.Range = [comment.pos, comment.end];
      const loc = getLocFor(range, ast);

      // both comments start with 2 characters - /* or //
      const textStart = range[0] + 2;
      const textEnd =
        comment.kind === ts.SyntaxKind.SingleLineCommentTrivia
          ? // single line comments end at the end
            range[1] - textStart
          : // multiline comments end 2 characters early
            range[1] - textStart - 2;
      comments.push({
        type,
        loc,
        range,
        value: code.slice(textStart, textStart + textEnd),
      });
    },
    ast,
  );

  return comments;
}

• JSDoc:

  /**
   * Convert all comments for the given AST.
   * @param ast the AST object
   * @param code the TypeScript code
   * @returns the converted ESTreeComment
   * @private
   */
  

• Parameters:

• ast: ts.SourceFile
• code: string
• Return Type: TSESTree.Comment[]
• Calls:
• tsutils.forEachComment
• getLocFor (from ./node-utils)
• comments.push
• code.slice
• Internal Comments:

  // both comments start with 2 characters - /* or // (x2)
  

---