SwallowKit VS Code Extension

日本語版 README はこちら

VS Code extension for SwallowKit — a CLI toolkit for building full-stack Azure apps with Next.js + Azure Functions + Cosmos DB + Zod schema sharing.

Features

🚀 Command Palette Integration

Access all SwallowKit commands via Ctrl+Shift+P:

Command	Description
`SwallowKit: Initialize New Project`	Guided wizard: folder → project name → CI/CD → backend language → Cosmos DB mode → VNet, then opens the project
`SwallowKit: Create Model`	Prompts for model name(s), optionally associates with a connector, runs `swallowkit create-model`, auto-opens new files
`SwallowKit: Create Dev Seed Templates`	Prompts for an environment name and runs `swallowkit create-dev-seeds <environment>`
`SwallowKit: Scaffold CRUD from Model`	Pick model file → runs `swallowkit scaffold <path>`
`SwallowKit: Scaffold CRUD (API Only)`	Same as above with `--api-only` flag
`SwallowKit: Add Connector`	Wizard: connector name → type (RDB/API) → provider, runs `swallowkit add-connector`
`SwallowKit: Add Authentication`	Select auth provider (Custom JWT / SWA / SWA+Custom / None), runs `swallowkit add-auth`
`SwallowKit: Start Dev Server`	Starts `swallowkit dev` in a dedicated terminal, offers `--seed-env` and `--mock-connectors` options
`SwallowKit: Stop Dev Server`	Stops the dev server terminal
`SwallowKit: Provision Azure Resources`	Collects Azure settings, then lets the CLI guide region selection in the terminal
`SwallowKit: Open Documentation`	Opens https://himanago.github.io/swallowkit/ in browser

Explorer: Right-click on shared/models/*.ts or lib/models/*.ts files → Scaffold CRUD
Explorer: Right-click on shared/models/ or lib/models/ folder → Create Model
Editor: Right-click when editing a model file → Scaffold CRUD

📊 Dev Server Status Bar

Stopped: ○ SwallowKit — click to start
Running: ▶ SwallowKit: Running (warning background) — click to stop

✂️ TypeScript Snippets

Prefix	Description
`skmodel`	Full SwallowKit Zod model template
`skfield-string`	String field with min/max
`skfield-number`	Number field with min
`skfield-boolean`	Boolean field with default
`skfield-enum`	Enum field
`skfield-array`	Array field
`sknested`	Nested schema reference
`skpartitionkey`	Custom Cosmos DB partition key
`skconnector-rdb`	RDB connector config (MySQL, PostgreSQL, SQL Server)
`skconnector-api`	REST API connector config

Requirements

Node.js 22.x
SwallowKit CLI: Available via npx swallowkit (or install globally: npm install -g swallowkit)
pnpm (recommended): If installed, the extension automatically uses pnpm dlx for faster execution. Falls back to npx when pnpm is not available.

Usage

Initialize a New Project

Run SwallowKit: Initialize New Project from the command palette
Select a target folder for the new project
Enter your project name
Choose CI/CD provider (GitHub Actions / Azure Pipelines / Skip)
Choose backend language (TypeScript / C# / Python)
Choose Cosmos DB mode (Free Tier / Serverless)
Choose network security (VNet Integration / None)
Wait for initialization to complete (progress shown in notification)
Choose to open the project in the current or a new window

Create a Model

Run SwallowKit: Create Model from the command palette (or right-click a models folder)
Enter model name(s), comma-separated for multiple (e.g. User, Product)
The files will be created and automatically opened in the editor

Scaffold CRUD

Run SwallowKit: Scaffold CRUD from Model from the command palette
Select a model file from the QuickPick list
CRUD code (Azure Functions + Next.js BFF + UI components) will be generated

Or right-click directly on a model file in the explorer.

Dev Server

Click the ○ SwallowKit item in the status bar to start/stop the dev server. The terminal 🐦 SwallowKit Dev will be created automatically.

If your project already has dev-seeds/<environment>/ folders, the extension will offer them before startup and run swallowkit dev --seed-env <environment>.

Dev Seeds Workflow

Run SwallowKit: Create Dev Seed Templates
Enter an environment name such as local
Edit the generated JSON files under dev-seeds/<environment>/
Run SwallowKit: Start Dev Server and choose that environment to seed the Cosmos DB Emulator before startup

Notes:

shared/models/todo.ts maps to dev-seeds/local/todo.json
Each JSON file can contain a single object or an array of objects
Every seed document must include a non-empty string id
If --seed-env is omitted, or the selected environment does not exist, current emulator data is preserved

Add External Connectors

Run SwallowKit: Add Connector from the command palette
Enter a connector name (e.g. mysql)
Select the connector type (RDB or API)
If RDB, select the provider (MySQL / PostgreSQL / SQL Server)
The connector is registered in swallowkit.config.js
Create connector-aware models with SwallowKit: Create Model — the extension will offer to associate the model with a connector

Add Authentication

Run SwallowKit: Add Authentication from the command palette
Select the auth provider (Custom JWT / Static Web Apps / SWA + Custom / None)
The authentication framework is added to the project

Dev Server with Mock Connectors

When connectors are defined in swallowkit.config.js, the Start Dev Server command will ask whether to use mock data (--mock-connectors) so you can develop locally without connecting to real external data sources.

Provision Azure Resources

Run SwallowKit: Provision Azure Resources
Enter resource group name
Optionally enter a subscription ID
The provision command starts in the terminal
Follow the CLI prompts to choose the primary Azure location and the Static Web App location
Confirm the deployment in the terminal

Extension Settings

No configurable settings in this version.

SwallowKit

himanago