create-nexwire 4.2.5 → 4.4.0

package/fastify/src/framework/maker-cli/module/index.mjs

@@ -0,0 +1,211 @@
+import { runSeed } from "../db/core.mjs";
+import { assertName } from "../utils/naming.mjs";
+import {
+  assertModuleHasSeeders,
+  cleanModuleTrash,
+  deleteModule,
+  deleteNotificationModule,
+  listModules,
+  makeController,
+  makeHelper,
+  makeJob,
+  makeLocalMiddleware,
+  makeModel,
+  makeModule,
+  makeModuleProvider,
+  makeModules,
+  makeNotificationModule,
+  makeRoute,
+  makeSchedule,
+  makeSchema,
+  makeSeeder,
+  makeService,
+  makeTest,
+  makeType,
+  runModuleMigrate
+} from "./core.mjs";
+
+/** Register module:* subcommands on the CLI program. */
+export function registerModuleCommands(program, rawArgs) {
+  program
+    .command("module:make <names...>")
+    .description("Create one or more modules with facade, providers, schema, service, controller, route, model, and seeder folders")
+    .option("--path <panel>", "Nest the module(s) under a panel folder (e.g. --path=admin)")
+    .option("--force", "Overwrite the files of modules that already exist")
+    .allowUnknownOption(true)
+    .action(async (names) => {
+      const result = await makeModules(names, rawArgs.slice(1 + names.length));
+      if (result.failed.length) process.exitCode = 1;
+    });
+  program
+    .command("module:make-notification [name]")
+    .description("Generate the notification HTTP module, and the shared store the first time")
+    .option("--path <panel>", "Nest the module under a panel folder (e.g. --path=admin)")
+    .option("--notifiable <type>", "Owner type recorded with each notification (default: user)")
+    .option("--force", "Overwrite the files of a module that already exists")
+    .allowUnknownOption(true)
+    .action(async (name) => {
+      const maybeModule = name && !name.startsWith("--") ? name : "";
+      const flagStart = maybeModule ? 2 : 1;
+      await makeNotificationModule(maybeModule || "notification", rawArgs.slice(flagStart));
+    });
+  program
+    .command("module:delete-notification [name]")
+    .description("Remove notification module (moves to trash)")
+    .option("--yes", "Confirm deletion without prompt")
+    .option("--dry-run", "Print what would be deleted without executing")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (name) => {
+      const maybeModule = name && !name.startsWith("--") ? name : "";
+      const flagStart = maybeModule ? 2 : 1;
+      await deleteNotificationModule(maybeModule || "notification", rawArgs.slice(flagStart));
+    });
+  program
+    .command("module:delete <name>")
+    .description("Move a module directory to storage trash (soft delete)")
+    .option("--yes", "Confirm deletion without prompt")
+    .option("--dry-run", "Print what would be deleted without executing")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (name) => deleteModule(name, rawArgs.slice(2)));
+  program
+    .command("module:trash:clean [name]")
+    .description("Permanently remove entries from module trash storage")
+    .option("--yes", "Confirm cleanup without prompt")
+    .option("--dry-run", "Print what would be cleaned without executing")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (name) => {
+      const maybeModule = name && !name.startsWith("--") ? name : "";
+      const flagStart = maybeModule ? 2 : 1;
+      await cleanModuleTrash(maybeModule, rawArgs.slice(flagStart));
+    });
+  program
+    .command("module:make-route <module> [controller]")
+    .description("Generate a route file for an existing module")
+    .option("--force", "Overwrite existing route file")
+    .option("--dry-run", "Print what would be created without executing")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (moduleName, controller) => makeRoute(moduleName, controller, rawArgs.slice(controller ? 3 : 2)));
+  program
+    .command("module:make-controller <module> [name]")
+    .description("Generate a controller for an existing module")
+    .option("--force", "Overwrite existing controller file")
+    .option("--dry-run", "Print what would be created without executing")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (moduleName, name) => makeController(moduleName, name, rawArgs.slice(name ? 3 : 2)));
+  program
+    .command("module:make-schema <module> [name]")
+    .description("Generate a schema file for an existing module")
+    .option("--force", "Overwrite existing schema file")
+    .option("--dry-run", "Print what would be created without executing")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (moduleName, name) => makeSchema(moduleName, name, rawArgs.slice(name ? 3 : 2)));
+  program
+    .command("module:make-service <module> [name]")
+    .description("Generate a service file for an existing module")
+    .option("--with-model", "Query database/models/<name>.ts instead of returning empty defaults")
+    .option("--force", "Overwrite existing service file")
+    .option("--dry-run", "Print what would be created without executing")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (moduleName, name) => makeService(moduleName, name, rawArgs.slice(name ? 3 : 2)));
+  program
+    .command("module:make-helper <module> [name]")
+    .description("Generate a helper file in the module's helpers folder")
+    .option("--force", "Overwrite existing helper file")
+    .option("--dry-run", "Print what would be created without executing")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (moduleName, name) => makeHelper(moduleName, name, rawArgs.slice(name ? 3 : 2)));
+  program
+    .command("module:make-middleware <module> [name]")
+    .description("Generate a module-local middleware file for an existing module")
+    .option("--force", "Overwrite existing middleware file")
+    .option("--dry-run", "Print what would be created without executing")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (moduleName, name) => makeLocalMiddleware(moduleName, name, rawArgs.slice(name ? 3 : 2)));
+  program
+    .command("module:make-provider <module> [name]")
+    .description("Generate a provider file in the module's providers folder")
+    .option("--force", "Overwrite existing provider file")
+    .option("--dry-run", "Print what would be created without executing")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (moduleName, name) => makeModuleProvider(moduleName, name, rawArgs.slice(name ? 3 : 2)));
+  program
+    .command("module:make-type <module> [name]")
+    .description("Generate a types file for an existing module")
+    .option("--force", "Overwrite existing types file")
+    .option("--dry-run", "Print what would be created without executing")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (moduleName, name) => makeType(moduleName, name, rawArgs.slice(name ? 3 : 2)));
+  program
+    .command("module:make-model <module> [name]")
+    .description("Generate a model file for an existing module")
+    .option("--force", "Overwrite existing model file")
+    .option("--dry-run", "Print what would be created without executing")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (moduleName, name) => makeModel(moduleName, name, rawArgs.slice(name ? 3 : 2)));
+  program
+    .command("module:make-seeder <module> [name]")
+    .description("Generate a seeder file for an existing module model")
+    .option("--force", "Overwrite existing seeder file")
+    .option("--dry-run", "Print what would be created without executing")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (moduleName, name) => makeSeeder(moduleName, name, rawArgs.slice(name ? 3 : 2)));
+  program
+    .command("module:make-job <module> [name]")
+    .description("Generate a job file for an existing module")
+    .option("--force", "Overwrite existing job file")
+    .option("--dry-run", "Print what would be created without executing")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (moduleName, name) => makeJob(moduleName, name, rawArgs.slice(name ? 3 : 2)));
+  program
+    .command("module:make-console <module> [name]")
+    .description("Generate a scheduler/console file for an existing module")
+    .option("--force", "Overwrite existing console file")
+    .option("--dry-run", "Print what would be created without executing")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (moduleName, name) => makeSchedule(moduleName, name, rawArgs.slice(name ? 3 : 2)));
+  program
+    .command("module:list")
+    .description("List all discovered modules")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async () => listModules());
+  program
+    .command("module:seed <module>")
+    .description("Run seeders for one module")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (moduleName) => {
+      const normalized = assertName(moduleName, "Module name");
+      await assertModuleHasSeeders(normalized);
+      await runSeed(normalized);
+    });
+  program
+    .command("module:migrate <module>")
+    .description("Generate and run a migration that includes the module")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (moduleName) => runModuleMigrate(moduleName, rawArgs));
+  program
+    .command("module:make-test <module> [name]")
+    .description("Generate a unit test file for a module")
+    .option("--force", "Overwrite existing test file")
+    .option("--dry-run", "Print what would be created without executing")
+    .option("--path <panel>", "Address a module inside a panel folder (e.g. --path=admin)")
+    .allowUnknownOption(true)
+    .action(async (moduleName, name) => makeTest(moduleName, name, rawArgs.slice(name ? 3 : 2)));
+}

