@getstrata/cli 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @getstrata/cli changelog
+
+## 1.0.1
+
+- `strata --help` and `strata -h` print help instead of reporting an unknown command.
+- `migrate` and `migrate:fresh` call an optional `close()` export from the app's migrate entry. Without it, a pooled driver such as `mysql2` kept the event loop alive and the command hung after finishing its work.
+- Dropped the `prepublishOnly` build. It produced a `dist/` that `files` never shipped; the `bin` is the Bun TypeScript entry.
+- README no longer advertises `strata new`, which this package does not implement.
+- `migrate` prints `Migrations applied.` and `migrate:fresh` prints `Database reset and migrated.` on success instead of exiting silently.
+
+## 1.0.0
+
+- First stable release of the `strata` binary: `dev`, `start`, `migrate`, `migrate:fresh`, `run`, plus app-registered commands.

package/README.md

@@ -1,14 +1,41 @@
 # @getstrata/cli
 
-Framework CLI for Strata apps. Bun stays the runtime, installer, and test runner. `strata` owns app lifecycle and framework commands.
+The `strata` binary for [Strata](https://github.com/EyK-26/strata) apps. Bun stays the runtime, installer, and test runner; `strata` owns the app lifecycle. Requires Bun (tested on 1.4.x).
+
+## Commands
 
 ```bash
 strata dev
 strata start
 strata migrate
+strata migrate:fresh
 strata run src/scripts/backfill.ts
+strata help
+```
+
+`strata --help` and `strata -h` print the same list as `strata help`.
+
+`strata run <file>` executes a file with the app preload. It is not an alias for `bun run <script>`.
+
+`strata start` does not migrate when `APP_ENV=production`. Run `strata migrate` as an explicit deploy step.
+
+## Running it
+
+This package installs into your app, not globally, so `strata` lands in `node_modules/.bin` and is not on your `PATH`. Use the scripts a generated app already ships:
+
+```bash
+bun run dev
+bun run db:migrate
 ```
 
+Or call it directly from inside the app directory:
+
+```bash
+bunx strata dev
+```
+
+Running `bunx strata` from outside a Strata app resolves an unrelated npm package named `strata` and starts a static file server. Stay in the app directory.
+
 ## How it finds your app
 
 From the current working directory, `strata` loads `strata.config.ts` if present, then falls back to conventions:
@@ -22,12 +49,19 @@ From the current working directory, `strata` loads `strata.config.ts` if present
 | `migrate` | `src/db/migrate.ts` |
 | `fresh` | `src/db/fresh.ts` |
 
-`src/cli/register.ts` can export `commands` or `registerCommands()` to add app-specific commands such as `make:*`, `queue:work`, and `openapi:*`.
+`src/cli/register.ts` can export `commands` or `registerCommands()` to add your own commands. Generated apps do not ship one, so `make:*`, `queue:work`, and `openapi:*` are yours to write if you want them.
 
-`strata run <file>` executes a file with the app preload. It is not an alias for `bun run <package.json script>`.
+A migrate entry may export `close()`. The CLI calls it after `migrate()` and `fresh()` so pooled drivers such as `mysql2` release the event loop instead of hanging the command.
 
-`strata new my-app --yes` scaffolds a new directory (same generator as `bunx create-strata`). `strata new --frontend=hybrid` (no project name) copies the HTML overlay and the SPA overlay into the current directory. Hybrid keeps HTML at `/` and serves the SPA under `/app/*`.
+## Creating a new app
+
+This package does not scaffold. Use the starter:
+
+```bash
+bunx create-strata my-app
+```
 
-## This monorepo
+## Docs
 
-`bun run cli <command>` is an alias for `strata <command>`. `bun run dev` starts HiroApp.
+- [Getting started](https://github.com/EyK-26/strata/blob/main/docs/GETTING-STARTED.md)
+- [Building apps](https://github.com/EyK-26/strata/blob/main/docs/BUILDING-APPS.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getstrata/cli",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Strata CLI: framework commands for Bun apps (dev, start, migrate, run)",
   "type": "module",
   "license": "MIT",
@@ -21,12 +21,10 @@
   "files": [
     "cli.ts",
     "src",
-    "README.md"
+    "README.md",
+    "CHANGELOG.md"
   ],
-  "scripts": {
-    "build": "bun build cli.ts --outdir dist --target bun --external bun",
-    "prepublishOnly": "bun run build"
-  },
+  "scripts": {},
   "publishConfig": {
     "access": "public"
   },

package/src/commands/migrate.ts

@@ -5,12 +5,23 @@ type MigrateModule = {
   migrate?: (...args: string[]) => Promise<void> | void;
   seed?: (...args: string[]) => Promise<void> | void;
   fresh?: (...args: string[]) => Promise<void> | void;
+  close?: () => Promise<void> | void;
 };
 
 async function importEntry(path: string): Promise<MigrateModule> {
   return (await import(pathToFileURL(path).href)) as MigrateModule;
 }
 
+/**
+ * Pooled drivers such as mysql2 keep the event loop alive, so a migrate that
+ * finished its work would otherwise hang until the process is killed.
+ */
+async function closeEntry(entry: MigrateModule): Promise<void> {
+  if (typeof entry.close === "function") {
+    await entry.close();
+  }
+}
+
 async function migrateCommand(app: StrataAppConfig, args: string[]): Promise<void> {
   if (!app.migrate) {
     throw new Error(
@@ -23,11 +34,16 @@ async function migrateCommand(app: StrataAppConfig, args: string[]): Promise<voi
     throw new Error(`${app.migrate} must export a migrate() function.`);
   }
 
-  await entry.migrate(...args);
+  try {
+    await entry.migrate(...args);
 
-  if (typeof entry.seed === "function") {
-    await entry.seed(...args);
+    if (typeof entry.seed === "function") {
+      await entry.seed(...args);
+    }
+  } finally {
+    await closeEntry(entry);
   }
+  console.log("Migrations applied.");
 }
 
 async function migrateFreshCommand(app: StrataAppConfig, args: string[]): Promise<void> {
@@ -36,7 +52,12 @@ async function migrateFreshCommand(app: StrataAppConfig, args: string[]): Promis
     if (typeof entry.fresh !== "function") {
       throw new Error(`${app.fresh} must export a fresh() function.`);
     }
-    await entry.fresh(...args);
+    try {
+      await entry.fresh(...args);
+    } finally {
+      await closeEntry(entry);
+    }
+    console.log("Database reset and migrated.");
     return;
   }
 

package/src/runCli.ts

@@ -7,6 +7,8 @@ import { startCommand } from "./commands/start.ts";
 import { loadAppCommands, resolveApp } from "./resolveApp.ts";
 import type { RunCliOptions, StrataAppConfig, StrataCommandMap } from "./types.ts";
 
+const HELP_FLAGS = new Set(["--help", "-h", "help"]);
+
 function builtinCommands(app: StrataAppConfig): StrataCommandMap {
   const commands: StrataCommandMap = {
     dev: async () => async () => {
@@ -60,7 +62,8 @@ async function runCli(options: RunCliOptions = {}): Promise<number> {
     printHelp(commandNames);
   };
 
-  const [command = "help", ...args] = options.argv ?? process.argv.slice(2);
+  const [requested = "help", ...args] = options.argv ?? process.argv.slice(2);
+  const command = HELP_FLAGS.has(requested) ? "help" : requested;
   const loadHandler = registry[command];
 
   const fail = (code: number): number => {