Skip to content

Commit fdab950

Browse files
savannahostrowskisavannahostrowski
committed
✨ Initial scaffolding
0 parents  commit fdab950

20 files changed

Lines changed: 1153 additions & 0 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
lint:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- uses: oven-sh/setup-bun@v2
15+
- run: bun install
16+
- run: bun run lint
17+
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v4
22+
- uses: oven-sh/setup-bun@v2
23+
- run: bun install
24+
- run: bun run compile

‎.github/workflows/publish.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Publish Extension
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
publish:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v4
12+
- uses: oven-sh/setup-bun@v2
13+
- run: bun install
14+
- run: bun run package
15+
- name: Publish to VS Code Marketplace
16+
run: bun run publish:marketplace
17+
env:
18+
VSCE_PAT: ${{ secrets.VSCE_PAT }}

‎.gitignore‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# dependencies (bun install)
2+
node_modules
3+
4+
# output
5+
out
6+
dist
7+
*.tgz
8+
9+
# code coverage
10+
coverage
11+
*.lcov
12+
13+
# logs
14+
logs
15+
_.log
16+
report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
17+
18+
# dotenv environment variable files
19+
.env
20+
.env.development.local
21+
.env.test.local
22+
.env.production.local
23+
.env.local
24+
25+
# caches
26+
.eslintcache
27+
.cache
28+
*.tsbuildinfo
29+
30+
# IntelliJ based IDEs
31+
.idea
32+
33+
# Finder (MacOS) folder config
34+
.DS_Store
35+
36+
# VS Code extension
37+
*.vsix
38+
.vscode-test

‎.vscode/launch.json‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"version": "0.2.0",
3+
"configurations": [
4+
{
5+
"name": "Run Extension",
6+
"type": "extensionHost",
7+
"request": "launch",
8+
"args": ["--extensionDevelopmentPath=${workspaceFolder}"],
9+
"outFiles": ["${workspaceFolder}/dist/**/*.js"],
10+
"preLaunchTask": "${defaultBuildTask}"
11+
},
12+
{
13+
"name": "Extension Tests",
14+
"type": "extensionHost",
15+
"request": "launch",
16+
"args": [
17+
"--extensionDevelopmentPath=${workspaceFolder}",
18+
"--extensionTestsPath=${workspaceFolder}/dist/test/suite/index"
19+
],
20+
"outFiles": ["${workspaceFolder}/dist/test/**/*.js"],
21+
"preLaunchTask": "${defaultBuildTask}"
22+
}
23+
]
24+
}

‎.vscode/tasks.json‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"version": "2.0.0",
3+
"tasks": [
4+
{
5+
"type": "npm",
6+
"script": "watch",
7+
"problemMatcher": "$tsc-watch",
8+
"isBackground": true,
9+
"presentation": {
10+
"reveal": "never"
11+
},
12+
"group": {
13+
"kind": "build",
14+
"isDefault": true
15+
}
16+
},
17+
{
18+
"type": "npm",
19+
"script": "compile",
20+
"problemMatcher": "$tsc",
21+
"presentation": {
22+
"reveal": "silent"
23+
},
24+
"group": "build"
25+
}
26+
]
27+
}

‎.vscodeignore‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.vscode/**
2+
.vscode-test/**
3+
src/**
4+
.gitignore
5+
.yarnrc
6+
**/*.map
7+
**/*.ts
8+
**/tsconfig.json
9+
esbuild.js
10+
node_modules/**
11+
bun.lockb

‎CLAUDE.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# FastAPI VS Code Extension
2+
3+
VS Code extension for FastAPI development.
4+
5+
## Commands
6+
7+
- `bun run compile` - Build the extension
8+
- `bun run watch` - Build with watch mode
9+
- `bun run lint` - Lint and format code
10+
- `bun run package` - Package extension as .vsix
11+
12+
## Structure
13+
14+
- `src/extension.ts` - Extension entry point
15+
- `src/commands/` - Command handlers
16+
- `src/providers/` - TreeView, CodeLens providers
17+
- `src/services/` - FastAPI endpoint scanning
18+
- `src/types/` - TypeScript interfaces

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 FastAPI Labs
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# FastAPI VS Code Extension
2+
3+
A VS Code extension for FastAPI development.
4+
5+
## Features
6+
7+
- Hello World command (example)
8+
9+
## Development
10+
11+
### Prerequisites
12+
13+
- [Bun](https://bun.sh) installed
14+
- VS Code
15+
16+
### Setup
17+
18+
1. Install dependencies:
19+
```bash
20+
bun install
21+
```
22+
23+
2. Build the extension:
24+
```bash
25+
bun run compile
26+
```
27+
28+
3. Press `F5` to open a new window with your extension loaded
29+
30+
### Scripts
31+
32+
- `bun run compile` - Compile the extension
33+
- `bun run watch` - Watch for changes and recompile
34+
- `bun run package` - Package the extension into a .vsix file
35+
- `bun run publish` - Publish the extension to the marketplace
36+
37+
## Project Structure
38+
39+
- `src/extension.ts` - Extension entry point
40+
- `esbuild.js` - esbuild configuration
41+
- `package.json` - Extension manifest
42+
- `tsconfig.json` - TypeScript configuration
43+
44+
## Technologies
45+
46+
- TypeScript
47+
- esbuild
48+
- Bun (package manager)
49+
- VS Code Extension API

‎SUPPORT.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Support
2+
3+
If you encounter any issues or have questions about the FastAPI VS Code extension, please file an issue on GitHub:
4+
5+
https://github.com/fastapi/fastapi-vscode/issues

0 commit comments

Comments
 (0)