@baseplate-dev/create-project 0.4.2 → 0.4.4

package/dist/project-creator.js

@@ -1,68 +1,36 @@
 import chalk from 'chalk';
-import fs from 'node:fs/promises';
 import path from 'node:path';
 import ora from 'ora';
-import { exec } from './exec.js';
+import { generateRootPackage } from './project-generator.js';
+/**
+ * Shows a success message with instructions for getting started.
+ */
+function showSuccessMessage(directory) {
+    const relativePath = path.relative(process.cwd(), directory);
+    console.info('');
+    console.info(`
+🎉 Congratulations! Your Baseplate project has been created. To get started, run the following command${relativePath === '' ? '' : 's'}:
+${relativePath === '' ? '' : chalk.bold(`\ncd ${relativePath}`)}
+${chalk.bold('pnpm baseplate serve')}
+
+For more information, read the included README.md file.
+`.trim());
+}
 export async function generateBaseplateProject({ packageName, directory, cliVersion, }) {
     const spinner = ora({
         text: 'Creating project files...',
     }).start();
     try {
-        await fs.mkdir(directory, {
-            recursive: true,
-        });
-        const writeFile = async (destination, content) => {
-            const destinationPath = path.join(directory, destination);
-            await fs.mkdir(path.dirname(destinationPath), {
-                recursive: true,
-            });
-            await fs.writeFile(destinationPath, content);
-        };
-        const copyFile = async (templateSrc, destination) => {
-            // template files are stored at ../templates
-            const source = new URL(`../templates/${templateSrc}`, import.meta.url);
-            const sourceFile = await fs.readFile(source);
-            await writeFile(destination, sourceFile);
-        };
-        // write package.json
-        await writeFile('package.json', JSON.stringify({
+        // Generate root package files using sync engine
+        // This includes package.json, turbo.json, pnpm-workspace.yaml, .gitignore, etc.
+        // It also runs pnpm install as a post-write command
+        await generateRootPackage({
             name: packageName,
-            version: '0.1.0',
-            private: true,
-            description: 'A Baseplate project',
-            license: 'UNLICENSED',
-            author: '<AUTHOR>',
-            scripts: {
-                'baseplate:serve': 'baseplate serve',
-                'baseplate:generate': 'baseplate generate',
-                preinstall: 'npx only-allow pnpm',
-            },
-            devDependencies: {
-                '@baseplate-dev/project-builder-cli': cliVersion,
-            },
-            packageManager: 'pnpm@10.18.3',
-            engines: {
-                node: '^22.0.0',
-                pnpm: '^10.18.3',
-            },
-            volta: {
-                node: '22.18.0',
-            },
-        }, null, 2));
-        await copyFile('.gitignore', '.gitignore');
-        await copyFile('.template.npmrc', '.npmrc');
-        await copyFile('README.md', 'README.md');
+            cliVersion,
+            directory,
+        });
         spinner.succeed();
-        await exec('pnpm install', directory);
-        const relativePath = path.relative(process.cwd(), directory);
-        console.info('');
-        console.info(`
-🎉 Congratulations! Your Baseplate project has been created. To get started, run the following command${relativePath === '' ? '' : 's'}:
-${relativePath === '' ? '' : chalk.bold(`\ncd ${relativePath}`)}
-${chalk.bold('pnpm baseplate serve')}
-
-For more information, read the included README.md file.
-`.trim());
+        showSuccessMessage(directory);
     }
     finally {
         if (spinner.isSpinning) {

package/dist/project-generator.d.ts

@@ -0,0 +1,35 @@
+import type { ProjectDefinition } from '@baseplate-dev/project-builder-lib';
+/**
+ * Configuration for generating an initial project.
+ */
+interface InitialProjectConfig {
+    /**
+     * The name of the project (used in package.json and project definition).
+     */
+    name: string;
+    /**
+     * The CLI version to use for the project.
+     */
+    cliVersion: string;
+    /**
+     * The absolute path to the project directory.
+     */
+    directory: string;
+}
+/**
+ * Creates a placeholder project definition with isInitialized: false.
+ * This definition can be used to bootstrap a new Baseplate project.
+ *
+ * @param config - Configuration for the initial project
+ * @returns A ProjectDefinition with isInitialized: false
+ */
+export declare function createInitialProjectDefinition(config: InitialProjectConfig): ProjectDefinition;
+/**
+ * Generates the root package files using the Baseplate sync engine.
+ * This creates all standard root-level files (package.json, turbo.json, etc.)
+ * and writes the project definition to baseplate/project-definition.json.
+ *
+ * @param config - Configuration for the initial project
+ */
+export declare function generateRootPackage(config: InitialProjectConfig): Promise<void>;
+export {};

package/dist/project-generator.js

@@ -0,0 +1,73 @@
+import { getLatestMigrationVersion } from '@baseplate-dev/project-builder-lib';
+import { generateProjectId, SyncMetadataController, syncProject, } from '@baseplate-dev/project-builder-server';
+import { createConsoleLogger } from '@baseplate-dev/sync';
+import { stringifyPrettyStable } from '@baseplate-dev/utils';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+/**
+ * Creates a placeholder project definition with isInitialized: false.
+ * This definition can be used to bootstrap a new Baseplate project.
+ *
+ * @param config - Configuration for the initial project
+ * @returns A ProjectDefinition with isInitialized: false
+ */
+export function createInitialProjectDefinition(config) {
+    return {
+        settings: {
+            general: {
+                name: config.name,
+                packageScope: '',
+                portOffset: 3000,
+            },
+        },
+        features: [],
+        cliVersion: config.cliVersion,
+        apps: [],
+        models: [],
+        isInitialized: false,
+        schemaVersion: getLatestMigrationVersion(),
+    };
+}
+/**
+ * Generates the root package files using the Baseplate sync engine.
+ * This creates all standard root-level files (package.json, turbo.json, etc.)
+ * and writes the project definition to baseplate/project-definition.json.
+ *
+ * @param config - Configuration for the initial project
+ */
+export async function generateRootPackage(config) {
+    const definition = createInitialProjectDefinition(config);
+    const logger = createConsoleLogger('error');
+    // Create project directory and write project definition first
+    // This is needed because syncProject expects the definition to exist on disk
+    const baseplateDir = path.join(config.directory, 'baseplate');
+    await fs.mkdir(baseplateDir, { recursive: true });
+    await fs.writeFile(path.join(baseplateDir, 'project-definition.json'), stringifyPrettyStable(definition));
+    // Create minimal plugin store (no plugins for initial project)
+    const pluginStore = { availablePlugins: [] };
+    // Create parser context
+    const context = {
+        pluginStore,
+        cliVersion: config.cliVersion,
+        project: {
+            id: generateProjectId(config.directory),
+            name: config.name,
+            directory: config.directory,
+            isInternalExample: false,
+        },
+    };
+    // Create sync metadata controller to set up .baseplate directory
+    const syncMetadataController = new SyncMetadataController(config.directory, logger);
+    // Use syncProject to generate all files and set up metadata
+    const result = await syncProject({
+        directory: config.directory,
+        logger,
+        context,
+        userConfig: {},
+        syncMetadataController,
+        overwrite: true,
+    });
+    if (result.status === 'error') {
+        throw new Error('Failed to generate project files');
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baseplate-dev/create-project",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "description": "CLI starter kit for creating a new Baseplate project",
   "keywords": [
     "cli",
@@ -37,10 +37,12 @@
   "dependencies": {
     "chalk": "5.3.0",
     "commander": "^12.1.0",
-    "execa": "9.3.0",
     "ora": "^8.0.1",
-    "@baseplate-dev/project-builder-cli": "0.4.2",
-    "@baseplate-dev/utils": "0.4.2"
+    "@baseplate-dev/project-builder-cli": "0.4.4",
+    "@baseplate-dev/project-builder-lib": "0.4.4",
+    "@baseplate-dev/project-builder-server": "0.4.4",
+    "@baseplate-dev/sync": "0.4.4",
+    "@baseplate-dev/utils": "0.4.4"
   },
   "devDependencies": {
     "@types/node": "^22.17.2",
@@ -50,7 +52,7 @@
     "tsx": "4.20.6",
     "typescript": "5.8.3",
     "vitest": "3.2.4",
-    "@baseplate-dev/tools": "0.4.2"
+    "@baseplate-dev/tools": "0.4.4"
   },
   "engines": {
     "node": "^22.0.0"

package/dist/exec.d.ts

@@ -1 +0,0 @@
-export declare function exec(command: string, cwd?: string): Promise<void>;

package/dist/exec.js

@@ -1,16 +0,0 @@
-import { execa } from 'execa';
-import ora from 'ora';
-export async function exec(command, cwd) {
-    const spinner = ora({
-        text: `Running ${command}...`,
-    }).start();
-    try {
-        const [cmd, ...args] = command.split(' ');
-        await execa(cmd, args, { cwd });
-        spinner.succeed();
-    }
-    catch (error) {
-        spinner.fail();
-        throw error;
-    }
-}

package/templates/.gitignore

@@ -1,141 +0,0 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-.pnpm-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# Snowpack dependency directory (https://snowpack.dev/)
-web_modules/
-
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional stylelint cache
-.stylelintcache
-
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# environment variable files
-.env
-.env.development.local
-.env.test.local
-.env.production.local
-.env.local
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-.parcel-cache
-
-# Next.js build output
-.next
-out
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and not Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# vuepress v2.x temp and cache directory
-.temp
-.cache
-
-# Docusaurus cache and generated files
-.docusaurus
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
-
-# Stores VSCode versions used for testing VSCode extensions
-.vscode-test
-
-# yarn v2
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
-.pnp.*
-
-playground
-
-.DS_Store
-.vercel
-
-.npmrc
-.turbo
-
-# Baseplate build artifacts
-baseplate/.build

package/templates/.pnpmfile.cjs

@@ -1,2 +0,0 @@
-// sets up .npmrc file for pnpm
-require('./scripts/setup-npmrc.cjs')(__dirname);

package/templates/.template.npmrc

@@ -1,14 +0,0 @@
-# Prevents publish from any branch other than main
-publish-branch=main
-# Saves exact versions of dependencies by default
-save-prefix=""
-# Ensures we use locally linked packages when available
-link-workspace-packages=true
-# Defaults to saving as workspace:*
-save-workspace-protocol=rolling
-# Security setting to delay installation of newly released dependencies
-# to reduce risk of installing compromised packages. Popular packages that are
-# successfully attacked are often discovered and removed from the registry
-# within an hour. Setting to 1440 minutes (24 hours) ensures only packages
-# released at least one day ago can be installed.
-minimumReleaseAge=1440

package/templates/README.md

@@ -1,35 +0,0 @@
-# Baseplate Project
-
-Welcome to your new Baseplate project! This README provides essential information on how to get started with your project, including setting up the generator UI and beginning your development process.
-
-## Getting Started
-
-To begin using the project, you will need to set up your local environment. Follow these instructions to get everything up and running.
-
-### Prerequisites
-
-Before you start, ensure you have `pnpm` installed on your system. If you do not have `pnpm` installed, you can learn how to install it by visiting [pnpm installation guide](https://pnpm.io/installation).
-
-### Installation
-
-To install the necessary dependencies for your project, run the following command in the root directory of your project:
-
-```bash
-pnpm install
-```
-
-### Launching the Generator UI
-
-To start the generator UI, which allows you to configure and initiate the code generation process, execute the following command:
-
-```bash
-pnpm baseplate serve
-```
-
-This command will start the server and open the corresponding web interface where you can customize your project’s specifications and features and generate the code.
-
-## Configuration
-
-To configure your project settings, use the web interface launched by the above command. Here you can specify data models, authentication mechanisms, and other project-specific settings.
-
-Thank you for choosing Baseplate for your project’s foundation!