@postxl/cli 1.4.4 → 1.5.0

package/dist/create-project.command.js

@@ -42,6 +42,7 @@ const node_util_1 = require("node:util");
 const schema_1 = require("@postxl/schema");
 const utils_1 = require("@postxl/utils");
 const create_project_generator_1 = require("./create-project/create-project.generator");
+const log_schema_error_1 = require("./helpers/log-schema-error");
 const execAsync = (0, node_util_1.promisify)(node_child_process_1.exec);
 async function run(command, options) {
     const { stdout, stderr } = await execAsync(command, options);
@@ -57,10 +58,25 @@ function register(program) {
         .command('create-project')
         .alias('new')
         .summary('Creates a new PostXL project.')
-        .description('Creates a new PostXL project with the simple schema template.')
+        .description(`Creates a new PostXL project.
+
+Installation flow:
+  1. Prompts for project name, slug, path, and schema (if not provided via options)
+  2. Writes initial project files (schema, generate.ts, tsconfig, package.json, .env)
+     Uses the simple schema for the first pass even if a custom schema is provided
+  3. Runs pnpm install to fetch initial dependencies
+  4. Runs first code generation without formatting (as prettier/eslint not yet installed)
+  5. Runs pnpm install again to fetch devDependencies added by the generated package.json
+  6. Swaps in the custom schema (if provided) before the final generation
+  7. Runs second code generation with full formatting (prettier, eslint)
+  8. Generates Prisma client
+  9. Initializes a git repository (unless --skip-git)
+
+If --skip-generate is used with a custom schema, the custom schema is written directly.`)
         .option('-n, --name <name>', 'Project name')
         .option('-s, --slug <slug>', 'Project slug')
         .option('-p, --project-path <path>', 'Path where the generated project should be written. If not specified, user will be prompted')
+        .option('-S, --schema <path>', 'Path to an existing postxl-schema.json to use instead of the default simple schema')
         .option('--skip-git', 'Skip initialing a git repository in the generated project directory')
         .option('--skip-generate', 'Skip running the initial project generation')
         .option('-l, --link-postxl', 'Link project to local PostXL monorepo packages (for development purposes)')
@@ -70,12 +86,16 @@ function register(program) {
             const link = options.linkPostxl === true;
             const name = await getProjectName(options.name);
             const slug = await getProjectSlug(options.slug, name);
-            const schema = getProjectSchema();
+            const customSchema = await loadCustomSchema(options.schema);
+            const schema = customSchema ?? getProjectSchema();
             const projectPath = await resolveProjectPath({ slug, projectPath: options.projectPath });
+            // For the first generator pass, use the simple schema (faster, result gets overwritten by second pass anyway).
+            // If --skip-generate is active, use the custom schema directly since there won't be a second pass.
+            const initialSchema = customSchema && !options.skipGenerate ? getProjectSchema() : schema;
             await createProjectStructure({
                 name,
                 slug,
-                schema,
+                schema: initialSchema,
                 projectPath,
             });
             // In case it is a workspace project, we install dependencies in the workspace part - else in the project
@@ -87,6 +107,10 @@ function register(program) {
                 // After the generation, we now have the full package.json including devDependencies for prettier, eslint, etc.
                 // So we install dependencies again to get those.
                 await installDependencies({ targetPath: projectPath, link });
+                // If a custom schema was provided, write it now before the second (final) generation pass.
+                if (customSchema) {
+                    await writeSchema({ name, slug, schema: customSchema, projectPath });
+                }
                 // The second generation runs with transformations - setting up prettier, eslint, etc.
                 await runGenerate({ projectPath, transform: true });
                 await generatePrismaClient(projectPath);
@@ -94,6 +118,11 @@ function register(program) {
                     await initializeGitRepository(projectPath);
                 }
             }
+            else if (customSchema) {
+                // With --skip-generate, createProjectStructure already wrote the custom schema,
+                // but we still need to apply name/slug/projectType overrides.
+                await writeSchema({ name, slug, schema: customSchema, projectPath });
+            }
             console.log(`\n✓ Project "${name}" created successfully at ${projectPath}`);
             console.log('\nNext steps:');
             console.log(`  cd ${path.relative(process.cwd(), projectPath)}`);
@@ -133,6 +162,48 @@ async function getProjectSlug(providedSlug, projectName) {
 function getProjectSchema() {
     return schema_1.sampleSchemas.simple;
 }
+async function loadCustomSchema(providedPath) {
+    if (!providedPath) {
+        return null;
+    }
+    const resolvedPath = path.resolve(providedPath);
+    let content;
+    try {
+        content = await fs.readFile(resolvedPath, 'utf-8');
+    }
+    catch (error) {
+        if (error instanceof Error && 'code' in error && error.code === 'ENOENT') {
+            console.error(`Schema file not found: ${resolvedPath}`);
+        }
+        else {
+            console.error(`Failed to read schema file: ${error instanceof Error ? error.message : error}`);
+        }
+        process.exit(1);
+    }
+    let json;
+    try {
+        json = JSON.parse(content);
+    }
+    catch {
+        console.error(`Schema file is not valid JSON: ${resolvedPath}`);
+        process.exit(1);
+    }
+    const result = schema_1.zProjectSchema.safeParse(json);
+    if (!result.success) {
+        (0, log_schema_error_1.logSchemaValidationError)(result.error);
+        process.exit(1);
+    }
+    return json;
+}
+async function writeSchema({ name, slug, schema, projectPath, }) {
+    const updatedSchema = {
+        ...schema,
+        name: (0, schema_1.toProjectSchemaName)(name),
+        slug: (0, schema_1.toProjectSlug)(slug),
+        projectType: 'standalone',
+    };
+    await fs.writeFile(path.join(projectPath, 'postxl-schema.json'), JSON.stringify(updatedSchema, null, 2) + '\n');
+}
 /**
  * If projectPath is not provided:
  *   - Prompt user for path if it should be standalone (in ../{slug}) or workspace (in ./projects/{slug}). Default is standalone.

package/dist/index.js

@@ -1,16 +1,22 @@
 #!/usr/bin/env node
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
+const node_path_1 = __importDefault(require("node:path"));
 const create_project_command_1 = require("./create-project.command");
 const generate_command_1 = require("./generate.command");
 const validate_command_1 = require("./validate.command");
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const { version } = require(node_path_1.default.join(__dirname, '..', 'package.json'));
 const program = new commander_1.Command();
 program
     //
     .name('pxl')
     .description('CLI for PostXL')
-    .version('1.4.4');
+    .version(version);
 // Adding all the commands
 (0, generate_command_1.register)(program);
 (0, create_project_command_1.register)(program);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@postxl/cli",
-  "version": "1.4.4",
+  "version": "1.5.0",
   "description": "Command-line interface for PostXL code generation framework",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -45,8 +45,8 @@
     "dotenv": "17.3.1",
     "zod-validation-error": "5.0.0",
     "@postxl/generator": "^1.3.7",
-    "@postxl/generators": "^1.21.0",
-    "@postxl/schema": "^1.8.0",
+    "@postxl/generators": "^1.23.0",
+    "@postxl/schema": "^1.8.2",
     "@postxl/utils": "^1.4.0"
   },
   "devDependencies": {},