@beignet/cli 0.0.3 → 0.0.5

package/src/db.ts

@@ -21,6 +21,7 @@ export type RunDatabaseCommandOptions = {
  * Result returned by a database lifecycle command.
  */
 export type RunDatabaseCommandResult = {
+  schemaVersion: 1;
   command: DatabaseCommand;
   cwd: string;
   script: string;
@@ -56,18 +57,20 @@ export async function runDatabaseCommand(
   const cwd = path.resolve(options.cwd ?? process.cwd());
   const script = databaseScripts[options.command];
   const packageJson = await readPackageJson(cwd);
+  const scriptCommand = packageJson.scripts?.[script];
 
-  if (!packageJson.scripts?.[script]) {
-    throw new Error(
-      `Missing package.json script "${script}". Add it to this Beignet app before running beignet db ${options.command}.`,
-    );
+  if (!scriptCommand) {
+    throw new Error(missingDatabaseScriptMessage(options.command, script));
   }
 
+  await assertDatabaseCommandPreflight(cwd, options.command, scriptCommand);
+
   const runner = await detectPackageManager(cwd);
   const args = ["run", script];
 
   if (options.dryRun) {
     return {
+      schemaVersion: 1,
       command: options.command,
       cwd,
       script,
@@ -83,6 +86,7 @@ export async function runDatabaseCommand(
   });
 
   return {
+    schemaVersion: 1,
     command: options.command,
     cwd,
     script,
@@ -96,6 +100,58 @@ export async function runDatabaseCommand(
   };
 }
 
+async function assertDatabaseCommandPreflight(
+  cwd: string,
+  command: DatabaseCommand,
+  scriptCommand: string,
+): Promise<void> {
+  if (
+    (command === "generate" || command === "migrate") &&
+    /\bdrizzle-kit\b/.test(scriptCommand) &&
+    !hasExplicitDrizzleConfigFlag(scriptCommand) &&
+    !(await exists(path.join(cwd, "drizzle.config.ts"))) &&
+    !(await exists(path.join(cwd, "drizzle.config.mts"))) &&
+    !(await exists(path.join(cwd, "drizzle.config.js"))) &&
+    !(await exists(path.join(cwd, "drizzle.config.mjs")))
+  ) {
+    throw new Error(
+      `Missing Drizzle config. beignet db ${command} runs "${scriptCommand}", but no drizzle.config.ts, drizzle.config.mts, drizzle.config.js, or drizzle.config.mjs exists in the app root.`,
+    );
+  }
+
+  const standardEntrypoints: Partial<Record<DatabaseCommand, string>> = {
+    seed: "infra/db/seed.ts",
+    reset: "infra/db/reset.ts",
+  };
+  const standardEntrypoint = standardEntrypoints[command];
+  if (
+    standardEntrypoint &&
+    scriptCommand.includes(standardEntrypoint) &&
+    !(await exists(path.join(cwd, standardEntrypoint)))
+  ) {
+    throw new Error(
+      `Missing database ${command} entrypoint ${standardEntrypoint}. beignet db ${command} runs "${scriptCommand}", so restore ${standardEntrypoint} or update package.json script "${databaseScripts[command]}".`,
+    );
+  }
+}
+
+function hasExplicitDrizzleConfigFlag(scriptCommand: string): boolean {
+  return /(?:^|\s)--config(?:=|\s)/.test(scriptCommand);
+}
+
+function missingDatabaseScriptMessage(
+  command: DatabaseCommand,
+  script: string,
+): string {
+  if (command === "generate" || command === "migrate") {
+    return `Missing package.json script "${script}". Standard Drizzle apps use "${script}": "drizzle-kit ${command}" with drizzle.config.ts at the app root.`;
+  }
+
+  const entrypoint =
+    command === "seed" ? "infra/db/seed.ts" : "infra/db/reset.ts";
+  return `Missing package.json script "${script}". Standard Drizzle apps use "${script}": "bun ${entrypoint}" so beignet db ${command} can run the app-owned ${command} entrypoint.`;
+}
+
 async function readPackageJson(cwd: string): Promise<PackageJson> {
   try {
     return JSON.parse(

package/src/github-annotations.ts

@@ -0,0 +1,37 @@
+/**
+ * Severity levels understood by GitHub Actions workflow commands.
+ */
+export type GithubAnnotationSeverity = "error" | "warning" | "notice";
+
+/**
+ * Format one GitHub Actions annotation workflow command.
+ *
+ * Absent properties are omitted and the message is percent-encoded so
+ * multiline messages survive the single-line command format.
+ */
+export function formatGithubAnnotation(annotation: {
+  severity: GithubAnnotationSeverity;
+  message: string;
+  file?: string;
+  line?: number;
+  col?: number;
+}): string {
+  const properties = [
+    annotation.file === undefined ? undefined : `file=${annotation.file}`,
+    annotation.line === undefined ? undefined : `line=${annotation.line}`,
+    annotation.col === undefined ? undefined : `col=${annotation.col}`,
+  ].filter((property): property is string => property !== undefined);
+  const propertySection =
+    properties.length > 0 ? ` ${properties.join(",")}` : "";
+
+  return `::${annotation.severity}${propertySection}::${encodeGithubAnnotationMessage(
+    annotation.message,
+  )}`;
+}
+
+function encodeGithubAnnotationMessage(message: string): string {
+  return message
+    .replaceAll("%", "%25")
+    .replaceAll("\r", "%0D")
+    .replaceAll("\n", "%0A");
+}