Skip to content

@sbtools/plugin-deno-functions

npm

Plugin that documents Supabase Edge Functions by statically analysing TypeScript source files.

Quick Start

bash
npm install @sbtools/plugin-deno-functions

Add to config:

json
{
  "plugins": [
    {
      "path": "@sbtools/plugin-deno-functions",
      "config": {
        "baseUrl": "/functions/v1",
        "configTomlPath": "supabase/config.toml"
      }
    }
  ]
}
bash
npx sbt edge-functions

Commands

CommandDescription
edge-functionsList discovered edge functions
edge-functions --briefSummary table only
edge-functions --jsonOutput raw JSON
edge-functions --openapiGenerate OpenAPI spec
$ npx sbt edge-functions --brief

Edge Functions (4 discovered)
┌──────────────────┬────────┬─────────────────────────┐
│ Function         │ Verify │ Endpoint                │
├──────────────────┼────────┼─────────────────────────┤
│ send-email       │ JWT    │ /functions/v1/send-email │
│ process-payment  │ JWT    │ /functions/v1/process-…  │
│ generate-report  │ JWT    │ /functions/v1/generate-… │
│ health-check     │ none   │ /functions/v1/health-c…  │
└──────────────────┴────────┴─────────────────────────┘

Configuration

KeyDefaultDescription
baseUrl/functions/v1URL prefix for edge function endpoints
configTomlPathsupabase/config.tomlPath to Supabase config.toml

Integration

Results integrate into Backend Atlas, Swagger UI/ReDoc, and sbt status.