@baseplate-dev/create-project 0.3.3 → 0.6.3

package/LICENSE

@@ -7,30 +7,30 @@ This project is licensed under the Mozilla Public License 2.0 (MPL-2.0) with the
 **Generated Code Exception**: All code generated by Baseplate generators and templates belongs entirely to the user who generated it. Half Dome Labs LLC disclaims any copyright interest in generated code. Users may use, modify, distribute, and license generated code under any terms they choose, including proprietary licenses, with no restrictions or attribution requirements.
 
 # Mozilla Public License Version 2.0
+==================================
 
 1. Definitions
-
----
+--------------
 
 1.1. "Contributor"
-means each individual or legal entity that creates, contributes to
-the creation of, or owns Covered Software.
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
 
 1.2. "Contributor Version"
-means the combination of the Contributions of others (if any) used
-by a Contributor and that particular Contributor's Contribution.
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
 
 1.3. "Contribution"
-means Covered Software of a particular Contributor.
+    means Covered Software of a particular Contributor.
 
 1.4. "Covered Software"
-means Source Code Form to which the initial Contributor has attached
-the notice in Exhibit A, the Executable Form of such Source Code
-Form, and Modifications of such Source Code Form, in each case
-including portions thereof.
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
 
 1.5. "Incompatible With Secondary Licenses"
-means
+    means
 
     (a) that the initial Contributor has attached the notice described
         in Exhibit B to the Covered Software; or
@@ -40,22 +40,22 @@ means
         terms of a Secondary License.
 
 1.6. "Executable Form"
-means any form of the work other than Source Code Form.
+    means any form of the work other than Source Code Form.
 
 1.7. "Larger Work"
-means a work that combines Covered Software with other material, in
-a separate file or files, that is not Covered Software.
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
 
 1.8. "License"
-means this document.
+    means this document.
 
 1.9. "Licensable"
-means having the right to grant, to the maximum extent possible,
-whether at the time of the initial grant or subsequently, any and
-all of the rights conveyed by this License.
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
 
 1.10. "Modifications"
-means any of the following:
+    means any of the following:
 
     (a) any file in Source Code Form that results from an addition to,
         deletion from, or modification of the contents of Covered
@@ -65,35 +65,34 @@ means any of the following:
         Software.
 
 1.11. "Patent Claims" of a Contributor
-means any patent claim(s), including without limitation, method,
-process, and apparatus claims, in any patent Licensable by such
-Contributor that would be infringed, but for the grant of the
-License, by the making, using, selling, offering for sale, having
-made, import, or transfer of either its Contributions or its
-Contributor Version.
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
 
 1.12. "Secondary License"
-means either the GNU General Public License, Version 2.0, the GNU
-Lesser General Public License, Version 2.1, the GNU Affero General
-Public License, Version 3.0, or any later versions of those
-licenses.
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
 
 1.13. "Source Code Form"
-means the form of the work preferred for making modifications.
+    means the form of the work preferred for making modifications.
 
 1.14. "You" (or "Your")
-means an individual or a legal entity exercising rights under this
-License. For legal entities, "You" includes any entity that
-controls, is controlled by, or is under common control with You. For
-purposes of this definition, "control" means (a) the power, direct
-or indirect, to cause the direction or management of such entity,
-whether by contract or otherwise, or (b) ownership of more than
-fifty percent (50%) of the outstanding shares or beneficial
-ownership of such entity.
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
 
 2. License Grants and Conditions
-
----
+--------------------------------
 
 2.1. Grants
 
@@ -101,14 +100,14 @@ Each Contributor hereby grants You a world-wide, royalty-free,
 non-exclusive license:
 
 (a) under intellectual property rights (other than patent or trademark)
-Licensable by such Contributor to use, reproduce, make available,
-modify, display, perform, distribute, and otherwise exploit its
-Contributions, either on an unmodified basis, with Modifications, or
-as part of a Larger Work; and
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
 
 (b) under Patent Claims of such Contributor to make, use, sell, offer
-for sale, have made, import, and otherwise transfer either its
-Contributions or its Contributor Version.
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
 
 2.2. Effective Date
 
@@ -125,15 +124,15 @@ Notwithstanding Section 2.1(b) above, no patent license is granted by a
 Contributor:
 
 (a) for any code that a Contributor has removed from Covered Software;
-or
+    or
 
 (b) for infringements caused by: (i) Your and any other third party's
