Getting Started

AI Prompt: Specify the following for Cursor rules


How to use

Copy the prompt to a file in your repo.

Use the "include file" feature from your AI tool to include the prompt when chatting with your AI assistant. For example, with GitHub Copilot, use #<filename>, in Cursor, use @Files, and in Zed, use /file.

Prompt


_113
---
_113
# Specify the following for Cursor rules
_113
description: Coding rules for Supabase Edge Functions
_113
globs: "supabase/functions/**/*.ts"
_113
---
_113
_113
You're an expert in writing TypeScript and Deno JavaScript runtime. Generate **high-quality Supabase Edge Functions** that adhere to the following best practices:
_113
_113
## Guidelines
_113
_113
1. Try to use Web APIs and Deno’s core APIs instead of external dependencies (eg: use fetch instead of Axios, use WebSockets API instead of node-ws)
_113
2. If you are reusing utility methods between Edge Functions, add them to `supabase/functions/_shared` and import using a relative path. Do NOT have cross dependencies between Edge Functions.
_113
3. Do NOT use bare specifiers when importing dependecnies. If you need to use an external dependency, make sure it's prefixed with either `npm:` or `jsr:`. For example, `@supabase/supabase-js` should be written as `npm:@supabase/supabase-js`.
_113
4. For external imports, always define a version. For example, `npm:@express` should be written as `npm:[email protected]`.
_113
5. For external dependencies, importing via `npm:` and `jsr:` is preferred. Minimize the use of imports from @`deno.land/x` , `esm.sh` and @`unpkg.com` . If you have a package from one of those CDNs, you can replace the CDN hostname with `npm:` specifier.
_113
6. You can also use Node built-in APIs. You will need to import them using `node:` specifier. For example, to import Node process: `import process from "node:process". Use Node APIs when you find gaps in Deno APIs.
_113
7. Do NOT use `import { serve } from "https://deno.land/[email protected]/http/server.ts"`. Instead use the built-in `Deno.serve`.
_113
8. Following environment variables (ie. secrets) are pre-populated in both local and hosted Supabase environments. Users don't need to manually set them:
_113
* SUPABASE_URL
_113
* SUPABASE_ANON_KEY
_113
* SUPABASE_SERVICE_ROLE_KEY
_113
* SUPABASE_DB_URL
_113
9. To set other environment variables (ie. secrets) users can put them in a env file and run the `supabase secrets set --env-file path/to/env-file`
_113
10. A single Edge Function can handle multiple routes. It is recommended to use a library like Express or Hono to handle the routes as it's easier for developer to understand and maintain. Each route must be prefixed with `/function-name` so they are routed correctly.
_113
11. File write operations are ONLY permitted on `/tmp` directory. You can use either Deno or Node File APIs.
_113
12. Use `EdgeRuntime.waitUntil(promise)` static method to run long-running tasks in the background without blocking response to a request. Do NOT assume it is available in the request / execution context.
_113
_113
## Example Templates
_113
_113
### Simple Hello World Function
_113
_113
```tsx
_113
interface reqPayload {
_113
name: string;
_113
}
_113
_113
console.info('server started');
_113
_113
Deno.serve(async (req: Request) => {
_113
const { name }: reqPayload = await req.json();
_113
const data = {
_113
message: `Hello ${name} from foo!`,
_113
};
_113
_113
return new Response(
_113
JSON.stringify(data),
_113
{ headers: { 'Content-Type': 'application/json', 'Connection': 'keep-alive' }}
_113
);
_113
});
_113
_113
```
_113
_113
### Example Function using Node built-in API
_113
_113
```tsx
_113
import { randomBytes } from "node:crypto";
_113
import { createServer } from "node:http";
_113
import process from "node:process";
_113
_113
const generateRandomString = (length) => {
_113
const buffer = randomBytes(length);
_113
return buffer.toString('hex');
_113
};
_113
_113
const randomString = generateRandomString(10);
_113
console.log(randomString);
_113
_113
const server = createServer((req, res) => {
_113
const message = `Hello`;
_113
res.end(message);
_113
});
_113
_113
server.listen(9999);
_113
```
_113
_113
### Using npm packages in Functions
_113
_113
```tsx
_113
import express from "npm:[email protected]";
_113
_113
const app = express();
_113
_113
app.get(/(.*)/, (req, res) => {
_113
res.send("Welcome to Supabase");
_113
});
_113
_113
app.listen(8000);
_113
_113
```
_113
_113
### Generate embeddings using built-in @Supabase.ai API
_113
_113
```tsx
_113
const model = new Supabase.ai.Session('gte-small');
_113
_113
Deno.serve(async (req: Request) => {
_113
const params = new URL(req.url).searchParams;
_113
const input = params.get('text');
_113
const output = await model.run(input, { mean_pool: true, normalize: true });
_113
return new Response(
_113
JSON.stringify(
_113
output,
_113
),
_113
{
_113
headers: {
_113
'Content-Type': 'application/json',
_113
'Connection': 'keep-alive',
_113
},
_113
},
_113
);
_113
});
_113
_113
```