Method getFileDescriptor

packages/language-server/src/server.js:338–360

* @param {string} filePath * @param {{ isShowContention?: boolean }} [options] * @returns {File | typeof SESSION_LOADING | undefined}

(filePath, options)

   * @returns {File | typeof SESSION_LOADING | undefined}
   */
  getFileDescriptor(filePath, options) {
    if (!this.session) return SESSION_LOADING;
    const relPath = toPosix(path.relative(this.cwd ?? process.cwd(), filePath));
    if (relPath.startsWith('..')) return;
    if (this.fileCache?.filePath === relPath) return this.fileCache.file;
    const startTime = performance.now();
    const file = this.session.describeFile(relPath, options);
    if (file) {
      const duration = Math.round(performance.now() - startTime);
      const mem = process.memoryUsage().heapUsed;
      this.connection.console.log(
        `Received file descriptor (${relPath} • ${duration}ms • ${(mem / 1024 / 1024).toFixed(2)}M)`
      );
      const m = file.metrics;
      this.connection.console.log(
        `  ↳ imports: ${Math.round(m.imports)}ms, exports: ${Math.round(m.exports)}ms, cycles: ${Math.round(m.cycles)}ms, contention: ${Math.round(m.contention)}ms`
      );
    } else {
      this.connection.console.log(`File not in project (${relPath})`);
    }
    this.fileCache = { filePath: relPath, file };
    return file;
  }

  /**
   * @returns {import('knip/session').PackageJsonFile & { dependenciesUsage: Record<string, import('knip/session').DependencyNodes> } | typeof SESSION_LOADING}