create-webplan

Prompt-first scaffolder for Webplan sites.

Current status

The package now covers all tracked webplan-005 milestones M1 through M3:

• public npm package shape for create-webplan
• fixed CLI contract for create-webplan <targetDir>
• prompt collection for package name, description, optional author, and package.json.webplan.canonicalBase
• deterministic target-directory policy
• template-source cleanup for create-driven consumption
• explicit rewrite seams in the template metadata and home-page content
• template copy into the target directory
• exclusion of workspace/build artifacts such as node_modules, dist, and .ssg-temp
• rewrite of package.json, index.html, src/pages/content.ts, and the generated project README.md
• generated-project smoke validation that scaffolds, installs, and builds a fresh site
• prepack and postpack template sync so the published tarball carries its own template source
• pack validation and publish-workflow coverage for create-webplan

The package is publish-ready from this monorepo, including a self-contained npm tarball that no longer depends on the local workspace template at install time.

CLI contract

create-webplan <targetDir>

Prompts:

• package name
  • defaults from the target directory basename
  • must stay lowercase and use only letters, numbers, ., _, or -
• description
  • defaults to A Webplan site
• author
  • optional
• canonical base
  • defaults to https://example.com
  • must be an absolute http or https URL

Target directory rules:

• a missing directory is accepted
• an existing empty directory is accepted
• an existing non-empty directory is rejected

V1 still requires manual follow-through. It does not install dependencies, initialize git, or add CI/bootstrap extras.

Generated output:

• copies the template source into the target directory
• rewrites package.json.name, description, optional author, and webplan.canonicalBase
• rewrites scaffold-owned metadata in index.html and src/pages/content.ts
• writes a consumer-facing README.md

Validation

• npm run test
• npm run test:smoke
• npm run test:pack
• npm run test:all

Relationship to the template and core package

• packages/webplan-template remains the source scaffold skeleton
• packages/webplan-template now intentionally has no post-copy scripts/setup.mjs; metadata rewrites belong to the scaffolder
• @webplan-pro/webplan-site-core remains the owner of reusable runtime behavior, preview, prerender, router generation, and typed exports
• create-webplan owns scaffolding only and must not duplicate runtime behavior from the core package
• the published create-webplan tarball now carries a synced copy of the template source via prepack and postpack