pgpm 2.9.0 → 2.10.0

package/commands/init/index.js

@@ -7,6 +7,7 @@ exports.createInitUsageText = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const core_1 = require("@pgpmjs/core");
+const env_1 = require("@pgpmjs/env");
 const types_1 = require("@pgpmjs/types");
 const inquirerer_1 = require("inquirerer");
 const DEFAULT_MOTD = `
@@ -97,7 +98,7 @@ async function handleInit(argv, prompter) {
             cwd,
         });
     }
-    // Default to module init (for 'module' type or unknown types)
+    // Default to module init (for 'module' type, 'generic' type, or unknown types)
     return handleModuleInit(argv, prompter, {
         fromPath,
         templateRepo,
@@ -105,6 +106,7 @@ async function handleInit(argv, prompter) {
         dir,
         noTty,
         cwd,
+        requiresWorkspace: inspection.config?.requiresWorkspace,
     }, wasExplicitModuleRequest);
 }
 async function handleBoilerplateInit(argv, prompter, ctx) {
@@ -172,7 +174,7 @@ async function handleBoilerplateInit(argv, prompter, ctx) {
             cwd: ctx.cwd,
         });
     }
-    // Default to module init (for 'module' type or unknown types)
+    // Default to module init (for 'module' type, 'generic' type, or unknown types)
     // When using --boilerplate, user made an explicit choice, so treat as explicit request
     return handleModuleInit(argv, prompter, {
         fromPath,
@@ -181,6 +183,7 @@ async function handleBoilerplateInit(argv, prompter, ctx) {
         dir: ctx.dir,
         noTty: ctx.noTty,
         cwd: ctx.cwd,
+        requiresWorkspace: inspection.config?.requiresWorkspace,
     }, true);
 }
 async function handleWorkspaceInit(argv, prompter, ctx) {
@@ -233,49 +236,67 @@ async function handleWorkspaceInit(argv, prompter, ctx) {
     return { ...argv, ...answers, cwd: targetPath };
 }
 async function handleModuleInit(argv, prompter, ctx, wasExplicitModuleRequest = false) {
+    // Determine workspace requirement (defaults to 'pgpm' for backward compatibility)
+    const workspaceType = ctx.requiresWorkspace ?? 'pgpm';
+    // Whether this is a pgpm-managed template (creates pgpm.plan, .control files)
+    const isPgpmTemplate = workspaceType === 'pgpm';
     const project = new core_1.PgpmPackage(ctx.cwd);
-    if (!project.workspacePath) {
-        const noTty = Boolean(argv.noTty || argv['no-tty'] || process.env.CI === 'true');
-        // If user explicitly requested module init or we're in non-interactive mode,
-        // just show the error with helpful guidance
-        if (wasExplicitModuleRequest || noTty) {
-            process.stderr.write('Not inside a PGPM workspace.\n');
-            throw types_1.errors.NOT_IN_WORKSPACE({});
+    // Check workspace requirement based on type (skip if workspaceType is false)
+    if (workspaceType !== false) {
+        let workspacePath;
+        let workspaceTypeName = '';
+        if (workspaceType === 'pgpm') {
+            workspacePath = project.workspacePath;
+            workspaceTypeName = 'PGPM';
         }
-        // Offer to create a workspace instead
-        const recoveryQuestion = [
-            {
-                name: 'workspace',
-                alias: 'w',
-                message: 'You are not inside a PGPM workspace. Would you like to create a new workspace instead?',
-                type: 'confirm',
-                required: true,
-            },
-        ];
-        const { workspace } = await prompter.prompt(argv, recoveryQuestion);
-        if (workspace) {
-            return handleWorkspaceInit(argv, prompter, {
-                fromPath: 'workspace',
-                templateRepo: ctx.templateRepo,
-                branch: ctx.branch,
-                dir: ctx.dir,
-                noTty: ctx.noTty,
-                cwd: ctx.cwd,
-            });
+        else {
+            workspacePath = (0, env_1.resolveWorkspaceByType)(ctx.cwd, workspaceType);
+            workspaceTypeName = workspaceType.toUpperCase();
+        }
+        if (!workspacePath) {
+            const noTty = Boolean(argv.noTty || argv['no-tty'] || process.env.CI === 'true');
+            // If user explicitly requested module init or we're in non-interactive mode,
+            // just show the error with helpful guidance
+            if (wasExplicitModuleRequest || noTty) {
+                process.stderr.write(`Not inside a ${workspaceTypeName} workspace.\n`);
+                throw types_1.errors.NOT_IN_WORKSPACE({});
+            }
+            // Only offer to create a workspace for pgpm templates
+            if (workspaceType === 'pgpm') {
+                const recoveryQuestion = [
+                    {
+                        name: 'workspace',
+                        alias: 'w',
+                        message: `You are not inside a ${workspaceTypeName} workspace. Would you like to create a new workspace instead?`,
+                        type: 'confirm',
+                        required: true,
+                    },
+                ];
+                const { workspace } = await prompter.prompt(argv, recoveryQuestion);
+                if (workspace) {
+                    return handleWorkspaceInit(argv, prompter, {
+                        fromPath: 'workspace',
+                        templateRepo: ctx.templateRepo,
+                        branch: ctx.branch,
+                        dir: ctx.dir,
+                        noTty: ctx.noTty,
+                        cwd: ctx.cwd,
+                    });
+                }
+            }
+            // User declined or non-pgpm workspace type, show the error
+            process.stderr.write(`Not inside a ${workspaceTypeName} workspace.\n`);
+            throw types_1.errors.NOT_IN_WORKSPACE({});
         }
-        // User declined, show the error
-        process.stderr.write('Not inside a PGPM workspace.\n');
-        throw types_1.errors.NOT_IN_WORKSPACE({});
     }
-    if (!project.isInsideAllowedDirs(ctx.cwd) && !project.isInWorkspace() && !project.isParentOfAllowedDirs(ctx.cwd)) {
-        process.stderr.write('You must be inside the workspace root or a parent directory of modules (like packages/).\n');
-        throw types_1.errors.NOT_IN_WORKSPACE_MODULE({});
+    // Only check workspace directory constraints if we're in a workspace
+    if (project.workspacePath) {
+        if (!project.isInsideAllowedDirs(ctx.cwd) && !project.isInWorkspace() && !project.isParentOfAllowedDirs(ctx.cwd)) {
+            process.stderr.write('You must be inside the workspace root or a parent directory of modules (like packages/).\n');
+            throw types_1.errors.NOT_IN_WORKSPACE_MODULE({});
+        }
     }
-    const availExtensions = await project.getAvailableModules();
-    // Note: moduleName is needed here before scaffolding because initModule creates
-    // the directory first, then scaffolds. The boilerplate's ____moduleName____ question
-    // gets skipped because the answer is already passed through. So users only see it
-    // once, but the definition exists in two places for this architectural reason.
+    // Build questions based on whether this is a pgpm template
     const moduleQuestions = [
         {
             name: 'moduleName',
@@ -283,7 +304,11 @@ async function handleModuleInit(argv, prompter, ctx, wasExplicitModuleRequest =
             required: true,
             type: 'text',
         },
-        {
+    ];
+    // Only ask for extensions if this is a pgpm template
+    if (isPgpmTemplate && project.workspacePath) {
+        const availExtensions = await project.getAvailableModules();
+        moduleQuestions.push({
             name: 'extensions',
             message: 'Which extensions?',
             options: availExtensions,
@@ -291,36 +316,61 @@ async function handleModuleInit(argv, prompter, ctx, wasExplicitModuleRequest =
             allowCustomOptions: true,
             required: true,
             default: ['plpgsql', 'uuid-ossp'],
-        },
-    ];
+        });
+    }
     const answers = await prompter.prompt(argv, moduleQuestions);
     const modName = (0, core_1.sluggify)(answers.moduleName);
-    const extensions = answers.extensions
-        .filter((opt) => opt.selected)
-        .map((opt) => opt.name);
+    const extensions = isPgpmTemplate && answers.extensions
+        ? answers.extensions
+            .filter((opt) => opt.selected)
+            .map((opt) => opt.name)
+        : [];
     const templateAnswers = {
         ...argv,
         ...answers,
         moduleName: modName,
         packageIdentifier: argv.packageIdentifier || modName
     };
-    await project.initModule({
-        name: modName,
-        description: answers.description || modName,
-        author: answers.author || modName,
-        extensions,
-        templateRepo: ctx.templateRepo,
-        templatePath: ctx.fromPath,
-        branch: ctx.branch,
-        dir: ctx.dir,
-        toolName: core_1.DEFAULT_TEMPLATE_TOOL_NAME,
-        answers: templateAnswers,
-        noTty: ctx.noTty
-    });
-    const isRoot = path_1.default.resolve(project.getWorkspacePath()) === path_1.default.resolve(ctx.cwd);
-    const modulePath = isRoot
-        ? path_1.default.join(ctx.cwd, 'packages', modName)
-        : path_1.default.join(ctx.cwd, modName);
+    // Determine output path based on whether we're in a workspace
+    let modulePath;
+    if (project.workspacePath) {
+        // Use workspace-aware initModule
+        await project.initModule({
+            name: modName,
+            description: answers.description || modName,
+            author: answers.author || modName,
+            extensions,
+            templateRepo: ctx.templateRepo,
+            templatePath: ctx.fromPath,
+            branch: ctx.branch,
+            dir: ctx.dir,
+            toolName: core_1.DEFAULT_TEMPLATE_TOOL_NAME,
+            answers: templateAnswers,
+            noTty: ctx.noTty,
+            pgpm: isPgpmTemplate,
+        });
+        const isRoot = path_1.default.resolve(project.workspacePath) === path_1.default.resolve(ctx.cwd);
+        modulePath = isRoot
+            ? path_1.default.join(ctx.cwd, 'packages', modName)
+            : path_1.default.join(ctx.cwd, modName);
+    }
+    else {
+        // Not in a workspace - scaffold directly to current directory
+        modulePath = path_1.default.join(ctx.cwd, modName);
+        fs_1.default.mkdirSync(modulePath, { recursive: true });
+        await (0, core_1.scaffoldTemplate)({
+            fromPath: ctx.fromPath,
+            outputDir: modulePath,
+            templateRepo: ctx.templateRepo,
+            branch: ctx.branch,
+            dir: ctx.dir,
+            answers: templateAnswers,
+            noTty: ctx.noTty,
+            toolName: core_1.DEFAULT_TEMPLATE_TOOL_NAME,
+            cwd: ctx.cwd,
+            prompter
+        });
+    }
     const motdPath = path_1.default.join(modulePath, '.motd');
     let motd = DEFAULT_MOTD;
     if (fs_1.default.existsSync(motdPath)) {
@@ -336,7 +386,6 @@ async function handleModuleInit(argv, prompter, ctx, wasExplicitModuleRequest =
     if (!motd.endsWith('\n')) {
         process.stdout.write('\n');
     }
-    const relPath = isRoot ? `packages/${modName}` : modName;
-    process.stdout.write(`\n✨ Enjoy!\n\ncd ./${relPath}\n`);
+    process.stdout.write(`\n✨ Enjoy!\n\ncd ./${modName}\n`);
     return { ...argv, ...answers };
 }

package/esm/commands/init/index.js

@@ -1,6 +1,7 @@
 import fs from 'fs';
 import path from 'path';
 import { DEFAULT_TEMPLATE_REPO, DEFAULT_TEMPLATE_TOOL_NAME, inspectTemplate, PgpmPackage, resolveBoilerplateBaseDir, scaffoldTemplate, scanBoilerplates, sluggify, } from '@pgpmjs/core';
+import { resolveWorkspaceByType } from '@pgpmjs/env';
 import { errors } from '@pgpmjs/types';
 import { registerDefaultResolver } from 'inquirerer';
 const DEFAULT_MOTD = `
