supabase-worker-previews 0.1.1 → 0.2.0

package/README.md

@@ -37,18 +37,18 @@ flowchart LR
   preview -- "previews.vars" --> shareddb[("Shared Preview database<br/>persistent branch 'preview'")]
   pr["PR changes supabase/<br/>or has label isolated-db"] --> integ["Supabase GitHub integration"]
   integ --> prdb[("The PR's own database")]
-  pr --> action["GitHub Actions: swp pr"]
+  pr --> action["GitHub Actions: pr command"]
   action -- "SUPABASE_OVERRIDE secret" --> preview
   preview -. "PRs with their own database" .-> prdb
-  action -- "swp check reads<br/>/.well-known/supabase-preview" --> preview
+  action -- "check reads<br/>/.well-known/supabase-preview" --> preview
 ```
 
-`swp` adds no infrastructure. Cloudflare builds the Previews and Supabase makes and migrates the databases. `swp` connects the two:
+It adds no infrastructure. Cloudflare builds the Previews and Supabase makes and migrates the databases; this package connects the two:
 
 1. **Every Preview starts on the shared Preview database**, a persistent Supabase branch that tracks your trunk. Its public URL and key live in your wrangler config's `previews.vars`.
-2. **A PR that changes the schema gets its own database.** The Supabase GitHub integration creates it; `swp pr` points the PR's Preview at it with one secret, `SUPABASE_OVERRIDE`.
+2. **A PR that changes the schema gets its own database.** The Supabase GitHub integration creates it; the `pr` command points the PR's Preview at it with one secret, `SUPABASE_OVERRIDE`.
 3. **The Worker reads its Supabase settings per request.** `withSupabasePreviews()` applies the override and injects the public config into each HTML page, so no build-time `VITE_SUPABASE_URL` pins a database into the bundle.
-4. **`swp check` asks the Preview which database it serves** and fails the PR unless it is the right one.
+4. **`check` asks the Preview which database it serves** and fails the PR unless it is the right one.
 
 New to Worker Previews or Supabase branching? [Concepts](docs/concepts.md) explains both in five minutes.
 
@@ -61,7 +61,7 @@ npm install --save-dev supabase-worker-previews
 npx supabase-worker-previews init --project-ref <production project ref>
 ```
 
-`init` writes `swp.config.json`, a grants migration and the PR workflow, and prints the rest. Then:
+`init` writes `supabase-worker-previews.json`, a grants migration and the PR workflow, and prints the rest. Then:
 
 1. Connect the Supabase GitHub integration (automatic branching on, deploy to production off).
 2. Add a `previews` block to your wrangler config.
@@ -83,43 +83,43 @@ The **[full quickstart](docs/quickstart.md)** walks through every step with the
 
 ## Commands
 
-| Group          | Command      | Does                                                                                 |
-| -------------- | ------------ | ------------------------------------------------------------------------------------ |
-| **Set up**     | `swp init`   | Scaffold `swp.config.json`, the grants migration and the workflow (never overwrites) |
-|                | `swp doctor` | Check the whole setup, offline and (with a token) against Supabase                   |
-|                | `swp shared` | Create or repair the shared Preview database; prints its `previews.vars`             |
-| **Per branch** | `swp up`     | Give a branch's Preview its own database                                             |
-|                | `swp check`  | Fail unless the Preview serves the right database                                    |
-|                | `swp down`   | Delete a branch's Preview and its own database                                       |
-| **In CI**      | `swp pr`     | All of the above for a `pull_request` workflow, plus the PR comment and deployment   |
-|                | `swp prune`  | List leftovers of deleted branches and closed PRs; delete them with `--yes`          |
+Run each one as `npx supabase-worker-previews <command>`, or from an npm script.
 
