@nakedev/go-scaffold 0.4.0 → 0.4.3

package/dist/commands/config.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configureProject = configureProject;
+exports.showProjectConfig = showProjectConfig;
+exports.validateProjectConfig = validateProjectConfig;
+const picocolors_1 = __importDefault(require("picocolors"));
+const generate_wizard_1 = require("../prompts/generate-wizard");
+const interactive_1 = require("../prompts/interactive");
+const config_1 = require("../utils/config");
+const module_profile_1 = require("../utils/module-profile");
+/**
+ * Interactive project-level defaults. Existing modules are not rewritten: the
+ * wizard only controls what a future `generate module` receives when the user
+ * chooses `--defaults` or accepts the generated-module prompt defaults.
+ */
+async function configureProject(projectDir = process.cwd()) {
+    const config = (0, config_1.readConfig)(projectDir);
+    console.log("\nConfigure future generated modules:\n");
+    const profile = await (0, generate_wizard_1.promptModuleProfile)((0, module_profile_1.moduleProfileFor)(config.architecture.defaultModuleSurface, config.architecture.defaultApplicationStyle));
+    const { moduleSurface: defaultModuleSurface, applicationStyle: defaultApplicationStyle } = profile === "advanced"
+        ? await (0, generate_wizard_1.promptAdvancedModuleArchitecture)(config.architecture.defaultModuleSurface, config.architecture.defaultApplicationStyle)
+        : (0, generate_wizard_1.moduleArchitectureForProfile)(profile);
+    console.log("\nSummary:");
+    console.log(`  Default module profile: ${(0, generate_wizard_1.moduleProfileDescription)(defaultModuleSurface, defaultApplicationStyle)}`);
+    console.log(`  Default module surface: ${defaultModuleSurface}`);
+    console.log(`  Default application style: ${defaultApplicationStyle}`);
+    console.log("  Existing modules: unchanged");
+    const proceed = await (0, interactive_1.confirm)({ message: "Save these project defaults?", default: true });
+    if (!proceed)
+        throw new Error("configuration cancelled");
+    (0, config_1.writeConfig)(projectDir, {
+        ...config,
+        architecture: {
+            ...config.architecture,
+            defaultModuleSurface,
+            defaultApplicationStyle,
+        },
+    });
+    console.log(picocolors_1.default.green("\nupdated go-scaffold.config.json"));
+}
+function showProjectConfig(projectDir = process.cwd()) {
+    console.log(JSON.stringify((0, config_1.readConfig)(projectDir), null, 2));
+}
+function validateProjectConfig(projectDir = process.cwd()) {
+    const config = (0, config_1.readConfig)(projectDir);
+    console.log(picocolors_1.default.green(`valid go-scaffold.config.json (schema ${config.schemaVersion})`));
+}

package/dist/commands/create.js

@@ -13,7 +13,9 @@ const config_1 = require("../utils/config");
 const naming_1 = require("../utils/naming");
 const create_wizard_1 = require("../prompts/create-wizard");
 const version_1 = require("../utils/version");
+const types_1 = require("../types");
 const observability_1 = require("./observability");
