package.json

{
  "name": "fastapi-vscode",
  "displayName": "FastAPI Extension",
  "description": "VS Code extension for FastAPI development",
  "version": "0.0.4",
  "publisher": "FastAPILabs",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "https://github.com/fastapi/fastapi-vscode"
  },
  "bugs": {
    "url": "https://github.com/fastapi/fastapi-vscode/issues"
  },
  "homepage": "https://github.com/fastapi/fastapi-vscode#readme",
  "engines": {
    "vscode": "^1.85.0"
  },
  "main": "./dist/extension.js",
  "browser": "./dist/web/extension.js",
  "activationEvents": [
    "workspaceContains:**/*.py",
    "workspaceContains:.fastapicloud/cloud.json"
  ],
  "categories": [
    "Other"
  ],
  "capabilities": {
    "virtualWorkspaces": true,
    "untrustedWorkspaces": {
      "supported": true
    }
  },
  "contributes": {
    "authentication": [
      {
        "id": "fastapi-vscode",
        "label": "FastAPI Cloud"
      }
    ],
    "commands": [
      {
        "command": "fastapi-vscode.refreshEndpoints",
        "title": "Refresh Endpoints",
        "category": "FastAPI",
        "icon": "$(refresh)"
      },
      {
        "command": "fastapi-vscode.toggleRouters",
        "title": "Toggle Expand/Collapse Routers",
        "category": "FastAPI",
        "icon": "$(fold)"
      },
      {
        "command": "fastapi-vscode.copyEndpointPath",
        "title": "Copy Endpoint Path",
        "category": "FastAPI"
      },
      {
        "command": "fastapi-vscode.goToRouter",
        "title": "Go to Router Definition",
        "category": "FastAPI"
      },
      {
        "command": "fastapi-vscode.reportIssue",
        "title": "Report Issue...",
        "category": "FastAPI"
      },
      {
        "command": "fastapi-vscode.searchEndpoints",
        "title": "Search Endpoints...",
        "category": "FastAPI",
        "icon": "$(search)"
      },
      {
        "command": "fastapi-vscode.linkApp",
        "title": "Link Project",
        "category": "FastAPI Cloud"
      },
      {
        "command": "fastapi-vscode.unlinkApp",
        "title": "Unlink Project",
        "category": "FastAPI Cloud"
      },
      {
        "command": "fastapi-vscode.signIn",
        "title": "Sign In",
        "category": "FastAPI Cloud"
      },
      {
        "command": "fastapi-vscode.signOut",
        "title": "Sign Out",
        "category": "FastAPI Cloud"
      }
    ],
    "keybindings": [
      {
        "command": "fastapi-vscode.searchEndpoints",
        "key": "ctrl+shift+e",
        "mac": "cmd+shift+e"
      }
    ],
    "menus": {
      "commandPalette": [
        {
          "command": "fastapi-vscode.copyEndpointPath",
          "when": "false"
        },
        {
          "command": "fastapi-vscode.goToRouter",
          "when": "false"
        },
        {
          "command": "fastapi-vscode.linkApp",
          "when": "config.fastapi.cloud.enabled"
        },
        {
          "command": "fastapi-vscode.unlinkApp",
          "when": "config.fastapi.cloud.enabled"
        },
        {
          "command": "fastapi-vscode.signIn",
          "when": "config.fastapi.cloud.enabled"
        },
        {
          "command": "fastapi-vscode.signOut",
          "when": "config.fastapi.cloud.enabled"
        }
      ],
      "view/title": [
        {
          "command": "fastapi-vscode.refreshEndpoints",
          "when": "view == endpoint-explorer",
          "group": "navigation@1"
        },
        {
          "command": "fastapi-vscode.toggleRouters",
          "when": "view == endpoint-explorer",
          "group": "navigation@2"
        }
      ],
      "view/item/context": [
        {
          "command": "fastapi-vscode.copyEndpointPath",
          "when": "view == endpoint-explorer && viewItem == route",
          "group": "navigation"
        },
        {
          "command": "fastapi-vscode.goToRouter",
          "when": "view == endpoint-explorer && viewItem == router",
          "group": "navigation"
        }
      ]
    },
    "viewsContainers": {
      "activitybar": [
        {
          "id": "fastapi",
          "title": "FastAPI",
          "icon": "media/icons/logo-outline.svg"
        }
      ]
    },
    "views": {
      "fastapi": [
        {
          "id": "endpoint-explorer",
          "name": "Endpoint Explorer",
          "icon": "media/icons/logo-outline.svg"
        }
      ]
    },
    "viewsWelcome": [
      {
        "view": "endpoint-explorer",
        "contents": "No FastAPI apps found in this workspace.\n\n[Configure Entry Point](command:workbench.action.openSettings?[\"fastapi.entryPoint\"])\n\n[Open Getting Started](command:workbench.action.openWalkthrough?{\"category\":\"FastAPILabs.fastapi-vscode#fastapi-getting-started\"})"
      }
    ],
    "walkthroughs": [
      {
        "id": "fastapi-getting-started",
        "title": "Get Started with FastAPI",
        "description": "Learn how to use the FastAPI extension to boost your productivity",
        "icon": "media/icons/logo-teal.svg",
        "steps": [
          {
            "id": "view-endpoints",
            "title": "View Your API Endpoints",
            "description": "Open the Endpoint Explorer in the Activity Bar (⚡) to see all routes in your FastAPI application.\n[Open Endpoint Explorer](command:endpoint-explorer.focus)",
            "media": {
              "image": "media/walkthrough/endpoints.gif",
              "altText": "Endpoint Explorer showing FastAPI routes organized by router"
            },
            "completionEvents": [
              "onView:endpoint-explorer"
            ]
          },
          {
            "id": "search-endpoints",
            "title": "Quickly Find Endpoints",
            "description": "Instantly filter and navigate to any endpoint in your application.\n[Search Endpoints](command:fastapi-vscode.searchEndpoints)",
            "media": {
              "image": "media/walkthrough/search.gif",
              "altText": "Search endpoints quick pick showing filtered results"
            },
            "completionEvents": [
              "onCommand:fastapi-vscode.searchEndpoints"
            ]
          },
          {
            "id": "codelens",
            "title": "Navigate from Tests to Routes",
            "description": "CodeLens links appear above test client calls to jump directly to the route definition.",
            "media": {
              "image": "media/walkthrough/codelens.gif",
              "altText": "CodeLens link above test client call"
            }
          },
          {
            "id": "configure",
            "title": "Configure Your Project",
            "description": "If the extension doesn't find your FastAPI app automatically, you can specify the entry point in settings.\n[Open Settings](command:workbench.action.openSettings?[\"fastapi.entryPoint\"])",
            "media": {
              "image": "media/walkthrough/configure.gif",
              "altText": "FastAPI entry point configuration in VS Code settings"
            }
          },
          {
            "id": "feedback",
            "title": "Give Feedback & Get Help",
            "description": "Help us improve! Report bugs, request features, or contribute to the project.\n\n[Report an Issue](command:fastapi-vscode.reportIssue)\n[View on GitHub](https://github.com/fastapi/fastapi-vscode)",
            "media": {
              "image": "media/walkthrough/feedback.gif",
              "altText": "FastAPI extension output panel showing debug logs"
            }
          }
        ]
      }
    ],
    "configuration": {
      "title": "FastAPI",
      "properties": {
        "fastapi.entryPoint": {
          "type": "string",
          "default": "",
          "scope": "resource",
          "description": "Path to the main FastAPI application file (e.g., 'src/main.py'). If not set, the extension will search common locations."
        },
        "fastapi.codeLens.enabled": {
          "type": "boolean",
          "default": true,
          "scope": "resource",
          "description": "Show CodeLens links above test client calls (e.g., client.get('/items')) to navigate to the corresponding route definition."
        },
        "fastapi.cloud.enabled": {
          "type": "boolean",
          "default": true,
          "scope": "window",
          "description": "Enable FastAPI Cloud integration (status bar, link/unlink commands)."
        },
        "fastapi.telemetry.enabled": {
          "type": "boolean",
          "default": true,
          "scope": "machine",
          "description": "Enable telemetry to help improve the extension. No personal data is collected."
        }
      }
    }
  },
  "scripts": {
    "vscode:prepublish": "bun run esbuild.js --production",
    "compile": "bun run esbuild.js",
    "watch": "bun run esbuild.js --watch",
    "package": "vsce package",
    "publish:marketplace": "vsce publish",
    "lint": "biome check --write --unsafe --no-errors-on-unmatched --files-ignore-unknown=true src/",
    "test": "bun run compile && vscode-test",
    "test:coverage": "bash scripts/test-coverage.sh",
    "test:web": "bun run compile && bunx @vscode/test-web --extensionDevelopmentPath=. --browserType=none",
    "prepare": "husky"
  },
  "devDependencies": {
    "@biomejs/biome": "^2.3.11",
    "@types/bun": "latest",
    "@types/mocha": "^10.0.10",
    "@types/sinon": "^21.0.0",
    "@types/vscode": "^1.85.0",
    "@vscode/test-cli": "^0.0.12",
    "@vscode/test-electron": "^2.5.2",
    "@vscode/vsce": "^3.7.1",
    "esbuild": "^0.27.2",
    "husky": "^9.1.7",
    "lint-staged": "^16.2.7",
    "path-browserify": "^1.0.1",
    "sinon": "^21.0.1",
    "typescript": "^5.0.0"
  },
  "dependencies": {
    "posthog-node": "^5.24.1",
    "toml": "^3.0.0",
    "web-tree-sitter": "^0.26.3"
  },
  "lint-staged": {
    "**/*.{ts,js,json}": [
      "biome check --write"
    ]
  }
}