@@ -90,7 +91,7 @@ async function handleInit(argv, prompter) {
             cwd,
         });
     }
-    // Default to module init (for 'module' type or unknown types)
+    // Default to module init (for 'module' type, 'generic' type, or unknown types)
     return handleModuleInit(argv, prompter, {
         fromPath,
         templateRepo,
@@ -98,6 +99,7 @@ async function handleInit(argv, prompter) {
         dir,
         noTty,
         cwd,
+        requiresWorkspace: inspection.config?.requiresWorkspace,
     }, wasExplicitModuleRequest);
 }
 async function handleBoilerplateInit(argv, prompter, ctx) {
@@ -165,7 +167,7 @@ async function handleBoilerplateInit(argv, prompter, ctx) {
             cwd: ctx.cwd,
         });
     }
-    // Default to module init (for 'module' type or unknown types)
+    // Default to module init (for 'module' type, 'generic' type, or unknown types)
     // When using --boilerplate, user made an explicit choice, so treat as explicit request
     return handleModuleInit(argv, prompter, {
         fromPath,
@@ -174,6 +176,7 @@ async function handleBoilerplateInit(argv, prompter, ctx) {
         dir: ctx.dir,
         noTty: ctx.noTty,
         cwd: ctx.cwd,
+        requiresWorkspace: inspection.config?.requiresWorkspace,
     }, true);
 }
 async function handleWorkspaceInit(argv, prompter, ctx) {
@@ -226,49 +229,67 @@ async function handleWorkspaceInit(argv, prompter, ctx) {
     return { ...argv, ...answers, cwd: targetPath };
 }
 async function handleModuleInit(argv, prompter, ctx, wasExplicitModuleRequest = false) {
+    // Determine workspace requirement (defaults to 'pgpm' for backward compatibility)
+    const workspaceType = ctx.requiresWorkspace ?? 'pgpm';
+    // Whether this is a pgpm-managed template (creates pgpm.plan, .control files)
+    const isPgpmTemplate = workspaceType === 'pgpm';
     const project = new PgpmPackage(ctx.cwd);
-    if (!project.workspacePath) {
-        const noTty = Boolean(argv.noTty || argv['no-tty'] || process.env.CI === 'true');
-        // If user explicitly requested module init or we're in non-interactive mode,
-        // just show the error with helpful guidance
-        if (wasExplicitModuleRequest || noTty) {
-            process.stderr.write('Not inside a PGPM workspace.\n');
-            throw errors.NOT_IN_WORKSPACE({});
+    // Check workspace requirement based on type (skip if workspaceType is false)
+    if (workspaceType !== false) {
+        let workspacePath;
+        let workspaceTypeName = '';
+        if (workspaceType === 'pgpm') {
+            workspacePath = project.workspacePath;
+            workspaceTypeName = 'PGPM';
         }
-        // Offer to create a workspace instead
-        const recoveryQuestion = [
-            {
-                name: 'workspace',
-                alias: 'w',
-                message: 'You are not inside a PGPM workspace. Would you like to create a new workspace instead?',
-                type: 'confirm',
-                required: true,
-            },
-        ];
-        const { workspace } = await prompter.prompt(argv, recoveryQuestion);
-        if (workspace) {
-            return handleWorkspaceInit(argv, prompter, {
-                fromPath: 'workspace',
-                templateRepo: ctx.templateRepo,
-                branch: ctx.branch,
-                dir: ctx.dir,
-                noTty: ctx.noTty,
-                cwd: ctx.cwd,
-            });
+        else {
+            workspacePath = resolveWorkspaceByType(ctx.cwd, workspaceType);
+            workspaceTypeName = workspaceType.toUpperCase();
+        }
+        if (!workspacePath) {
+            const noTty = Boolean(argv.noTty || argv['no-tty'] || process.env.CI === 'true');
+            // If user explicitly requested module init or we're in non-interactive mode,
+            // just show the error with helpful guidance
+            if (wasExplicitModuleRequest || noTty) {
+                process.stderr.write(`Not inside a ${workspaceTypeName} workspace.\n`);
+                throw errors.NOT_IN_WORKSPACE({});
+            }
+            // Only offer to create a workspace for pgpm templates
+            if (workspaceType === 'pgpm') {
+                const recoveryQuestion = [
+                    {
+                        name: 'workspace',
+                        alias: 'w',
+                        message: `You are not inside a ${workspaceTypeName} workspace. Would you like to create a new workspace instead?`,
+                        type: 'confirm',
+                        required: true,
+                    },
+                ];
+                const { workspace } = await prompter.prompt(argv, recoveryQuestion);
+                if (workspace) {
+                    return handleWorkspaceInit(argv, prompter, {
+                        fromPath: 'workspace',
+                        templateRepo: ctx.templateRepo,
+                        branch: ctx.branch,
+                        dir: ctx.dir,
+                        noTty: ctx.noTty,
+                        cwd: ctx.cwd,
+                    });
+                }
+            }
+            // User declined or non-pgpm workspace type, show the error
+            process.stderr.write(`Not inside a ${workspaceTypeName} workspace.\n`);
+            throw errors.NOT_IN_WORKSPACE({});
         }
-        // User declined, show the error
-        process.stderr.write('Not inside a PGPM workspace.\n');
-        throw errors.NOT_IN_WORKSPACE({});
     }
-    if (!project.isInsideAllowedDirs(ctx.cwd) && !project.isInWorkspace() && !project.isParentOfAllowedDirs(ctx.cwd)) {
-        process.stderr.write('You must be inside the workspace root or a parent directory of modules (like packages/).\n');
-        throw errors.NOT_IN_WORKSPACE_MODULE({});
+    // Only check workspace directory constraints if we're in a workspace
+    if (project.workspacePath) {
+        if (!project.isInsideAllowedDirs(ctx.cwd) && !project.isInWorkspace() && !project.isParentOfAllowedDirs(ctx.cwd)) {
+            process.stderr.write('You must be inside the workspace root or a parent directory of modules (like packages/).\n');
+            throw errors.NOT_IN_WORKSPACE_MODULE({});
+        }
     }
-    const availExtensions = await project.getAvailableModules();
-    // Note: moduleName is needed here before scaffolding because initModule creates
-    // the directory first, then scaffolds. The boilerplate's ____moduleName____ question
-    // gets skipped because the answer is already passed through. So users only see it
-    // once, but the definition exists in two places for this architectural reason.
+    // Build questions based on whether this is a pgpm template
     const moduleQuestions = [
         {
             name: 'moduleName',
@@ -276,7 +297,11 @@ async function handleModuleInit(argv, prompter, ctx, wasExplicitModuleRequest =
             required: true,
             type: 'text',
         },
-        {
+    ];
+    // Only ask for extensions if this is a pgpm template
+    if (isPgpmTemplate && project.workspacePath) {
+        const availExtensions = await project.getAvailableModules();
+        moduleQuestions.push({
             name: 'extensions',
             message: 'Which extensions?',
             options: availExtensions,
@@ -284,36 +309,61 @@ async function handleModuleInit(argv, prompter, ctx, wasExplicitModuleRequest =
             allowCustomOptions: true,
             required: true,
             default: ['plpgsql', 'uuid-ossp'],
-        },
-    ];
+        });
+    }
     const answers = await prompter.prompt(argv, moduleQuestions);
     const modName = sluggify(answers.moduleName);
-    const extensions = answers.extensions
-        .filter((opt) => opt.selected)
-        .map((opt) => opt.name);
+    const extensions = isPgpmTemplate && answers.extensions
+        ? answers.extensions
+            .filter((opt) => opt.selected)
+            .map((opt) => opt.name)
+        : [];
     const templateAnswers = {
         ...argv,
         ...answers,
         moduleName: modName,
         packageIdentifier: argv.packageIdentifier || modName
     };
-    await project.initModule({
-        name: modName,
-        description: answers.description || modName,
-        author: answers.author || modName,
-        extensions,
-        templateRepo: ctx.templateRepo,
-        templatePath: ctx.fromPath,
-        branch: ctx.branch,
-        dir: ctx.dir,
-        toolName: DEFAULT_TEMPLATE_TOOL_NAME,
-        answers: templateAnswers,
-        noTty: ctx.noTty
-    });
-    const isRoot = path.resolve(project.getWorkspacePath()) === path.resolve(ctx.cwd);
-    const modulePath = isRoot
-        ? path.join(ctx.cwd, 'packages', modName)
-        : path.join(ctx.cwd, modName);
+    // Determine output path based on whether we're in a workspace
+    let modulePath;
+    if (project.workspacePath) {
+        // Use workspace-aware initModule
+        await project.initModule({
+            name: modName,
+            description: answers.description || modName,
+            author: answers.author || modName,
+            extensions,
+            templateRepo: ctx.templateRepo,
+            templatePath: ctx.fromPath,
+            branch: ctx.branch,
+            dir: ctx.dir,
+            toolName: DEFAULT_TEMPLATE_TOOL_NAME,
+            answers: templateAnswers,
+            noTty: ctx.noTty,
+            pgpm: isPgpmTemplate,
+        });
+        const isRoot = path.resolve(project.workspacePath) === path.resolve(ctx.cwd);
+        modulePath = isRoot
+            ? path.join(ctx.cwd, 'packages', modName)
+            : path.join(ctx.cwd, modName);
+    }
+    else {
+        // Not in a workspace - scaffold directly to current directory
+        modulePath = path.join(ctx.cwd, modName);
+        fs.mkdirSync(modulePath, { recursive: true });
+        await scaffoldTemplate({
+            fromPath: ctx.fromPath,
+            outputDir: modulePath,
+            templateRepo: ctx.templateRepo,
+            branch: ctx.branch,
+            dir: ctx.dir,
+            answers: templateAnswers,
+            noTty: ctx.noTty,
+            toolName: DEFAULT_TEMPLATE_TOOL_NAME,
+            cwd: ctx.cwd,
+            prompter
+        });
+    }
     const motdPath = path.join(modulePath, '.motd');
     let motd = DEFAULT_MOTD;
     if (fs.existsSync(motdPath)) {
@@ -329,7 +379,6 @@ async function handleModuleInit(argv, prompter, ctx, wasExplicitModuleRequest =
     if (!motd.endsWith('\n')) {
         process.stdout.write('\n');
     }
-    const relPath = isRoot ? `packages/${modName}` : modName;
-    process.stdout.write(`\n✨ Enjoy!\n\ncd ./${relPath}\n`);
+    process.stdout.write(`\n✨ Enjoy!\n\ncd ./${modName}\n`);
     return { ...argv, ...answers };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pgpm",
-  "version": "2.9.0",
+  "version": "2.10.0",
   "author": "Constructive <developers@constructive.io>",
   "description": "PostgreSQL Package Manager - Database migration and package management CLI",
   "main": "index.js",
@@ -47,8 +47,8 @@
   },
   "dependencies": {
     "@inquirerer/utils": "^3.1.2",
-    "@pgpmjs/core": "^4.9.0",
-    "@pgpmjs/env": "^2.9.2",
+    "@pgpmjs/core": "^4.10.0",
+    "@pgpmjs/env": "^2.9.3",
     "@pgpmjs/logger": "^1.3.7",
     "@pgpmjs/types": "^2.14.0",
     "appstash": "^0.2.7",
@@ -75,5 +75,5 @@
     "pg",
     "pgsql"
   ],
-  "gitHead": "e6171117d5498f38f456dfaf7e8a497dd7d2a30b"
+  "gitHead": "ba5bbacf7ccc1980cba10bf3f45ebb0ca639fb79"
 }