Init API reference

runInit(config: InitConfig): Promise<ResolvedConfig>

resolveConfig(config: InitConfig): ResolvedConfig

buildPackageName(scope: string, projectId: string, mod: { packageNameSuffix: string; }): string

packageNameToFolder(packageName: string): string

type InitConfig = {
  projectId: string;
  scope: string;
  modules: ModuleInput[];
  playgroundMode: PlaygroundMode;
  cwd: string;
}

type ModuleInput = {
  moduleId: string;
  packageNameSuffix: string;
  title: string;
  description: string;
  kind: ModuleKind;
  platforms: ModulePlatform[];
  stability: ModuleStability;
}

type ModuleKind = "core" | "integration" | "plugin" | "sdk" | "cli"

type ModulePlatform = | "node"
  | "browser"
  | "react"
  | "react-native"
  | "vue"
  | "svelte"
  | "solid"
  | "universal"

type ModuleStability = "experimental" | "beta" | "stable" | "deprecated"

type PlaygroundMode = "none" | "single" | "per-module"

type ResolvedConfig = InitConfig & {
  siteDir: string;
  configDir: string;
  modulesResolved: ResolvedModule[];
}

type ResolvedModule = ModuleInput & {
  packageName: string;
  packageDir: string;
  docsDir: string;
  docsDirRelativeToSite: string;
}

const defaults: { readonly version: "0.1.0"; readonly license: "MIT"; readonly nodeEngines: ">=20"; readonly orphanMode: "warn"; }