@xubylele/schema-forge 1.8.1 → 1.9.0

package/README.md

@@ -40,7 +40,7 @@ const result = await generate({ name: 'MyMigration' });
 if (result.exitCode !== EXIT_CODES.SUCCESS) process.exit(result.exitCode);
 ```
 
-**Exports:** `init`, `generate`, `diff`, `doctor`, `validate`, `introspect`, `importSchema` (each returns `Promise<RunResult>`), `RunResult` (`{ exitCode: number }`), `EXIT_CODES`, and option types (`GenerateOptions`, `DiffOptions`, etc.). Entrypoint: `@xubylele/schema-forge/api`. Exit code semantics: [docs/exit-codes.json](docs/exit-codes.json).
+**Exports:** `init`, `generate`, `diff`, `doctor`, `validate`, `introspect`, `importSchema` (each returns `Promise<RunResult>`), `RunResult` (`{ exitCode: number }`), `EXIT_CODES`, and option types (`InitOptions`, `GenerateOptions`, `DiffOptions`, etc.). Entrypoint: `@xubylele/schema-forge/api`. Exit code semantics: [docs/exit-codes.json](docs/exit-codes.json).
 
 ## Development
 
@@ -88,15 +88,20 @@ Here's a quick walkthrough to get started with SchemaForge:
 ### 1. Initialize a new project
 
 ```bash
-schema-forge init
+schema-forge init [provider]
 ```
 
+Optional `provider`: `postgres` (default) or `supabase`. You can also use `--provider <provider>`.
+
+- **postgres** – Creates `migrations/` at the project root and sets `outputDir` to `migrations`.
+- **supabase** – Uses `supabase/migrations/` for migrations. If `supabase/` does not exist, it is created; if it already exists (e.g. from `supabase init`), SchemaForge config is set to use `supabase/migrations/`.
+
 This creates:
 
 - `schemaforge/schema.sf` - Your schema definition file
-- `schemaforge/config.json` - Project configuration
+- `schemaforge/config.json` - Project configuration (includes `provider` and `outputDir`)
 - `schemaforge/state.json` - State tracking file
-- `supabase/migrations/` - Directory for generated migrations
+- `migrations/` or `supabase/migrations/` - Directory for generated migrations (depends on provider)
 
 ### 2. Define your schema
 
@@ -186,9 +191,18 @@ For common function-style defaults, comparisons are normalized to avoid obvious
 Initialize a new SchemaForge project in the current directory.
 
 ```bash
-schema-forge init
+schema-forge init [provider]
+schema-forge init --provider <provider>
 ```
 
+- **`[provider]`** (optional) – `postgres` or `supabase`. Default is `postgres`.
+- **`--provider <provider>`** – Same as above; overrides the positional argument if both are given.
+
+**Behavior:**
+
+- **postgres** (default): Creates `migrations/` at the project root. Config gets `provider: "postgres"` and `outputDir: "migrations"`.
+- **supabase**: Uses `supabase/migrations/` for generated migrations. If the `supabase/` folder does not exist, it is created along with `supabase/migrations/`. If `supabase/` already exists (e.g. from an existing Supabase project), only `supabase/migrations/` is ensured and config is set to use it. Config gets `provider: "supabase"` and `outputDir: "supabase/migrations"`.
+
 Creates the necessary directory structure and configuration files.
 
 ### `schema-forge generate`
@@ -578,6 +592,8 @@ table profiles {
 
 ## Project Structure
 
+With **postgres** (default), migrations live in `migrations/` at the project root. With **supabase**, they live in `supabase/migrations/`. Example for a Supabase-backed project:
+
 ```bash
 your-project/
 +-- schemaforge/
@@ -585,14 +601,16 @@ your-project/
 |   +-- config.json        # Project configuration
 |   \-- state.json         # State tracking (auto-generated)
 \-- supabase/