package/fastify/src/framework/maker-cli/provider/core.mjs

@@ -0,0 +1,49 @@
+import fs from "node:fs/promises";
+import path from "node:path";
+import { hasFlag } from "../utils/flags.mjs";
+import { assertName, camelCase } from "../utils/naming.mjs";
+
+const stubsRoot = path.resolve(import.meta.dirname, "../stubs");
+
+/** Read a stub file and replace {{key}} placeholders, removing unfilled ones. */
+async function stub(name, values = {}) {
+  let content = await fs.readFile(path.join(stubsRoot, name), "utf8");
+  for (const [key, value] of Object.entries(values)) {
+    content = content.replaceAll(`{{${key}}}`, String(value));
+  }
+  return content.replace(/\{\{[A-Z0-9_]+\}\}/g, "");
+}
+
+/**
+ * Why: Generates the app-wide provider file.
+ * When: A developer wants to plug an implementation into the whole app.
+ * Where: src/providers/<name>.ts - imported automatically at boot.
+ * How: Writes the stub and prints how to reach the provider from anywhere.
+ */
+export async function makeProvider(rawName, flags = []) {
+  const name = assertName(rawName, "Provider name");
+  const camel = camelCase(name);
+  const dryRun = hasFlag(flags, "--dry-run");
+  const force = hasFlag(flags, "--force") || hasFlag(flags, "--yes");
+
+  const filePath = path.resolve(process.cwd(), "src/providers", `${name}.ts`);
+  if (dryRun) {
+    console.log(`Would create provider file: ${path.relative(process.cwd(), filePath)}`);
+    return;
+  }
+
+  let exists = false;
+  try {
+    await fs.access(filePath);
+    exists = true;
+  } catch {}
+  if (exists && !force) {
+    throw new Error(`Provider already exists: ${path.relative(process.cwd(), filePath)}. Re-run with --force to overwrite.`);
+  }
+
+  const content = await stub("provider/name.ts.stub", { name, camel });
+  await fs.mkdir(path.dirname(filePath), { recursive: true });
+  await fs.writeFile(filePath, content);
+  console.log(`Provider ready: ${path.relative(process.cwd(), filePath)}`);
+  console.log(`It is imported at boot. Reach it with: getProvider("${name}")`);
+}

