@baseplate-dev/create-project
Version:
CLI starter kit for creating a new Baseplate project
36 lines (35 loc) • 1.22 kB
TypeScript
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 {};