-  \-- migrations/        # Generated SQL migrations
+  \-- migrations/        # Generated SQL migrations (when provider is supabase)
     +-- 20240101120000-initial.sql
     \-- 20240101120100-add-user-avatar.sql
 ```
 
+For postgres, replace `supabase/migrations/` with a top-level `migrations/` directory.
+
 ## Configuration
 
-The `schemaforge/config.json` file contains project configuration:
+The `schemaforge/config.json` file contains project configuration. The `provider` and `outputDir` values are set by `schema-forge init` based on the provider you choose:
 
 ```json
 {
@@ -607,18 +625,21 @@ The `schemaforge/config.json` file contains project configuration:
 }
 ```
 
+- **postgres**: `provider: "postgres"`, `outputDir: "migrations"`.
+- **supabase**: `provider: "supabase"`, `outputDir: "supabase/migrations"`.
+
 ## Supported Databases
 
 Currently supports:
 
-- PostgreSQL (`postgres`)
-- Supabase (`supabase`)
+- PostgreSQL (`postgres`) – default; migrations in `migrations/`
+- Supabase (`supabase`) – migrations in `supabase/migrations/`; choose at init with `schema-forge init supabase`
 
 ## Development Workflow
 
 A typical development workflow looks like this:
 
-1. **Initialize** - `schema-forge init` (one time)
+1. **Initialize** - `schema-forge init` or `schema-forge init supabase` (one time)
 2. **Edit schema** - Modify `schemaforge/schema.sf`
 3. **Preview changes** - `schema-forge diff` (optional)
 4. **Generate migration** - `schema-forge generate --name "description"`

package/dist/api.d.ts

@@ -21,6 +21,10 @@ interface ImportOptions {
     out?: string;
 }
 
+interface InitOptions {
+    provider?: string;
+}
+
 interface IntrospectOptions {
     url?: string;
     schema?: string;
@@ -70,8 +74,9 @@ interface RunResult {
 }
 /**
  * Initialize a new schema project in the current directory.
+ * @param options.provider - Database provider: 'postgres' (default) or 'supabase'. Supabase uses supabase/migrations for output.
  */
-declare function init(): Promise<RunResult>;
+declare function init(options?: InitOptions): Promise<RunResult>;
 /**
  * Generate SQL migration from schema files.
  */
@@ -98,4 +103,4 @@ declare function introspect(options?: IntrospectOptions): Promise<RunResult>;
  */
 declare function importSchema(inputPath: string, options?: ImportOptions): Promise<RunResult>;
 
-export { type DiffOptions, type DoctorOptions, EXIT_CODES, type GenerateOptions, type ImportOptions, type IntrospectOptions, type RunResult, type ValidateOptions, diff, doctor, generate, importSchema, init, introspect, validate };
+export { type DiffOptions, type DoctorOptions, EXIT_CODES, type GenerateOptions, type ImportOptions, type InitOptions, type IntrospectOptions, type RunResult, type ValidateOptions, diff, doctor, generate, importSchema, init, introspect, validate };

package/dist/api.js

@@ -3389,7 +3389,21 @@ async function runImport(inputPath, options = {}) {
 
 // src/commands/init.ts
 var import_commander5 = require("commander");
-async function runInit() {
+var import_path11 = __toESM(require("path"));
+var ALLOWED_PROVIDERS = ["postgres", "supabase"];
+function resolveInitProvider(provider) {
+  if (!provider) {
+    return "postgres";
+  }
+  const normalized = provider.trim().toLowerCase();
+  if (ALLOWED_PROVIDERS.includes(normalized)) {
+    return normalized;
+  }
+  throw new Error(
+    `Invalid provider "${provider}". Allowed values: ${ALLOWED_PROVIDERS.join(", ")}.`
+  );
+}
+async function runInit(options) {
   const root = getProjectRoot();
   const schemaForgeDir = getSchemaForgeDir(root);
   if (await fileExists(schemaForgeDir)) {
@@ -3407,6 +3421,7 @@ async function runInit() {
   if (await fileExists(statePath)) {
     throw new Error(`${statePath} already exists`);
   }
+  const provider = resolveInitProvider(options?.provider);
   info("Initializing schema project...");
   await ensureDir(schemaForgeDir);
   const schemaContent = `# SchemaForge schema definition
