summaryrefslogtreecommitdiff
path: root/packages/core/src/ide/detect-ide.ts
blob: 759c410347d25a88e7af6561b24e305d562bbe17 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/**
 * @license
 * Copyright 2025 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */

export enum DetectedIde {
  VSCode = 'vscode',
  VSCodium = 'vscodium',
  Cursor = 'cursor',
  CloudShell = 'cloudshell',
  Codespaces = 'codespaces',
  Windsurf = 'windsurf',
  FirebaseStudio = 'firebasestudio',
  Trae = 'trae',
}

export function getIdeDisplayName(ide: DetectedIde): string {
  switch (ide) {
    case DetectedIde.VSCode:
      return 'VS Code';
    case DetectedIde.VSCodium:
      return 'VSCodium';
    case DetectedIde.Cursor:
      return 'Cursor';
    case DetectedIde.CloudShell:
      return 'Cloud Shell';
    case DetectedIde.Codespaces:
      return 'GitHub Codespaces';
    case DetectedIde.Windsurf:
      return 'Windsurf';
    case DetectedIde.FirebaseStudio:
      return 'Firebase Studio';
    case DetectedIde.Trae:
      return 'Trae';
    default: {
      // This ensures that if a new IDE is added to the enum, we get a compile-time error.
      const exhaustiveCheck: never = ide;
      return exhaustiveCheck;
    }
  }
}

export function detectIde(): DetectedIde | undefined {
  // Only VSCode-based integrations are currently supported.
  if (process.env.TERM_PROGRAM !== 'vscode') {
    return undefined;
  }
  if (process.env.CURSOR_TRACE_ID) {
    return DetectedIde.Cursor;
  }
  if (process.env.CODESPACES) {
    return DetectedIde.Codespaces;
  }
  if (process.env.EDITOR_IN_CLOUD_SHELL) {
    return DetectedIde.CloudShell;
  }
  if (process.env.TERM_PRODUCT === 'Trae') {
    return DetectedIde.Trae;
  }
  if (process.env.FIREBASE_DEPLOY_AGENT) {
    return DetectedIde.FirebaseStudio;
  }
  return DetectedIde.VSCode;
}