-modifications of Covered Software, or (ii) the combination of its
-Contributions with other software (except as part of its Contributor
-Version); or
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
 
 (c) under Patent Claims infringed by Covered Software in the absence of
-its Contributions.
+    its Contributions.
 
 This License does not grant any rights in the trademarks, service marks,
 or logos of any Contributor (except as may be necessary to comply with
@@ -164,8 +163,7 @@ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
 in Section 2.1.
 
 3. Responsibilities
-
----
+-------------------
 
 3.1. Distribution of Source Form
 
@@ -182,15 +180,15 @@ Form.
 If You distribute Covered Software in Executable Form then:
 
 (a) such Covered Software must also be made available in Source Code
-Form, as described in Section 3.1, and You must inform recipients of
-the Executable Form how they can obtain a copy of such Source Code
-Form by reasonable means in a timely manner, at a charge no more
-than the cost of distribution to the recipient; and
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
 
 (b) You may distribute such Executable Form under the terms of this
-License, or sublicense it under different terms, provided that the
-license for the Executable Form does not attempt to limit or alter
-the recipients' rights in the Source Code Form under this License.
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
 
 3.3. Distribution of a Larger Work
 
@@ -227,8 +225,7 @@ disclaimers of warranty and limitations of liability specific to any
 jurisdiction.
 
 4. Inability to Comply Due to Statute or Regulation
-
----
+---------------------------------------------------
 
 If it is impossible for You to comply with any of the terms of this
 License with respect to some or all of the Covered Software due to
@@ -241,8 +238,7 @@ or regulation, such description must be sufficiently detailed for a
 recipient of ordinary skill to be able to understand it.
 
 5. Termination
-
----
+--------------
 
 5.1. The rights granted under this License will terminate automatically
 if You fail to comply with any of its terms. However, if You become
@@ -270,55 +266,50 @@ end user license agreements (excluding distributors and resellers) which
 have been validly granted by You or Your distributors under this License
 prior to termination shall survive termination.
 
----
-
--                                                                      *
-- 6.  Disclaimer of Warranty \*
-- ------------------------- \*
--                                                                      *
-- Covered Software is provided under this License on an "as is" \*
-- basis, without warranty of any kind, either expressed, implied, or \*
-- statutory, including, without limitation, warranties that the \*
-- Covered Software is free of defects, merchantable, fit for a \*
-- particular purpose or non-infringing. The entire risk as to the \*
-- quality and performance of the Covered Software is with You. \*
-- Should any Covered Software prove defective in any respect, You \*
-- (not any Contributor) assume the cost of any necessary servicing, \*
-- repair, or correction. This disclaimer of warranty constitutes an \*
-- essential part of this License. No use of any Covered Software is \*
-- authorized under this License except under this disclaimer. \*
--                                                                      *
-
----
-
----
-
--                                                                      *
-- 7.  Limitation of Liability \*
-- -------------------------- \*
--                                                                      *
-- Under no circumstances and under no legal theory, whether tort \*
-- (including negligence), contract, or otherwise, shall any \*
-- Contributor, or anyone who distributes Covered Software as \*
-- permitted above, be liable to You for any direct, indirect, \*
-- special, incidental, or consequential damages of any character \*
-- including, without limitation, damages for lost profits, loss of \*
-- goodwill, work stoppage, computer failure or malfunction, or any \*
-- and all other commercial damages or losses, even if such party \*
-- shall have been informed of the possibility of such damages. This \*
-- limitation of liability shall not apply to liability for death or \*
-- personal injury resulting from such party's negligence to the \*
-- extent applicable law prohibits such limitation. Some \*
-- jurisdictions do not allow the exclusion or limitation of \*
-- incidental or consequential damages, so this exclusion and \*
-- limitation may not apply to You. \*
--                                                                      *
-
----
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
 
 8. Litigation
-
----
+-------------
 
 Any litigation relating to this License may be brought only in the
 courts of a jurisdiction where the defendant maintains its principal
@@ -328,8 +319,7 @@ Nothing in this Section shall prevent a party's ability to bring
 cross-claims or counter-claims.
 
 9. Miscellaneous
-
----
+----------------
 
 This License represents the complete agreement concerning the subject
 matter hereof. If any provision of this License is held to be
@@ -339,8 +329,7 @@ that the language of a contract shall be construed against the drafter
 shall not be used to construe this License against a Contributor.
 
 10. Versions of the License
-
----
+---------------------------
 
 10.1. New Versions
 
@@ -371,11 +360,12 @@ If You choose to distribute Source Code Form that is Incompatible With
 Secondary Licenses under the terms of this version of the License, the
 notice described in Exhibit B of this License must be attached.
 
-## Exhibit A - Source Code Form License Notice
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
 
-This Source Code Form is subject to the terms of the Mozilla Public
-License, v. 2.0. If a copy of the MPL was not distributed with this
-file, You can obtain one at http://mozilla.org/MPL/2.0/.
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
 If it is not possible or desirable to put the notice in a particular
 file, then You may include the notice in a location (such as a LICENSE
@@ -384,7 +374,8 @@ for such a notice.
 
 You may add additional accurate notices of copyright ownership.
 
-## Exhibit B - "Incompatible With Secondary Licenses" Notice
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
 
-This Source Code Form is "Incompatible With Secondary Licenses", as
-defined by the Mozilla Public License, v. 2.0.
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/dist/create-baseplate-project.js

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
+import { getPackageVersion } from '@baseplate-dev/utils/node';
 import chalk from 'chalk';
 import { program } from 'commander';
 import fs from 'node:fs/promises';
 import path from 'node:path';
-import { getLatestCliVersion } from './npm.service.js';
 import { generateBaseplateProject } from './project-creator.js';
-import { getPackageVersion } from './version.js';
+import { getCliVersion } from './version.js';
 // check if directory contains a package.json file
 async function checkForPackageJson(directory) {
     try {
@@ -18,7 +18,7 @@ async function checkForPackageJson(directory) {
     }
 }
 async function runMain() {
-    const version = await getPackageVersion();
+    const version = await getPackageVersion(import.meta.dirname);
     if (!version) {
         throw new Error('Could not determine package version');
     }
@@ -44,7 +44,7 @@ async function runMain() {
     if (hasPackageJson) {
         throw new Error(`The directory ${directory} already contains a package.json file.`);
     }
-    const cliVersion = await getLatestCliVersion();
+    const cliVersion = await getCliVersion();
     await generateBaseplateProject({
         packageName,
         directory: resolvedDirectory,

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.6.5',
-            engines: {
-                node: '^22.0.0',
-                pnpm: '^10.6.0',
-            },
-            volta: {
-                node: '22.14.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,78 @@
+import { getLatestMigrationVersion } from '@baseplate-dev/project-builder-lib';
+import { generateProjectId, SERVER_CORE_MODULES, 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: [],
+        libraries: [],
+        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: [],
+        coreModules: SERVER_CORE_MODULES,
+    };
+    // Create parser context
+    const context = {
+        pluginStore,
+        cliVersion: config.cliVersion,
+        project: {
+            id: generateProjectId(config.directory),
+            name: config.name,
+            directory: config.directory,
+            type: 'user',
+            baseplateDirectory: path.join(config.directory, 'baseplate'),
+        },
+    };
+    // 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/dist/version.d.ts

@@ -1 +1 @@
-export declare function getPackageVersion(): Promise<string | null>;
+export declare function getCliVersion(): Promise<string>;

package/dist/version.js

@@ -1,23 +1,12 @@
-import { findNearestPackageJson } from '@baseplate-dev/utils/node';
-import { promises as fs } from 'node:fs';
-import { fileURLToPath } from 'node:url';
-let cachedVersion;
-export async function getPackageVersion() {
-    if (cachedVersion === undefined) {
-        // Construct the path to the package.json file.
-        const packageJsonPath = await findNearestPackageJson({
-            cwd: fileURLToPath(import.meta.url),
-        });
-        if (packageJsonPath) {
-            // Read the package.json file.
-            const fileContent = await fs.readFile(packageJsonPath, 'utf8');
-            const packageJson = JSON.parse(fileContent);
-            // Return the version.
-            cachedVersion = packageJson.version || null;
-        }
-        else {
-            cachedVersion = null;
-        }
+import { getPackageVersion } from '@baseplate-dev/utils/node';
+import { createRequire } from 'node:module';
+import path from 'node:path';
+export async function getCliVersion() {
+    const require = createRequire(import.meta.url);
+    const cliEntryPath = require.resolve('@baseplate-dev/project-builder-cli');
+    const version = await getPackageVersion(path.dirname(cliEntryPath));
+    if (!version) {
+        throw new Error(`Unable to find version in package.json for @baseplate-dev/project-builder-cli in ${cliEntryPath}`);
     }
-    return cachedVersion;
+    return version;
 }