@@ -3419,9 +3434,26 @@ table users {
 `;
   await writeTextFile(schemaFilePath, schemaContent);
   success(`Created ${schemaFilePath}`);
+  let outputDir;
+  if (provider === "supabase") {
+    const supabaseDir = import_path11.default.join(root, "supabase");
+    const migrationsDir = import_path11.default.join(root, "supabase", "migrations");
+    if (!await fileExists(supabaseDir)) {
+      await ensureDir(migrationsDir);
+      success(`Created supabase/migrations`);
+    } else {
+      await ensureDir(migrationsDir);
+      success(`Using existing supabase/; migrations at supabase/migrations`);
+    }
+    outputDir = "supabase/migrations";
+  } else {
+    outputDir = "migrations";
+    await ensureDir(import_path11.default.join(root, outputDir));
+    success(`Created ${outputDir}`);
+  }
   const config = {
-    provider: "postgres",
-    outputDir: "migrations",
+    provider,
+    outputDir,
     schemaFile: "schemaforge/schema.sf",
     stateFile: "schemaforge/state.json",
     sql: {
@@ -3437,9 +3469,6 @@ table users {
   };
   await writeJsonFile(statePath, state);
   success(`Created ${statePath}`);
-  const outputDir = "migrations";
-  await ensureDir(outputDir);
-  success(`Created ${outputDir}`);
   success("Project initialized successfully");
   info("Next steps:");
   info("  1. Edit schemaforge/schema.sf to define your schema");
@@ -3449,9 +3478,9 @@ table users {
 
 // src/commands/introspect.ts
 var import_commander6 = require("commander");
-var import_path11 = __toESM(require("path"));
+var import_path12 = __toESM(require("path"));
 function resolveOutputPath(root, outputPath) {
-  return import_path11.default.isAbsolute(outputPath) ? outputPath : import_path11.default.join(root, outputPath);
+  return import_path12.default.isAbsolute(outputPath) ? outputPath : import_path12.default.join(root, outputPath);
 }
 async function runIntrospect(options = {}) {
   const connectionString = resolvePostgresConnectionString({ url: options.url });
@@ -3478,9 +3507,9 @@ async function runIntrospect(options = {}) {
 
 // src/commands/validate.ts
 var import_commander7 = require("commander");
-var import_path12 = __toESM(require("path"));
+var import_path13 = __toESM(require("path"));
 function resolveConfigPath5(root, targetPath) {
-  return import_path12.default.isAbsolute(targetPath) ? targetPath : import_path12.default.join(root, targetPath);
+  return import_path13.default.isAbsolute(targetPath) ? targetPath : import_path13.default.join(root, targetPath);
 }
 async function runValidate(options = {}) {
   const root = getProjectRoot();
@@ -3598,8 +3627,8 @@ async function runWithResult(fn) {
     return { exitCode: EXIT_CODES.VALIDATION_ERROR };
   }
 }
-async function init() {
-  return runWithResult(() => runInit());
+async function init(options = {}) {
+  return runWithResult(() => runInit(options));
 }
 async function generate(options = {}) {
   return runWithResult(() => runGenerate(options));

package/dist/cli.js

@@ -2733,7 +2733,7 @@ var import_commander8 = require("commander");
 // package.json
 var package_default = {
   name: "@xubylele/schema-forge",
-  version: "1.8.1",
+  version: "1.9.0",
   description: "Universal migration generator from schema DSL",
   main: "dist/cli.js",
   type: "commonjs",
@@ -3454,7 +3454,21 @@ async function runImport(inputPath, options = {}) {
 
 // src/commands/init.ts
 var import_commander5 = require("commander");
-async function runInit() {
+var import_path11 = __toESM(require("path"));
+var ALLOWED_PROVIDERS = ["postgres", "supabase"];
+function resolveInitProvider(provider) {
+  if (!provider) {
+    return "postgres";
+  }
+  const normalized = provider.trim().toLowerCase();
+  if (ALLOWED_PROVIDERS.includes(normalized)) {
+    return normalized;
+  }
+  throw new Error(
+    `Invalid provider "${provider}". Allowed values: ${ALLOWED_PROVIDERS.join(", ")}.`
+  );
+}
+async function runInit(options) {
   const root = getProjectRoot();
   const schemaForgeDir = getSchemaForgeDir(root);
   if (await fileExists(schemaForgeDir)) {
@@ -3472,6 +3486,7 @@ async function runInit() {
   if (await fileExists(statePath)) {
     throw new Error(`${statePath} already exists`);
   }
+  const provider = resolveInitProvider(options?.provider);
   info("Initializing schema project...");
   await ensureDir(schemaForgeDir);
   const schemaContent = `# SchemaForge schema definition
@@ -3484,9 +3499,26 @@ table users {
 `;
   await writeTextFile(schemaFilePath, schemaContent);
   success(`Created ${schemaFilePath}`);
+  let outputDir;
+  if (provider === "supabase") {
+    const supabaseDir = import_path11.default.join(root, "supabase");
+    const migrationsDir = import_path11.default.join(root, "supabase", "migrations");
+    if (!await fileExists(supabaseDir)) {
+      await ensureDir(migrationsDir);
+      success(`Created supabase/migrations`);
+    } else {
+      await ensureDir(migrationsDir);
+      success(`Using existing supabase/; migrations at supabase/migrations`);
+    }
+    outputDir = "supabase/migrations";
+  } else {
+    outputDir = "migrations";
+    await ensureDir(import_path11.default.join(root, outputDir));
+    success(`Created ${outputDir}`);
+  }
   const config = {
-    provider: "postgres",
-    outputDir: "migrations",
+    provider,
+    outputDir,
     schemaFile: "schemaforge/schema.sf",
     stateFile: "schemaforge/state.json",
     sql: {
@@ -3502,9 +3534,6 @@ table users {
   };
   await writeJsonFile(statePath, state);
   success(`Created ${statePath}`);
-  const outputDir = "migrations";
-  await ensureDir(outputDir);
-  success(`Created ${outputDir}`);
   success("Project initialized successfully");
   info("Next steps:");
   info("  1. Edit schemaforge/schema.sf to define your schema");
@@ -3514,9 +3543,9 @@ table users {
 
 // src/commands/introspect.ts
 var import_commander6 = require("commander");
-var import_path11 = __toESM(require("path"));
+var import_path12 = __toESM(require("path"));
 function resolveOutputPath(root, outputPath) {
-  return import_path11.default.isAbsolute(outputPath) ? outputPath : import_path11.default.join(root, outputPath);
+  return import_path12.default.isAbsolute(outputPath) ? outputPath : import_path12.default.join(root, outputPath);
 }
 async function runIntrospect(options = {}) {
   const connectionString = resolvePostgresConnectionString({ url: options.url });
@@ -3543,9 +3572,9 @@ async function runIntrospect(options = {}) {
 
 // src/commands/validate.ts
 var import_commander7 = require("commander");
-var import_path12 = __toESM(require("path"));
+var import_path13 = __toESM(require("path"));
 function resolveConfigPath5(root, targetPath) {
-  return import_path12.default.isAbsolute(targetPath) ? targetPath : import_path12.default.join(root, targetPath);
+  return import_path13.default.isAbsolute(targetPath) ? targetPath : import_path13.default.join(root, targetPath);
 }
 async function runValidate(options = {}) {
   const root = getProjectRoot();
@@ -3710,9 +3739,12 @@ async function handleError(error2) {
   }
   process.exitCode = EXIT_CODES.VALIDATION_ERROR;
 }
-program.command("init").description("Initialize a new schema project").action(async () => {
+program.command("init").description(
+  "Initialize a new schema project. Optional provider: postgres (default) or supabase. Supabase uses supabase/migrations for output."
+).argument("[provider]", "Database provider: postgres or supabase").option("--provider <provider>", "Database provider: postgres or supabase (overrides argument)").action(async (providerArg, options) => {
   try {
-    await runInit();
+    const provider = options.provider ?? providerArg;
+    await runInit({ provider });
   } catch (error2) {
     await handleError(error2);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xubylele/schema-forge",
-  "version": "1.8.1",
+  "version": "1.9.0",
   "description": "Universal migration generator from schema DSL",
   "main": "dist/cli.js",
   "type": "commonjs",