+const module_profile_1 = require("../utils/module-profile");
 async function createProject(rawName, opts) {
     const trimmed = (rawName ?? (await (0, create_wizard_1.promptProjectName)())).trim();
     if (!trimmed)
@@ -27,6 +29,13 @@ async function createProject(rawName, opts) {
     }
     let features;
     let apiPrefix;
+    let architecture;
+    const moduleProfile = (0, config_1.parseModuleProfile)(opts.moduleProfile, "--module-profile");
+    const moduleSurface = (0, config_1.parseModuleSurface)(opts.moduleSurface);
+    const applicationStyle = (0, config_1.parseApplicationStyle)(opts.applicationStyle);
+    if (moduleProfile && (moduleSurface || applicationStyle)) {
+        throw new Error("--module-profile cannot be combined with --module-surface or --application-style — choose one configuration style");
+    }
     if (opts.defaults) {
         features = { docker: opts.docker ?? true, openapiDocs: opts.openapiDocs ?? true, observability: opts.observability ?? false };
         // "" to match what the wizard's Enter now gives. --defaults means "don't
@@ -37,16 +46,27 @@ async function createProject(rawName, opts) {
         const check = (0, naming_1.validateApiPrefix)(apiPrefix);
         if (check !== true)
             throw new Error(check);
+        const profileArchitecture = moduleProfile ? (0, module_profile_1.architectureForModuleProfile)(moduleProfile) : undefined;
+        architecture = {
+            ...types_1.DEFAULT_ARCHITECTURE_CONFIG,
+            ...(profileArchitecture ? { defaultModuleSurface: profileArchitecture.moduleSurface } : {}),
+            ...(profileArchitecture ? { defaultApplicationStyle: profileArchitecture.applicationStyle } : {}),
+            ...(!profileArchitecture && moduleSurface ? { defaultModuleSurface: moduleSurface } : {}),
+            ...(!profileArchitecture && applicationStyle ? { defaultApplicationStyle: applicationStyle } : {}),
+        };
     }
     else {
         // commander gives `--no-x` options a default of true, and there is no
         // `--docker`/`--openapi-docs` to pass, so false here can only mean the
         // caller opted out explicitly. undefined leaves the question to the wizard.
-        ({ features, apiPrefix } = await (0, create_wizard_1.runCreateWizard)({
+        ({ features, apiPrefix, architecture } = await (0, create_wizard_1.runCreateWizard)({
             docker: opts.docker === false ? false : undefined,
             openapiDocs: opts.openapiDocs === false ? false : undefined,
             observability: opts.observability === true ? true : undefined,
             apiPrefix: opts.apiPrefix,
+            moduleProfile,
+            moduleSurface,
+            applicationStyle,
         }));
     }
     const context = {
@@ -54,12 +74,22 @@ async function createProject(rawName, opts) {
         goModule,
         dbName: (0, naming_1.toDbName)(projectName),
         apiPrefix,
+        ...architecture,
         ...features,
     };
     await fs_extra_1.default.ensureDir(projectDir);
     await (0, template_renderer_1.applyTemplateEntries)(projectDir, create_manifest_1.CREATE_MANIFEST, context);
     (0, template_renderer_1.gofmtTree)(projectDir);
-    (0, config_1.writeConfig)(projectDir, { projectName, goModule, apiPrefix, features, scaffoldVersion: (0, version_1.cliVersion)() });
+    (0, config_1.writeConfig)(projectDir, {
+        schemaVersion: 1,
+        projectName,
+        goModule,
+        apiPrefix,
+        features,
+        architecture,
+        modules: {},
+        scaffoldVersion: (0, version_1.cliVersion)(),
+    });
     // Composed the same way a user would do it by hand — `create` always
     // renders the plain base, then this layers the same patches `add
     // observability` would apply on an existing project, so the two paths

package/dist/commands/generate.js

@@ -59,8 +59,17 @@ async function generateModule(rawName, opts, projectDir = process.cwd()) {
         modulePath,
         auth: opts.auth,
         permission: opts.permission,
+        cqrs: opts.cqrs,
+        moduleSurface: opts.full ? "crud" : "minimal",
+        applicationStyle: opts.cqrs ? "cqrs" : "service",
     };
-    const moduleFiles = opts.full ? module_manifest_1.MODULE_FILES : module_manifest_1.MODULE_FILES_MINIMAL;
+    const moduleFiles = opts.cqrs
+        ? opts.full
+            ? module_manifest_1.MODULE_FILES_CQRS
+            : module_manifest_1.MODULE_FILES_MINIMAL_CQRS
+        : opts.full
+            ? module_manifest_1.MODULE_FILES
+            : module_manifest_1.MODULE_FILES_MINIMAL;
     const moduleEntries = moduleFiles.map((f) => ({
         template: f.template,
         output: path_1.default.join("internal", "app", modulePath, f.output),
@@ -132,8 +141,22 @@ async function generateModule(rawName, opts, projectDir = process.cwd()) {
     }
     (0, template_renderer_1.gofmtTree)(projectDir);
     (0, gocheck_1.assertNoDrift)(projectDir, checkBefore, config);
+    (0, config_1.writeConfig)(projectDir, {
+        ...config,
+        modules: {
+            ...config.modules,
+            [modulePath]: {
+                surface: opts.full ? "crud" : "minimal",
+                applicationStyle: opts.cqrs ? "cqrs" : "service",
+            },
+        },
+    });
     const routePath = config.apiPrefix ? `/${config.apiPrefix}/${naming.plural}` : `/${naming.plural}`;
     console.log(picocolors_1.default.green(`\ngenerated internal/app/${modulePath}/`));
+    if (opts.cqrs) {
+        console.log("application boundary: CQRS command/query handlers in commands.go and queries.go");
+    }
+    console.log(`recorded module defaults: ${opts.full ? "crud" : "minimal"} + ${opts.cqrs ? "cqrs" : "service"}`);
     if (opts.full) {
         console.log(`registered route ${routePath} in cmd/api/wiring.go`);
     }
@@ -162,5 +185,5 @@ async function generateModule(rawName, opts, projectDir = process.cwd()) {
     if (docsMessage)
         console.log(docsMessage);
     console.log(picocolors_1.default.dim(`\nnext: add real fields to model.go/dto.go, run \`go build ./...\`, then apply the migration ` +
-        `(AUTO_MIGRATE=true handles it in dev, or \`migrate -path migrations -database "$DB_DSN" up\`)`));
+        `(use the development bootstrap locally, or \`migrate -path migrations -database "$DB_DSN" up\` before production)`));
 }

package/dist/commands/method.js

@@ -51,13 +51,13 @@ function methodOpenapiDocument(naming, method, type, getMode, field) {
     if (type === "post") {
         operation.push("  requestBody:", "    required: true", "    content:", "      application/json:", "        schema:", "          type: object", "          description: TODO define request fields");
     }
-    const status = type === "delete" ? "204" : type === "post" ? "201" : "200";
-    operation.push("  responses:", `    \"${status}\":`, `      description: ${type === "delete" ? "completed or already absent" : "TODO define response"}`);
-    if (type !== "delete") {
+    const status = type === "delete" ? "204" : type === "post" ? "201" : type === "put" || type === "patch" ? "501" : "200";
+    operation.push("  responses:", `    \"${status}\":`, `      description: ${type === "delete" ? "completed or already absent" : type === "put" || type === "patch" ? "not implemented" : "TODO define response"}`);
+    if (type !== "delete" && type !== "put" && type !== "patch") {
         operation.push("      content:", "        application/json:", "          schema:", "            type: object", "            description: TODO replace with the method response schema");
     }
     operation.push("    \"400\": { $ref: '../../common/responses.yaml#/ValidationError' }");
-    if (type === "get" || type === "put" || type === "patch") {
+    if (type === "get") {
         operation.push("    \"404\": { $ref: '../../common/responses.yaml#/NotFoundError' }");
     }
     return [...pathParameters, ...operation, ""].join("\n");
@@ -70,16 +70,30 @@ async function generateMethod(moduleNameArg, methodNameArg, opts, projectDir = p
     const paths = {
         dtoPath: path_1.default.join(moduleDir, "dto.go"),
         repositoryPath: path_1.default.join(moduleDir, "repository.go"),
+        commandPath: path_1.default.join(moduleDir, "commands.go"),
+        queryPath: path_1.default.join(moduleDir, "queries.go"),
         servicePath: path_1.default.join(moduleDir, "service.go"),
         handlerPath: path_1.default.join(moduleDir, "handler.go"),
         serviceTestPath: path_1.default.join(moduleDir, "service_test.go"),
     };
-    for (const p of Object.values(paths)) {
+    const requiredPaths = [
+        paths.dtoPath,
+        paths.repositoryPath,
+        paths.servicePath,
+        paths.handlerPath,
+        paths.serviceTestPath,
+    ];
+    for (const p of requiredPaths) {
         if (!fs_extra_1.default.existsSync(p)) {
             throw new Error(`module "${naming.pkg}" not found at ${moduleDir} (missing ${path_1.default.basename(p)}) — ` +
                 `run \`go-scaffold generate module ${naming.pkg}\` first`);
         }
     }
+    const cqrsPaths = [paths.commandPath, paths.queryPath].filter((candidate) => candidate !== undefined && fs_extra_1.default.existsSync(candidate));
+    if (cqrsPaths.length === 1) {
+        throw new Error(`module "${naming.pkg}" has an incomplete CQRS boundary at ${moduleDir} — ` +
+            `commands.go and queries.go must be present together`);
+    }
     const type = opts.type ?? (await (0, generate_wizard_1.promptMethodType)());
     if (opts.getMode && type !== "get") {
         throw new Error("--get-mode can only be used with --type get");
@@ -98,7 +112,7 @@ async function generateMethod(moduleNameArg, methodNameArg, opts, projectDir = p
     // patchMethod writes dto.go, then handler.go, then reads service.go, so a
     // missing service marker used to leave two files patched and the method
     // permanently un-retryable (assertNotDuplicate then sees it as existing).
-    if (!(0, method_patcher_1.markersPresent)(paths.handlerPath, paths.servicePath)) {
+    if (!(0, method_patcher_1.markersPresentForPaths)(paths)) {
         throw new Error(`internal/app/${naming.pkg} is missing the marker comments \`generate method\` patches at.\n` +
             `handler.go and service.go must both still carry their \`// go-scaffold:*\` markers —\n` +
             `restore them, or add this method by hand.`);
@@ -151,5 +165,6 @@ async function generateMethod(moduleNameArg, methodNameArg, opts, projectDir = p
     if (docsRelativePath) {
         console.log(picocolors_1.default.green(`docs: docs/${docsRelativePath} (wired into docs/openapi.yaml)`));
     }
-    console.log(picocolors_1.default.dim(`\nnext: fill in the TODO in service.go, then \`go build ./...\` / \`go test ./...\``));
+    const implementationFile = cqrsPaths.length === 2 ? (type === "get" ? "queries.go" : "commands.go") : "service.go";
+    console.log(picocolors_1.default.dim(`\nnext: fill in the TODO in ${implementationFile}, then \`go build ./...\` / \`go test ./...\``));
 }

package/dist/commands/migration.js

@@ -29,6 +29,6 @@ async function generateMigration(rawName, projectDir = process.cwd()) {
     fs_extra_1.default.writeFileSync(upPath, `-- TODO: write the up migration for ${name}\n`);
     fs_extra_1.default.writeFileSync(downPath, `-- TODO: write the down migration for ${name} (reverses the up migration)\n`);
     console.log(picocolors_1.default.green(`\ngenerated migrations/${version}_${name}.{up,down}.sql`));
-    console.log(picocolors_1.default.dim(`\nnext: write the SQL, then \`make migrate-up\` (dev) or apply it as a deploy step ` +
-        `(AUTO_MIGRATE=true also picks up model changes automatically in dev — this file matters most for prod)`));
+    console.log(picocolors_1.default.dim(`\nnext: write the SQL, then apply it with \`make migrate-up\` before production ` +
+        `(APP_ENV=development only enables the convenience bootstrap)`));
 }

package/dist/commands/observability.js

@@ -95,9 +95,9 @@ function refreshArchitectDocs(projectDir, config) {
         { template: "create/features/docs/architecture.md.hbs", output: path_1.default.join("docs", "architect", "architecture.md") },
         { template: "create/features/docs/techstack.md.hbs", output: path_1.default.join("docs", "architect", "techstack.md") },
     ];
-    // only what the two templates actually reference — projectName, apiPrefix
-    // and the feature flags
-    const base = { projectName: config.projectName, apiPrefix: config.apiPrefix, ...config.features };
+    // only what the two templates actually reference — projectName, apiPrefix,
+    // architecture defaults and the feature flags
+    const base = { projectName: config.projectName, apiPrefix: config.apiPrefix, ...config.architecture, ...config.features };
     const root = (0, template_renderer_1.getTemplatesRoot)();
     const skipped = [];
     for (const doc of docs) {

package/dist/commands/rbac.js

@@ -61,7 +61,7 @@ async function addRbac(projectDir = process.cwd()) {
     (0, rbac_patcher_1.patchUserModelForRbac)(path_1.default.join(projectDir, "internal", "app", "user", "model", "user.go"));
     (0, rbac_patcher_1.patchMiddlewareAuthForRbac)(path_1.default.join(projectDir, "internal", "shared", "middleware", "auth.go"));
     (0, rbac_patcher_1.patchUserJWTForRbac)(path_1.default.join(projectDir, "internal", "app", "user", "jwt.go"));
-    (0, rbac_patcher_1.patchUserServiceForRbac)(path_1.default.join(projectDir, "internal", "app", "user", "service.go"));
+    (0, rbac_patcher_1.patchUserServiceForRbac)(path_1.default.join(projectDir, "internal", "app", "user", "service.go"), config.goModule, path_1.default.join(projectDir, "internal", "app", "user", "sessions.go"));
     (0, rbac_patcher_1.patchUserServiceTestForRbac)(path_1.default.join(projectDir, "internal", "app", "user", "service_test.go"));
     (0, rbac_patcher_1.patchUserDTOForRbac)(path_1.default.join(projectDir, "internal", "app", "user", "dto.go"));
     (0, rbac_patcher_1.patchUserHandlerForRbac)(path_1.default.join(projectDir, "internal", "app", "user", "handler.go"), config.goModule);
@@ -97,9 +97,9 @@ async function addRbac(projectDir = process.cwd()) {
     (0, config_1.writeConfig)(projectDir, { ...config, features: { ...config.features, rbac: true } });
     console.log(picocolors_1.default.green("\nadded internal/app/role/ and internal/shared/middleware/authz.go"));
     console.log("registered GET /users, GET /users/:id, PATCH /users/:id/set-role, /roles, and /permissions in cmd/api/wiring.go" + docsMessage);
-    console.log(picocolors_1.default.yellow("\n⚠ AUTO_MIGRATE=true does NOT seed the role/permission data — it only creates the\n" +
+    console.log(picocolors_1.default.yellow("\n⚠ The development table bootstrap does NOT seed role/permission data — it only creates the\n" +
         "  tables from the Go structs. The \"staff\"/\"admin\" roles and their permissions live\n" +
-        "  in the migration's SQL (INSERT statements), which AutoMigrate never runs. Without\n" +
+        "  in the migration's SQL (INSERT statements), which table creation never runs. Without\n" +
         "  applying it for real, `make seed` fails with \"unknown role code\" and nobody can be\n" +
         "  granted anything. Apply it before relying on RBAC, even in dev:\n" +
         "    migrate -path migrations -database \"$DB_DSN\" up   (or: make migrate-up)"));

package/dist/commands/undo.js

@@ -123,6 +123,11 @@ async function undoModule(rawName, opts, projectDir = process.cwd()) {
         didWhat: `undid module "${naming.pkg}"`,
         recover: `internal/app/${modulePath}/ is gone; re-run \`go-scaffold generate module ${naming.pkg}\` to put it\nback, then reconcile cmd/api/wiring.go by hand.`,
     });
+    if (config.modules[modulePath]) {
+        const modules = { ...config.modules };
+        delete modules[modulePath];
+        (0, config_1.writeConfig)(projectDir, { ...config, modules });
+    }
     console.log(picocolors_1.default.green(`\nundid module "${naming.pkg}"`));
     console.log(`  deleted internal/app/${modulePath}/`);
     console.log(`  un-wired cmd/api/wiring.go`);

package/dist/commands/worker.js

@@ -41,7 +41,7 @@ async function addWorker(backend, projectDir = process.cwd()) {
         : ["github.com/hibiken/asynq v0.26.0", "github.com/redis/go-redis/v9 v9.22.0"]);
     // auth added before the worker wired a synchronous mailer — now that there
     // is a queue, move it onto it
-    const mailerUpgraded = (0, auth_patcher_1.upgradeMailerToQueue)(path_1.default.join(projectDir, "cmd", "api", "wiring.go"), config.goModule, backend);
+    const mailerUpgraded = (0, auth_patcher_1.upgradeMailerToQueue)(path_1.default.join(projectDir, "cmd", "api", "wiring.go"), config.goModule, backend, path_1.default.join(projectDir, "internal", "app", "user", "composition.go"));
     patchEnvExample(path_1.default.join(projectDir, ".env.example"), { redis: !riverQueue });
     patchMakefile(path_1.default.join(projectDir, "Makefile"), { river: riverQueue });
     (0, template_renderer_1.gofmtTree)(projectDir);