-`swp` is the short name once the package is installed; the full name `supabase-worker-previews` runs the same CLI. With `npx`, always use the full name: `npx swp` on a machine without this package installed downloads [an unrelated npm package named `swp`](https://www.npmjs.com/package/swp) that deletes dependency and build folders.
+| Group          | Command  | Does                                                                                               |
+| -------------- | -------- | -------------------------------------------------------------------------------------------------- |
+| **Set up**     | `init`   | Scaffold `supabase-worker-previews.json`, the grants migration and the workflow (never overwrites) |
+|                | `doctor` | Check the whole setup, offline and (with a token) against Supabase                                 |
+|                | `shared` | Create or repair the shared Preview database; prints its `previews.vars`                           |
+| **Per branch** | `up`     | Give a branch's Preview its own database                                                           |
+|                | `check`  | Fail unless the Preview serves the right database                                                  |
+|                | `down`   | Delete a branch's Preview and its own database                                                     |
+| **In CI**      | `pr`     | All of the above for a `pull_request` workflow, plus the PR comment and deployment                 |
+|                | `prune`  | List leftovers of deleted branches and closed PRs; delete them with `--yes`                        |
 
-`swp <command> --help` shows one command's flags and examples, and `swp --version` prints the version. Flags, environment variables, every `swp.config.json` field and the GitHub Action inputs are in the [configuration reference](docs/configuration.md).
+`<command> --help` shows one command's flags and examples, and `--version` prints the version. Flags, environment variables, every `supabase-worker-previews.json` field and the GitHub Action inputs are in the [configuration reference](docs/configuration.md).
 
 ## Safety
 
-- `swp` never writes to, repoints or deletes the production project, and never deletes a persistent branch.
-- `swp check` fails the first time a Preview serves production, with no retry.
-- `swp doctor` fails if `previews.vars` names production or holds a secret.
-- `swp prune` only lists until you pass `--yes`, and every command that changes something takes `--dry-run`.
+- It never writes to, repoints or deletes the production project, and never deletes a persistent branch.
+- `check` fails the first time a Preview serves production, with no retry.
+- `doctor` fails if `previews.vars` names production or holds a secret.
+- `prune` only lists until you pass `--yes`, and every command that changes something takes `--dry-run`.
 
-[Security](docs/security.md) covers what `swp` can touch and what each token can reach.
+[Security](docs/security.md) covers what the CLI can touch and what each token can reach.
 
 ## Docs
 
-| Page                                       | For                                                                |
-| ------------------------------------------ | ------------------------------------------------------------------ |
-| [Concepts](docs/concepts.md)               | Worker Previews, Supabase branches, and how `swp` joins them       |
-| [Quickstart](docs/quickstart.md)           | From an existing Worker to the first working PR Preview            |
-| [Frameworks](docs/README.md#frameworks)    | TanStack Start, Hono, React Router v7, Astro                       |
-| [Troubleshooting](docs/troubleshooting.md) | Symptoms, causes and fixes                                         |
-| [How it works](docs/how-it-works.md)       | Every moving part and why it is built that way                     |
-| [Configuration](docs/configuration.md)     | Commands, flags, `swp.config.json`, the GitHub Action, the runtime |
-| [Tokens](docs/tokens.md)                   | Least-privilege Cloudflare, Supabase and GitHub credentials        |
-| [Security](docs/security.md)               | What `swp` can touch, what is public, what is secret               |
-| [Compared with Vercel](docs/vs-vercel.md)  | When Vercel and its Supabase integration are the better fit        |
+| Page                                       | For                                                                              |
+| ------------------------------------------ | -------------------------------------------------------------------------------- |
+| [Concepts](docs/concepts.md)               | Worker Previews, Supabase branches, and how this package joins them              |
+| [Quickstart](docs/quickstart.md)           | From an existing Worker to the first working PR Preview                          |
+| [Frameworks](docs/README.md#frameworks)    | TanStack Start, Hono, React Router v7, Astro                                     |
+| [Troubleshooting](docs/troubleshooting.md) | Symptoms, causes and fixes                                                       |
+| [How it works](docs/how-it-works.md)       | Every moving part and why it is built that way                                   |
+| [Configuration](docs/configuration.md)     | Commands, flags, `supabase-worker-previews.json`, the GitHub Action, the runtime |
+| [Tokens](docs/tokens.md)                   | Least-privilege Cloudflare, Supabase and GitHub credentials                      |
+| [Security](docs/security.md)               | What the CLI can touch, what is public, what is secret                           |
+| [Compared with Vercel](docs/vs-vercel.md)  | When Vercel and its Supabase integration are the better fit                      |
 
 The full index is [docs/README.md](docs/README.md).
 

package/dist/cli.js

@@ -2,7 +2,7 @@
 import { execFileSync } from "node:child_process";
 import { existsSync } from "node:fs";
 import { CloudflareApi } from "./cloudflare.js";
-import { loadConfig, migrationFiles } from "./config.js";
+import { CONFIG_FILE, configFileIn, DOTENV_FILE, LEGACY_CONFIG_FILE, LEGACY_DOTENV_FILE, loadConfig, migrationFiles, } from "./config.js";
 import { check, down, shared, up } from "./commands/branches.js";
 import { doctor, formatReport } from "./commands/doctor.js";
 import { init } from "./commands/init.js";
@@ -64,12 +64,14 @@ async function main(argv) {
         return 0;
     }
     if (invocation.kind === "error") {
-        console.error(`${errStyle.red("swp:")} ${invocation.message}`);
+        console.error(`${errStyle.red("supabase-worker-previews:")} ${invocation.message}`);
         return 2;
     }
     const { command, flags } = invocation;
     const dryRun = flags["dry-run"] === true;
-    const envFile = str(flags.dotenv) ?? (existsSync(".env.swp") ? ".env.swp" : undefined);
+    const envFile = str(flags.dotenv) ?? [DOTENV_FILE, LEGACY_DOTENV_FILE].find((f) => existsSync(f));
+    if (envFile === LEGACY_DOTENV_FILE)
+        console.error(errStyle.yellow(`Loading ${LEGACY_DOTENV_FILE}; rename it to ${DOTENV_FILE}.`));
     if (envFile) {
         if (!existsSync(envFile))
             throw new Error(`--dotenv ${envFile}: no such file`);
@@ -98,6 +100,8 @@ async function main(argv) {
         console.log(report.text);
         return report.pass ? 0 : 1;
     }
+    if (configFileIn() === LEGACY_CONFIG_FILE)
+        console.error(errStyle.yellow(`Reading ${LEGACY_CONFIG_FILE}; rename it to ${CONFIG_FILE}.`));
     const config = loadConfig(overrides);
     const prNum = prNumber(flags.pr);
     const event = command === "pr" ? readEvent() : undefined;
@@ -147,6 +151,6 @@ async function main(argv) {
     return 0;
 }
 main(process.argv.slice(2)).then((code) => process.exit(code), (err) => {
-    console.error(`${errStyle.red("swp:")} ${formatError(err)}`);
+    console.error(`${errStyle.red("supabase-worker-previews:")} ${formatError(err)}`);
     process.exit(1);
 });

package/dist/commands/branches.d.ts

@@ -17,7 +17,7 @@ export type Deps = {
 export declare function branchFor(gitBranch: string, deps: Deps): Promise<Branch | undefined>;
 /** The Preview a git branch deploys to: named after the branch, or `pr-<number>` when configured. */
 export declare function previewKey(gitBranch: string, config: Config, pr?: number): string;
-/** A branch `swp` may delete: never production, the shared database, the trunk's or a persistent one. */
+/** A branch `supabase-worker-previews` may delete: never production, the shared database, the trunk's or a persistent one. */
 export declare function isDisposable(branch: Branch, config: Config): boolean;
 /** Never repoint, write to or delete the production project through a branch record. */
 export declare function assertIsolated(branch: Branch, parent: string): void;

package/dist/commands/branches.js

@@ -19,7 +19,7 @@ export function previewKey(gitBranch, config, pr) {
         throw new Error(`previewName is "pr", so pass the PR number (--pr <n>)`);
     return `pr-${pr}`;
 }
-/** A branch `swp` may delete: never production, the shared database, the trunk's or a persistent one. */
+/** A branch `supabase-worker-previews` may delete: never production, the shared database, the trunk's or a persistent one. */
 export function isDisposable(branch, config) {
     return (!branch.is_default &&
         !branch.persistent &&
@@ -59,7 +59,7 @@ export async function shared(deps) {
     }
     if (!branches.some((b) => b.is_default))
         throw new Error(`Branching is not enabled on ${parent}. Connect the repo in the Supabase dashboard ` +
-            "(project settings, Integrations, GitHub, automatic branching on), then run swp shared again.");
+            "(project settings, Integrations, GitHub, automatic branching on), then run supabase-worker-previews shared again.");
     let branch = branches.find((b) => b.name === config.sharedBranch);
     if (!branch) {
         branch = await supabase.createBranch(parent, {

package/dist/commands/doctor.js

@@ -1,6 +1,6 @@
 import { existsSync, readdirSync, readFileSync } from "node:fs";
 import { join } from "node:path";
-import { CONFIG_DEFAULTS, defined, loadConfig, migrationFiles, migrationsDir, readWranglerConfig, } from "../config.js";
+import { CONFIG_DEFAULTS, CONFIG_FILE, configFileIn, defined, DOTENV_FILE, LEGACY_CONFIG_FILE, LEGACY_DOTENV_FILE, loadConfig, migrationFiles, migrationsDir, readWranglerConfig, } from "../config.js";
 import { TOKENS_URL } from "../http.js";
 import { projectRefOf } from "../runtime.js";
 import { makeStyle } from "../style.js";
@@ -37,7 +37,7 @@ export function checkLocal(config, cwd = process.cwd()) {
     const ok = (message) => out.push({ level: "ok", message });
     const warn = (message, fix) => out.push({ level: "warn", message, fix });
     const error = (message, fix) => out.push({ level: "error", message, fix });
-    const shared = "Run `swp shared` and paste the values it prints into previews.vars.";
+    const shared = "Run `supabase-worker-previews shared` and paste the values it prints into previews.vars.";
     const version = installedWranglerVersion(cwd);
     if (!version)
         warn("wrangler is not installed in this project", "npm install --save-dev wrangler@latest (4.135.0 or later)");
@@ -47,11 +47,11 @@ export function checkLocal(config, cwd = process.cwd()) {
         ok(`wrangler ${version}`);
     const wrangler = readWranglerConfig(cwd);
     if (!wrangler)
-        error("no wrangler.jsonc, wrangler.json or wrangler.toml here", "Run swp doctor in the Worker's directory.");
+        error("no wrangler.jsonc, wrangler.json or wrangler.toml here", "Run supabase-worker-previews doctor in the Worker's directory.");
     else {
         const previews = wrangler.json.previews;
         if (!previews)
-            error(`${wrangler.file} has no "previews" block, so Previews get no Supabase settings`, 'Add "previews": { "vars": {} }, redeclaring every binding the Worker uses, then run `swp shared` for the vars.');
+            error(`${wrangler.file} has no "previews" block, so Previews get no Supabase settings`, 'Add "previews": { "vars": {} }, redeclaring every binding the Worker uses, then run `supabase-worker-previews shared` for the vars.');
         else {
             const vars = (previews.vars ?? {});
             const url = typeof vars.SUPABASE_URL === "string" ? vars.SUPABASE_URL : undefined;
@@ -63,7 +63,7 @@ export function checkLocal(config, cwd = process.cwd()) {
                 ok(`previews.vars uses ${projectRefOf(url) ?? url}`);
             for (const name of SECRET_NAMES)
                 if (name in vars)
-                    error(`previews.vars holds ${name}; secrets belong in the Preview base config`, `Remove ${name} from previews.vars (swp stores it as a secret), and rotate the key if it was committed.`);
+                    error(`previews.vars holds ${name}; secrets belong in the Preview base config`, `Remove ${name} from previews.vars (supabase-worker-previews stores it as a secret), and rotate the key if it was committed.`);
             for (const key of BINDING_KEYS) {
                 if (!(key in wrangler.json) || key in previews)
                     continue;
@@ -81,13 +81,13 @@ export function checkLocal(config, cwd = process.cwd()) {
     }
     const migrations = migrationFiles(config, cwd);
     if (!migrations.length)
-        warn(`no migrations in ${migrationsDir(config)}`, 'Commit your migrations there, or set "supabaseDir" in swp.config.json.');
+        warn(`no migrations in ${migrationsDir(config)}`, 'Commit your migrations there, or set "supabaseDir" in supabase-worker-previews.json.');
     else {
         const first = readFileSync(join(cwd, migrationsDir(config), migrations[0]), "utf8");
         if (hasDefaultPrivileges(first))
             ok(`${migrations[0]} grants the API roles default privileges`);
         else
-            error(`the first migration (${migrations[0]}) does not grant default privileges; branch databases will 403`, "Run `swp init` to add the grants migration before it.");
+            error(`the first migration (${migrations[0]}) does not grant default privileges; branch databases will 403`, "Run `supabase-worker-previews init` to add the grants migration before it.");
     }
     const toml = join(cwd, config.supabaseDir, "config.toml");
     if (existsSync(toml)) {
@@ -110,7 +110,7 @@ export async function checkRemote(config, supabase, cwd = process.cwd()) {
                 level: "error",
                 message: `cannot read project ${parent}: ${err.message}`,
                 ...(status === 404 && {
-                    fix: `Check "supabaseProjectRef" in swp.config.json, and that SUPABASE_ACCESS_TOKEN can reach that project.`,
+                    fix: `Check "supabaseProjectRef" in supabase-worker-previews.json, and that SUPABASE_ACCESS_TOKEN can reach that project.`,
                 }),
             },
         ];
@@ -142,7 +142,7 @@ export async function checkRemote(config, supabase, cwd = process.cwd()) {
         out.push({
             level: "error",
             message: `no "${config.sharedBranch}" branch, the shared Preview database`,
-            fix: "Run `swp shared` to create it.",
+            fix: "Run `supabase-worker-previews shared` to create it.",
         });
         return out;
     }
@@ -150,19 +150,19 @@ export async function checkRemote(config, supabase, cwd = process.cwd()) {
         out.push({
             level: "error",
             message: `"${config.sharedBranch}" is the production project itself`,
-            fix: 'Set "sharedBranch" in swp.config.json to another name, then run `swp shared`.',
+            fix: 'Set "sharedBranch" in supabase-worker-previews.json to another name, then run `supabase-worker-previews shared`.',
         });
     if (!shared.persistent)
         out.push({
             level: "warn",
             message: `"${config.sharedBranch}" is not persistent`,
-            fix: "Run `swp shared` to make it persistent.",
+            fix: "Run `supabase-worker-previews shared` to make it persistent.",
         });
     if (shared.git_branch !== config.trunk)
         out.push({
             level: "error",
             message: `"${config.sharedBranch}" tracks ${shared.git_branch ?? "no git branch"}, not ${config.trunk}`,
-            fix: `Run \`swp shared\` to point it at ${config.trunk}.`,
+            fix: `Run \`supabase-worker-previews shared\` to point it at ${config.trunk}.`,
         });
     const vars = readWranglerConfig(cwd)?.json.previews
         ?.vars;
@@ -171,7 +171,7 @@ export async function checkRemote(config, supabase, cwd = process.cwd()) {
         out.push({
             level: "error",
             message: `previews.vars uses ${varsRef}, but "${config.sharedBranch}" is ${shared.project_ref}`,
-            fix: "Run `swp shared` and paste the values it prints into previews.vars.",
+            fix: "Run `supabase-worker-previews shared` and paste the values it prints into previews.vars.",
         });
     else if (varsRef)
         out.push({
@@ -230,6 +230,18 @@ export async function doctor(overrides, supabase, cwd = process.cwd()) {
     const local = { title: "Local files", findings: [] };
     const online = { title: "Supabase (online)", findings: [] };
     let config;
+    if (configFileIn(cwd) === LEGACY_CONFIG_FILE)
+        local.findings.push({
+            level: "warn",
+            message: `${LEGACY_CONFIG_FILE} is the name from before 0.2.0`,
+            fix: `Rename it to ${CONFIG_FILE}; the old name is still read for now.`,
+        });
+    if (existsSync(join(cwd, LEGACY_DOTENV_FILE)) && !existsSync(join(cwd, DOTENV_FILE)))
+        local.findings.push({
+            level: "warn",
+            message: `${LEGACY_DOTENV_FILE} is the name from before 0.2.0`,
+            fix: `Rename it to ${DOTENV_FILE}, and update .gitignore; the old name is still loaded for now.`,
+        });
     try {
         config = loadConfig(overrides, cwd);
     }
@@ -246,7 +258,7 @@ export async function doctor(overrides, supabase, cwd = process.cwd()) {
         online.skipped = "skipped until the config above is fixed";
     else if (!supabase)
         online.skipped =
-            "skipped: SUPABASE_ACCESS_TOKEN is not set. Add it to .env.swp to also check branching, " +
+            "skipped: SUPABASE_ACCESS_TOKEN is not set. Add it to .env.supabase-worker-previews to also check branching, " +
                 `the shared database and the GitHub integration (${TOKENS_URL}).`;
     else {
         online.title = `Supabase (online, project ${config.supabaseProjectRef})`;
@@ -281,7 +293,7 @@ export function formatReport(sections, s = makeStyle(false)) {
     const plural = (n, word) => `${n} ${word}${n === 1 ? "" : "s"}`;
     const skipped = sections.some((section) => section.skipped) ? " (online checks skipped)" : "";
     lines.push("", errors
-        ? s.red(`${plural(errors, "error")}, ${plural(warnings, "warning")}${skipped}. Fix the errors and run swp doctor again.`)
+        ? s.red(`${plural(errors, "error")}, ${plural(warnings, "warning")}${skipped}. Fix the errors and run supabase-worker-previews doctor again.`)
         : warnings
             ? s.yellow(`No errors, ${plural(warnings, "warning")}${skipped}.`)
             : s.green(`All checks passed${skipped}.`));

package/dist/commands/init.js

@@ -1,8 +1,8 @@
 import { execFileSync } from "node:child_process";
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
-import { dirname, join } from "node:path";
+import { basename, dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
-import { CONFIG_FILE, migrationFiles, migrationsDir, PLACEHOLDER_REF, readWranglerConfig, WRANGLER_FILES, } from "../config.js";
+import { CONFIG_FILE, configFileIn, migrationFiles, migrationsDir, PLACEHOLDER_REF, readWranglerConfig, WRANGLER_FILES, } from "../config.js";
 import { QUICKSTART_URL, TOKENS_URL } from "../http.js";
 import { hasDefaultPrivileges } from "./doctor.js";
 const TEMPLATES = join(dirname(fileURLToPath(import.meta.url)), "..", "..", "templates");
@@ -49,9 +49,9 @@ export function init(options = {}, cwd = process.cwd()) {
     const log = options.log ?? console.log;
     const wrangler = readWranglerConfig(cwd);
     if (!wrangler)
-        throw new Error(`No ${WRANGLER_FILES.join(", ")} in this directory. Run swp init in the Worker's directory.`);
+        throw new Error(`No ${WRANGLER_FILES.join(", ")} in this directory. Run supabase-worker-previews init in the Worker's directory.`);
     if (!wrangler.name)
-        throw new Error(`${wrangler.file} has no "name". Add the Worker's name, then run swp init again.`);
+        throw new Error(`${wrangler.file} has no "name". Add the Worker's name, then run supabase-worker-previews init again.`);
     const write = (path, content) => {
         if (options.dryRun)
             return;
@@ -60,11 +60,11 @@ export function init(options = {}, cwd = process.cwd()) {
     };
     if (options.dryRun)
         log("Dry run: nothing is written.\n");
-    const configPath = join(cwd, CONFIG_FILE);
+    const configPath = join(cwd, configFileIn(cwd));
     let needsRef;
     if (existsSync(configPath)) {
         needsRef = !hasProjectRef(readFileSync(configPath, "utf8"));
-        log(`- ${CONFIG_FILE} exists, left alone`);
+        log(`- ${basename(configPath)} exists, left alone`);
     }
     else {
         const linked = linkedProjectRef(cwd);
@@ -117,7 +117,7 @@ export function init(options = {}, cwd = process.cwd()) {
         ...(wrangler.json.previews
             ? []
             : [`Add a "previews" block to ${wrangler.file}, redeclaring every binding the Worker uses.`]),
-        "Put SUPABASE_ACCESS_TOKEN, CLOUDFLARE_API_TOKEN and CLOUDFLARE_ACCOUNT_ID in .env.swp\n" +
+        "Put SUPABASE_ACCESS_TOKEN, CLOUDFLARE_API_TOKEN and CLOUDFLARE_ACCOUNT_ID in .env.supabase-worker-previews\n" +
             `(git-ignore it; scopes: ${TOKENS_URL}),\n` +
             "then run `npx supabase-worker-previews shared` and paste the previews.vars it prints.",
         "Wrap the Worker's default export:\n" +

package/dist/commands/pr.js

@@ -4,10 +4,10 @@ import { apiErrorMessage } from "../http.js";
 import { check, down, release, up } from "./branches.js";
 export function readEvent(path = process.env.GITHUB_EVENT_PATH) {
     if (!path)
-        throw new Error("GITHUB_EVENT_PATH is not set: `swp pr` runs inside a pull_request workflow. To try one branch here, use `swp up` or `swp check`.");
+        throw new Error("GITHUB_EVENT_PATH is not set: `supabase-worker-previews pr` runs inside a pull_request workflow. To try one branch here, use `supabase-worker-previews up` or `supabase-worker-previews check`.");
     const event = JSON.parse(readFileSync(path, "utf8"));
     if (!event.pull_request)
-        throw new Error("`swp pr` needs a pull_request event");
+        throw new Error("`supabase-worker-previews pr` needs a pull_request event");
     return event;
 }
 export const PR_ENV = [
@@ -25,14 +25,14 @@ export function skipReason(event, env = process.env) {
     if (head !== undefined && head?.full_name !== event.repository.full_name)
         return {
             level: "notice",
-            message: `swp pr skipped PR #${event.number}: it comes from ${head ? `the fork ${head.full_name}` : "a deleted fork"}, and GitHub Actions gives fork PRs no secrets`,
+            message: `supabase-worker-previews pr skipped PR #${event.number}: it comes from ${head ? `the fork ${head.full_name}` : "a deleted fork"}, and GitHub Actions gives fork PRs no secrets`,
         };
     const missing = PR_ENV.filter((name) => !env[name]);
     if (missing.length) {
         const bot = env.GITHUB_ACTOR?.endsWith("[bot]") ?? false;
         return {
             level: bot ? "warning" : "error",
-            message: `swp pr ${bot ? "skipped" : "cannot check"} PR #${event.number}: ${missing.join(", ")} ${missing.length === 1 ? "is" : "are"} empty; add ${missing.length === 1 ? "it" : "them"} to the repository's Actions secrets`,
+            message: `supabase-worker-previews pr ${bot ? "skipped" : "cannot check"} PR #${event.number}: ${missing.join(", ")} ${missing.length === 1 ? "is" : "are"} empty; add ${missing.length === 1 ? "it" : "them"} to the repository's Actions secrets`,
         };
     }
     return null;

package/dist/config.d.ts

@@ -1,6 +1,12 @@
-export declare const CONFIG_FILE = "swp.config.json";
+export declare const CONFIG_FILE = "supabase-worker-previews.json";
+/** The name before 0.2.0, still read when the current one is absent. */
+export declare const LEGACY_CONFIG_FILE = "swp.config.json";
+export declare const DOTENV_FILE = ".env.supabase-worker-previews";
+export declare const LEGACY_DOTENV_FILE = ".env.swp";
+/** The config file to read in `cwd`: the current name, else the legacy one if only that exists. */
+export declare function configFileIn(cwd?: string): string;
 export declare const WRANGLER_FILES: string[];
-/** What `swp init` writes when it cannot find the project ref. */
+/** What `supabase-worker-previews init` writes when it cannot find the project ref. */
 export declare const PLACEHOLDER_REF = "<production project ref>";
 export type Config = {
     /** Worker name; defaults to `name` in the wrangler config. */
@@ -22,9 +28,9 @@ export type Config = {
     previewName: "branch" | "pr";
     /** Which Supabase API keys to hand a Preview when a project has both kinds. */
     apiKeys: "legacy" | "new";
-    /** `swp pr` keeps one status comment on the PR. Default true. */
+    /** `supabase-worker-previews pr` keeps one status comment on the PR. Default true. */
     prComment?: boolean;
-    /** `swp pr` records a GitHub deployment for the PR head. Default true. */
+    /** `supabase-worker-previews pr` records a GitHub deployment for the PR head. Default true. */
     githubDeployments?: boolean;
     /** GitHub environment of those deployments, shared by every PR; `{branch}` makes one per branch. Default "Preview". */
     deploymentEnvironment?: string;

package/dist/config.js

@@ -1,11 +1,21 @@
 import { existsSync, readdirSync, readFileSync } from "node:fs";
-import { join } from "node:path";
+import { basename, join } from "node:path";
 import { parse as parseToml } from "smol-toml";
 import { parseJsonc } from "./jsonc.js";
 import { didYouMean } from "./suggest.js";
-export const CONFIG_FILE = "swp.config.json";
+export const CONFIG_FILE = "supabase-worker-previews.json";
+/** The name before 0.2.0, still read when the current one is absent. */
+export const LEGACY_CONFIG_FILE = "swp.config.json";
+export const DOTENV_FILE = ".env.supabase-worker-previews";
+export const LEGACY_DOTENV_FILE = ".env.swp";
+/** The config file to read in `cwd`: the current name, else the legacy one if only that exists. */
+export function configFileIn(cwd = process.cwd()) {
+    return !existsSync(join(cwd, CONFIG_FILE)) && existsSync(join(cwd, LEGACY_CONFIG_FILE))
+        ? LEGACY_CONFIG_FILE
+        : CONFIG_FILE;
+}
 export const WRANGLER_FILES = ["wrangler.jsonc", "wrangler.json", "wrangler.toml"];
-/** What `swp init` writes when it cannot find the project ref. */
+/** What `supabase-worker-previews init` writes when it cannot find the project ref. */
 export const PLACEHOLDER_REF = "<production project ref>";
 export const CONFIG_DEFAULTS = {
     trunk: "main",
@@ -48,44 +58,46 @@ export function readWranglerConfig(cwd = process.cwd()) {
     return { file, json, name: typeof json.name === "string" ? json.name : undefined };
 }
 export function loadConfig(overrides = {}, cwd = process.cwd()) {
-    const path = join(cwd, CONFIG_FILE);
+    const name = configFileIn(cwd);
+    const path = join(cwd, name);
     const exists = existsSync(path);
     const file = exists ? readConfigFile(path) : {};
     const wrangler = readWranglerConfig(cwd);
     const merged = { ...CONFIG_DEFAULTS, worker: wrangler?.name, ...file, ...defined(overrides) };
     if (!merged.supabaseProjectRef)
         throw new Error(exists
-            ? `Set "supabaseProjectRef" (the production project) in ${CONFIG_FILE}`
-            : `No ${CONFIG_FILE} in this directory. Run \`swp init\` first, or pass --project-ref <ref>.`);
+            ? `Set "supabaseProjectRef" (the production project) in ${name}`
+            : `No ${name} in this directory. Run \`supabase-worker-previews init\` first, or pass --project-ref <ref>.`);
     if (merged.supabaseProjectRef === PLACEHOLDER_REF)
-        throw new Error(`"supabaseProjectRef" in ${CONFIG_FILE} is still ${PLACEHOLDER_REF}. ` +
+        throw new Error(`"supabaseProjectRef" in ${name} is still ${PLACEHOLDER_REF}. ` +
             "Set it to the production project's ref, the <ref> in https://<ref>.supabase.co.");
     if (!merged.worker)
         throw new Error(wrangler
-            ? `${wrangler.file} has no "name"; add the Worker's name there or "worker" in ${CONFIG_FILE}`
-            : `No ${WRANGLER_FILES.join(", ")} in this directory. Run swp in the Worker's directory, or set "worker" in ${CONFIG_FILE}.`);
+            ? `${wrangler.file} has no "name"; add the Worker's name there or "worker" in ${name}`
+            : `No ${WRANGLER_FILES.join(", ")} in this directory. Run supabase-worker-previews in the Worker's directory, or set "worker" in ${name}.`);
     for (const [key, allowed] of Object.entries(CHOICES)) {
         const value = merged[key];
         if (!allowed.includes(value))
-            throw new Error(`"${key}" in ${CONFIG_FILE} must be ${allowed.map((a) => `"${a}"`).join(" or ")}`);
+            throw new Error(`"${key}" in ${name} must be ${allowed.map((a) => `"${a}"`).join(" or ")}`);
     }
     return merged;
 }
 function readConfigFile(path) {
+    const name = basename(path);
     let json;
     try {
         json = JSON.parse(readFileSync(path, "utf8"));
     }
     catch (err) {
-        throw new Error(`Cannot parse ${CONFIG_FILE}: ${err.message}`, { cause: err });
+        throw new Error(`Cannot parse ${name}: ${err.message}`, { cause: err });
     }
     if (!json || typeof json !== "object" || Array.isArray(json))
-        throw new Error(`${CONFIG_FILE} must hold a JSON object`);
+        throw new Error(`${name} must hold a JSON object`);
     for (const key of Object.keys(json)) {
         if (KEYS.includes(key))
             continue;
         const guess = didYouMean(key, KEYS);
-        throw new Error(`Unknown key "${key}" in ${CONFIG_FILE}.${guess ? ` Did you mean "${guess}"?` : ""} See the README for the keys.`);
+        throw new Error(`Unknown key "${key}" in ${name}.${guess ? ` Did you mean "${guess}"?` : ""} See the README for the keys.`);
     }
     return json;
 }

package/dist/feedback.d.ts

@@ -29,7 +29,7 @@ export type FeedbackDeps = Deps & {
     clock?: () => Date;
 };
 /**
- * The PR comment and GitHub deployment for one `swp pr` run. Any GitHub API
+ * The PR comment and GitHub deployment for one `supabase-worker-previews pr` run. Any GitHub API
  * failure becomes a warning; only the wrapped database work decides the job.
  */
 export declare class Feedback {

package/dist/feedback.js

@@ -44,7 +44,7 @@ export function warning(message) {
     return `::warning::${message.replace(/%/g, "%25").replace(/\r/g, "%0D").replace(/\n/g, "%0A")}`;
 }
 /**
- * The PR comment and GitHub deployment for one `swp pr` run. Any GitHub API
+ * The PR comment and GitHub deployment for one `supabase-worker-previews pr` run. Any GitHub API
  * failure becomes a warning; only the wrapped database work decides the job.
  */
 export class Feedback {

package/dist/run.d.ts

@@ -12,7 +12,7 @@ export type Runner = {
 export declare function makeRunner(dryRun: boolean, log?: (line: string) => void): Runner;
 /**
  * `--flag value`, `--flag=value` and bare `--flag`. A flag in `booleans` never
- * takes the next argument, so `swp --dry-run up` keeps `up` as the command.
+ * takes the next argument, so `supabase-worker-previews --dry-run up` keeps `up` as the command.
  */
 export declare function parseArgs(argv: string[], booleans?: ReadonlySet<string>): {
     positional: string[];

package/dist/run.js

@@ -29,7 +29,7 @@ export function makeRunner(dryRun, log = console.log) {
 }
 /**
  * `--flag value`, `--flag=value` and bare `--flag`. A flag in `booleans` never
- * takes the next argument, so `swp --dry-run up` keeps `up` as the command.
+ * takes the next argument, so `supabase-worker-previews --dry-run up` keeps `up` as the command.
  */
 export function parseArgs(argv, booleans = new Set()) {
     const positional = [];

package/dist/runtime.d.ts

@@ -50,7 +50,7 @@ type EnvOf<H> = H extends {
 /**
  * Wraps a Worker's default export. Every handler sees the override applied;
  * `fetch` also injects the public config and answers the identity route that
- * `swp check` reads.
+ * `supabase-worker-previews check` reads.
  */
 export declare function withSupabasePreviews<H extends object, E extends object = EnvOf<H>>(handler: H & Handler, options?: PreviewOptions): H;
 export {};

package/dist/runtime.js

@@ -96,7 +96,7 @@ function envOrProcessEnv(env) {
 /**
  * Wraps a Worker's default export. Every handler sees the override applied;
  * `fetch` also injects the public config and answers the identity route that
- * `swp check` reads.
+ * `supabase-worker-previews check` reads.
  */
 export function withSupabasePreviews(handler, options = {}) {
     const { globalName = DEFAULT_GLOBAL, inject = true, identity = true } = options;

package/dist/supabase.js

@@ -148,7 +148,7 @@ export function explainCreateBranchError(ref, name, err) {
         advice = `The organization's plan does not allow persistent branches${upgrade}.`;
     else if (gate?.feature === "branching_limit" ||
         /branch(es|ing)?[ _]limit|(maximum|max|too many)[\w ]* branches/i.test(err.body))
-        advice = `Project ${ref} has reached its branch limit. Delete branches you no longer need (\`swp prune\` lists leftovers) or raise the limit${upgrade}.`;
+        advice = `Project ${ref} has reached its branch limit. Delete branches you no longer need (\`supabase-worker-previews prune\` lists leftovers) or raise the limit${upgrade}.`;
     else if (gate)
         advice = `The organization's plan does not include ${gate.feature ?? "this feature"}${upgrade}.`;
     else if (err.status === 401)

package/dist/usage.js

@@ -9,10 +9,22 @@ const TOKENS = ["SUPABASE_ACCESS_TOKEN", "CLOUDFLARE_API_TOKEN", "CLOUDFLARE_ACC
 const WITH_GITHUB = [...TOKENS, "GITHUB_TOKEN"];
 const DRY_RUN = { name: "dry-run", help: "Print the plan; change nothing" };
 const OVERRIDES = [
-    { name: "dotenv", value: "<path>", help: "Load tokens from this file (default: .env.swp when present)" },
+    {
+        name: "dotenv",
+        value: "<path>",
+        help: "Load tokens from this file (default: .env.supabase-worker-previews when present)",
+    },
     { name: "worker", value: "<name>", help: 'Worker name (default: "name" in the wrangler config)' },
-    { name: "project-ref", value: "<ref>", help: "Production project ref (default: swp.config.json)" },
-    { name: "trunk", value: "<branch>", help: "Branch the shared database tracks (default: swp.config.json)" },
+    {
+        name: "project-ref",
+        value: "<ref>",
+        help: "Production project ref (default: supabase-worker-previews.json)",
+    },
+    {
+        name: "trunk",
+        value: "<branch>",
+        help: "Branch the shared database tracks (default: supabase-worker-previews.json)",
+    },
 ];
 const BRANCH = [
     { name: "branch", value: "<b>", help: "Git branch (default: the current one, or the CI branch)" },
@@ -27,8 +39,8 @@ export const COMMANDS = [
         name: "init",
         group: "Set up",
         args: "[--project-ref <ref>] [--trunk <branch>] [--action]",
-        summary: "Scaffold swp.config.json, the grants migration and the PR workflow",
-        details: "Writes swp.config.json, a first migration that grants the API roles default privileges, and\n" +
+        summary: "Scaffold supabase-worker-previews.json, the grants migration and the PR workflow",
+        details: "Writes supabase-worker-previews.json, a first migration that grants the API roles default privileges, and\n" +
             ".github/workflows/supabase-previews.yml. Never overwrites a file; run it again safely.",
         flags: [
             { name: "project-ref", value: "<ref>", help: "Production project ref (default: from `supabase link`)" },
@@ -45,7 +57,10 @@ export const COMMANDS = [
         ],
         env: [],
         dryRunEnv: [],
-        examples: ["swp init --project-ref abcdefghijklmnopqrst", "swp init --action"],
+        examples: [
+            "supabase-worker-previews init --project-ref abcdefghijklmnopqrst",
+            "supabase-worker-previews init --action",
+        ],
     },
     {
         name: "doctor",
@@ -58,7 +73,7 @@ export const COMMANDS = [
         flags: OVERRIDES,
         env: [],
         dryRunEnv: [],
-        examples: ["swp doctor"],
+        examples: ["supabase-worker-previews doctor"],
     },
     {
         name: "shared",
@@ -71,7 +86,7 @@ export const COMMANDS = [
         flags: [DRY_RUN, ...OVERRIDES],
         env: TOKENS,
         dryRunEnv: ["SUPABASE_ACCESS_TOKEN"],
-        examples: ["swp shared --dry-run", "swp shared"],
+        examples: ["supabase-worker-previews shared --dry-run", "supabase-worker-previews shared"],
     },
     {
         name: "up",
@@ -83,7 +98,7 @@ export const COMMANDS = [
         flags: [...BRANCH, DRY_RUN, ...OVERRIDES],
         env: TOKENS,
         dryRunEnv: [],
-        examples: ["swp up --branch feat/notes --dry-run"],
+        examples: ["supabase-worker-previews up --branch feat/notes --dry-run"],
     },
     {
         name: "check",
@@ -100,7 +115,7 @@ export const COMMANDS = [
         ],
         env: TOKENS,
         dryRunEnv: [],
-        examples: ["swp check --branch feat/notes --isolated"],
+        examples: ["supabase-worker-previews check --branch feat/notes --isolated"],
     },
     {
         name: "down",
@@ -111,7 +126,7 @@ export const COMMANDS = [
         flags: [...BRANCH, DRY_RUN, ...OVERRIDES],
         env: TOKENS,
         dryRunEnv: TOKENS,
-        examples: ["swp down --branch feat/notes --dry-run"],
+        examples: ["supabase-worker-previews down --branch feat/notes --dry-run"],
     },
     {
         name: "pr",
@@ -129,7 +144,7 @@ export const COMMANDS = [
         ],
         env: WITH_GITHUB,
         dryRunEnv: WITH_GITHUB,
-        examples: ["swp pr"],
+        examples: ["supabase-worker-previews pr"],
     },
     {
         name: "prune",
@@ -149,7 +164,7 @@ export const COMMANDS = [
         ],
         env: WITH_GITHUB,
         dryRunEnv: WITH_GITHUB,
-        examples: ["swp prune", "swp prune --yes"],
+        examples: ["supabase-worker-previews prune", "supabase-worker-previews prune --yes"],
     },
 ];
 const ALL_FLAGS = [...COMMANDS.flatMap((c) => c.flags), ...HELP];
@@ -175,9 +190,9 @@ export function mainHelp(s = makeStyle(false)) {
         ...COMMANDS.filter((c) => c.group === group).map((c) => `  ${s.cyan(c.name.padEnd(width))}  ${c.summary}`),
     ]);
     return [
-        `${s.bold("swp")} ${version()}: branch previews for Cloudflare Workers on Supabase branching`,
+        `${s.bold("supabase-worker-previews")} ${version()}: branch previews for Cloudflare Workers on Supabase branching`,
         "",
-        `${s.bold("Usage:")} swp <command> [flags]`,
+        `${s.bold("Usage:")} supabase-worker-previews <command> [flags]`,
         ...groups,
         "",
         s.bold("Common flags"),
@@ -192,14 +207,14 @@ export function mainHelp(s = makeStyle(false)) {
         "  npx supabase-worker-previews doctor",
         "  npx supabase-worker-previews shared --dry-run",
         "",
-        `Run ${s.cyan("swp <command> --help")} for one command. Docs: ${DOCS_URL}`,
+        `Run ${s.cyan("supabase-worker-previews <command> --help")} for one command. Docs: ${DOCS_URL}`,
     ].join("\n");
 }
 export function commandHelp(c, s = makeStyle(false)) {
     return [
-        `${s.bold(`swp ${c.name}`)}: ${c.summary.charAt(0).toLowerCase()}${c.summary.slice(1)}`,
+        `${s.bold(`supabase-worker-previews ${c.name}`)}: ${c.summary.charAt(0).toLowerCase()}${c.summary.slice(1)}`,
         "",
-        `${s.bold("Usage:")} swp ${c.name}${c.args ? ` ${c.args}` : ""}`,
+        `${s.bold("Usage:")} supabase-worker-previews ${c.name}${c.args ? ` ${c.args}` : ""}`,
         "",
         c.details,
         "",
@@ -259,11 +274,11 @@ function unknownCommand(name) {
     const guess = didYouMean(name, COMMANDS.map((c) => c.name));
     return {
         kind: "error",
-        message: `Unknown command "${name}".${guess ? ` Did you mean "swp ${guess}"?` : ""}\nRun swp --help to see every command.`,
+        message: `Unknown command "${name}".${guess ? ` Did you mean "supabase-worker-previews ${guess}"?` : ""}\nRun supabase-worker-previews --help to see every command.`,
     };
 }
 function usageError(message, name) {
-    return { kind: "error", message: `${message}\nRun swp ${name} --help for its usage.` };
+    return { kind: "error", message: `${message}\nRun supabase-worker-previews ${name} --help for its usage.` };
 }
 const ENV_SOURCES = {
     SUPABASE_ACCESS_TOKEN: "https://supabase.com/dashboard/account/tokens (organization-scoped)",
@@ -281,11 +296,11 @@ export function missingEnvMessage(name, dryRun, env = process.env) {
     return [
         `${name}${dryRun ? " --dry-run" : ""} needs ${missing.length === 1 ? "this variable" : "these variables"}, not set:`,
         ...missing.map((v) => `  ${v.padEnd(width)}  ${ENV_SOURCES[v]}`),
-        `Put ${missing.length === 1 ? "it" : "them"} in .env.swp (git-ignore it) or the environment. Scopes: ${TOKENS_URL}`,
+        `Put ${missing.length === 1 ? "it" : "them"} in .env.supabase-worker-previews (git-ignore it) or the environment. Scopes: ${TOKENS_URL}`,
     ].join("\n");
 }
 /** One line for the user: the message, and for a network failure the host and the system error. */
-export function formatError(err, debug = !!process.env.SWP_DEBUG) {
+export function formatError(err, debug = !!(process.env.SUPABASE_WORKER_PREVIEWS_DEBUG || process.env.SWP_DEBUG)) {
     if (!(err instanceof Error))
         return String(err);
     if (debug && err.stack)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "supabase-worker-previews",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Branch previews for Cloudflare Workers on Supabase branching: every git branch gets a Worker Preview, and every PR that changes the schema gets its own Supabase database.",
   "license": "MIT",
   "author": "Matt Ruby",
@@ -34,7 +34,6 @@
     "node": ">=22.0.0"
   },
   "bin": {
-    "swp": "dist/cli.js",
     "supabase-worker-previews": "dist/cli.js"
   },
   "main": "./dist/runtime.js",

package/templates/supabase-previews-action.yml

@@ -1,7 +1,7 @@
 name: Preview database
 
 # The same job as supabase-previews.yml, through the published action. It runs
-# the project's installed swp when there is one, else downloads the package.
+# the project's installed supabase-worker-previews when there is one, else downloads the package.
 
 on:
   pull_request: