Reference
@reckona/create-mreact-app
15 public exports.
Function
FunctioncreateMreactApp
function createMreactApp(options: CreateMreactAppOptions): Promise<CreateMreactAppResult>Scaffolds a new mreact app by writing the selected template files into the target directory.FunctionupgradeMreactAppfunction upgradeMreactApp(options: UpgradeMreactAppOptions): Promise<UpgradeMreactAppResult>Updates known mreact workspace dependencies and records version-gated codemods for an existing app.Interface
InterfaceCreateMreactAppOptions
interface CreateMreactAppOptionsConfigures the project directory, template, package manager, and deploy target for app scaffolding.InterfaceCreateMreactAppResultinterface CreateMreactAppResultReports the generated app directory, files, package manager, template, and deploy target.InterfaceUpgradeMreactAppCodemodResultinterface UpgradeMreactAppCodemodResultReports whether an upgrade codemod would be or was applied.InterfaceUpgradeMreactAppDependencyUpdateinterface UpgradeMreactAppDependencyUpdateDescribes a package dependency version changed by an app upgrade run.InterfaceUpgradeMreactAppOptionsinterface UpgradeMreactAppOptionsConfigures an existing mreact app upgrade run.InterfaceUpgradeMreactAppResultinterface UpgradeMreactAppResultReports the package file, dependency updates, codemods, and change flag for an upgrade run.Type Alias
Type AliasCreateMreactAppDeployTarget
type CreateMreactAppDeployTarget = "aws-lambda" | "cloudflare" | "container"Names the deployment target whose files are included in the generated app.Type AliasCreateMreactAppPackageManagertype CreateMreactAppPackageManager = "pnpm" | "npm" | "bun"Names the package manager used to write install and script commands.Type AliasCreateMreactAppTemplatetype CreateMreactAppTemplate = "basic" | "tailwind" | "dashboard"Names the starter template used when scaffolding a new mreact app.Type AliasPackageDependencyFieldtype PackageDependencyField = "dependencies" | "devDependencies" | "peerDependencies" | "optionalDependencies"Names package.json dependency sections that can contain mreact workspace packages.Variable
VariablecreateMreactAppCodemods
const createMreactAppCodemods: readonly [{ description: "Normalize app-router import policy examples after the 0.0.16 adapter template changes."; id: "0.0.16-import-policy-normalize"; version: "0.0.16" }, { description: "Check AWS Lambda template ESM entrypoints and package-manager production install guidance."; id: "0.0.16-aws-lambda-esm-template"; version: "0.0.16" }, { description: "Check app-router tsconfig global type declarations for Slot, Await, and generated route helpers."; id: "0.0.54-app-router-globals"; version: "0.0.54" }, { description: "Review generated app-router CSS imports and route stylesheet assumptions after automatic route CSS asset support."; id: "0.0.78-route-css-assets"; version: "0.0.78" }, { description: "Review AWS Lambda build/package scripts for generated Lambda targets, generated import policy, and minimal asset packaging."; id: "0.0.120-aws-lambda-generated-package"; version: "0.0.120" }, { description: "Review starter pages that still render static hello content; current basic and Tailwind starters use a small interactive cell counter."; id: "0.0.148-interactive-counter-starter"; version: "0.0.148" }]Lists version-gated codemods reported by `upgradeMreactApp()`.VariablecreateMreactAppDeployTargetsconst createMreactAppDeployTargets: readonly ["cloudflare", "container", "aws-lambda"]Lists the deployment targets supported by `createMreactApp()`.VariablecreateMreactAppTemplatesconst createMreactAppTemplates: readonly ["basic", "tailwind", "dashboard"]Lists the templates supported by `createMreactApp()`.