package/fastify/src/framework/maker-cli/provider/index.mjs

@@ -0,0 +1,12 @@
+import { makeProvider } from "./core.mjs";
+
+/** Register provider:* subcommands on the CLI program. */
+export function registerProviderCommands(program, rawArgs) {
+  program
+    .command("provider:make <name>")
+    .description("Generate a provider file in src/providers")
+    .option("--force", "Overwrite existing provider file")
+    .option("--dry-run", "Print what would be created without executing")
+    .allowUnknownOption(true)
+    .action(async (name) => makeProvider(name, rawArgs.filter((arg) => arg.startsWith("--"))));
+}

package/fastify/src/framework/maker-cli/runtime/build-ui.mjs

@@ -0,0 +1,16 @@
+import { execSync } from "node:child_process";
+import { existsSync, mkdirSync, readFileSync } from "node:fs";
+import { resolve } from "node:path";
+
+const isFalse = (v) => v === "false" || v === "0";
+
+const envFile = resolve(process.cwd(), ".env");
+const fileDisabled = existsSync(envFile) && /^UI=(?:false|0)\s*$/m.test(readFileSync(envFile, "utf-8"));
+
+if (isFalse(process.env.UI) || fileDisabled) {
+  console.log("UI build skipped (UI=false)");
+  mkdirSync("public", { recursive: true });
+  process.exit(0);
+}
+
+execSync("vite build --config src/resources/vite.config.ts", { stdio: "inherit" });