⬅️ Back to Table of Contents

📄 describeFilePath.ts

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	1

📚 Table of Contents

• Imports
• Functions

🛠️ File Location:

📂 packages/typescript-estree/src/create-program/describeFilePath.ts

📦 Imports

Name	Source
path	node:path

---

Functions

describeFilePath(filePath: string, tsconfigRootDir: string): string

Code

export function describeFilePath(
  filePath: string,
  tsconfigRootDir: string,
): string {
  // If the TSConfig root dir is a parent of the filePath, use
  // `<tsconfigRootDir>` as a prefix for the path.
  const relative = path.relative(tsconfigRootDir, filePath);
  if (relative && !relative.startsWith('..') && !path.isAbsolute(relative)) {
    return `<tsconfigRootDir>/${relative}`;
  }

  // Root-like Mac/Linux (~/*, ~*) or Windows (C:/*, /) paths that aren't
  // relative to the TSConfig root dir should be fully described.
  // This avoids strings like <tsconfigRootDir>/../../../../repo/file.ts.
  // https://github.com/typescript-eslint/typescript-eslint/issues/6289
  if (/^[(\w+:)\\/~]/.test(filePath)) {
    return filePath;
  }

  // Similarly, if the relative path would contain a lot of ../.., then
  // ignore it and print the file path directly.
  if (/\.\.[/\\]\.\./.test(relative)) {
    return filePath;
  }

  // Lastly, since we've eliminated all special cases, we know the cleanest
  // path to print is probably the prefixed relative one.
  return `<tsconfigRootDir>/${relative}`;
}

• Parameters:
• filePath: string
• tsconfigRootDir: string
• Return Type: string
• Calls:
• path.relative
• relative.startsWith
• path.isAbsolute
• /^[(\w+:)\\/~]/.test
• /\.\.[/\\]\.\./.test
• Internal Comments:

  // If the TSConfig root dir is a parent of the filePath, use (x2)
  // `<tsconfigRootDir>` as a prefix for the path. (x2)
  // Root-like Mac/Linux (~/*, ~*) or Windows (C:/*, /) paths that aren't
  // relative to the TSConfig root dir should be fully described.
  // This avoids strings like <tsconfigRootDir>/../../../../repo/file.ts.
  // https://github.com/typescript-eslint/typescript-eslint/issues/6289
  // Similarly, if the relative path would contain a lot of ../.., then
  // ignore it and print the file path directly.
  // Lastly, since we've eliminated all special cases, we know the cleanest
  // path to print is probably the prefixed relative one.
  

---