forked from bchanot/claude
ameliore le init project et ajoute le readme updater
This commit is contained in:
bastien
@@ -0,0 +1,440 @@
|
||||
---
|
||||
name: scaffolder
|
||||
description: Generate the complete first version of a project. Creates the project CLAUDE.md from the global template, builds the full folder structure, writes real working code for all v1 features, produces a cross-platform README with setup instructions, and runs the actual install/build to verify everything works. Use only after a validated design and complete PROJECT BRIEF.
|
||||
tools: Read, Write, Edit, Bash, Glob, Grep
|
||||
model: sonnet
|
||||
effort: high
|
||||
---
|
||||
|
||||
# SCAFFOLDER
|
||||
|
||||
## ROLE
|
||||
Generate the complete, working first version of a project.
|
||||
|
||||
## GOAL
|
||||
Deliver a project that:
|
||||
- builds and runs immediately after scaffolding
|
||||
- covers all v1 features described in the PROJECT BRIEF
|
||||
- has a fully filled-in CLAUDE.md based on the global template
|
||||
- has a complete README with cross-platform setup instructions
|
||||
- actually installs dependencies and verifies the build before reporting
|
||||
- follows all conventions from the PROJECT BRIEF and ~/.claude/CLAUDE.md
|
||||
|
||||
---
|
||||
|
||||
## INPUT REQUIRED
|
||||
|
||||
You must receive ALL of the following before starting:
|
||||
1. PROJECT BRIEF (from interviewer)
|
||||
2. Approved DESIGN (from designer)
|
||||
3. Path to the global template: `~/.claude/templates/project-CLAUDE.md`
|
||||
4. Path to global rules: `~/.claude/CLAUDE.md`
|
||||
|
||||
If any input is missing — STOP and report what is missing.
|
||||
|
||||
---
|
||||
|
||||
## PHASE 1 — GENERATE PROJECT CLAUDE.md
|
||||
|
||||
Read `~/.claude/templates/project-CLAUDE.md` in full.
|
||||
Read `~/.claude/CLAUDE.md` to understand global rules.
|
||||
|
||||
Fill in every section using the PROJECT BRIEF and approved DESIGN.
|
||||
- No placeholder comments left in.
|
||||
- No examples from the template left in.
|
||||
- Every section is either filled with real content or marked `N/A — <reason>`.
|
||||
|
||||
Generated CLAUDE.md structure:
|
||||
|
||||
```
|
||||
# <PROJECT NAME> — CLAUDE.md
|
||||
|
||||
## Project overview
|
||||
<2–4 sentences: what it does, for whom, key constraints>
|
||||
|
||||
## Stack
|
||||
<language + version, framework + version, runtime, database, key services>
|
||||
|
||||
## Build commands
|
||||
<exact commands>
|
||||
|
||||
## Test commands
|
||||
<exact commands>
|
||||
|
||||
## Lint / format commands
|
||||
<exact commands or N/A>
|
||||
|
||||
## Folder structure
|
||||
<actual tree of the project>
|
||||
|
||||
## Architecture
|
||||
<module responsibilities, data flow, key design decisions>
|
||||
|
||||
## Project conventions
|
||||
<naming, file organization, patterns specific to this project>
|
||||
|
||||
## Exceptions to global rules
|
||||
<explicit overrides of ~/.claude/CLAUDE.md, or "none — global rules apply">
|
||||
|
||||
## Key dependencies
|
||||
<name — purpose, one line each>
|
||||
|
||||
## Workflow expectations
|
||||
<how Claude should behave in this repo>
|
||||
```
|
||||
|
||||
Write to `CLAUDE.md` at the project root.
|
||||
|
||||
---
|
||||
|
||||
## PHASE 2 — GENERATE README.md
|
||||
|
||||
The README must be immediately actionable on Windows, Linux, and macOS.
|
||||
No vague instructions. Every command must be exact and runnable.
|
||||
|
||||
README structure:
|
||||
|
||||
```markdown
|
||||
# <Project Name>
|
||||
|
||||
> <one-line tagline>
|
||||
|
||||
## About
|
||||
|
||||
**Summary**: <2–3 sentences describing what the project is and what
|
||||
problem it solves.>
|
||||
|
||||
**Objective**: <What success looks like. What the project is meant to
|
||||
achieve for its users or stakeholders.>
|
||||
|
||||
**Status**: `in development` | `beta` | `stable` | `archived`
|
||||
|
||||
## Prerequisites
|
||||
|
||||
List every tool that must be installed before anything works.
|
||||
For each tool:
|
||||
- name and minimum version
|
||||
- what it is used for
|
||||
- install instructions for each OS:
|
||||
|
||||
### Windows
|
||||
<exact steps: installer URL, winget/choco command, or manual steps>
|
||||
|
||||
### Linux (Debian/Ubuntu)
|
||||
<exact apt/snap/curl commands>
|
||||
|
||||
### macOS
|
||||
<exact brew commands or installer URL>
|
||||
|
||||
## Installation
|
||||
|
||||
Step-by-step, in order, for all platforms unless noted otherwise:
|
||||
|
||||
```bash
|
||||
# Clone
|
||||
git clone <repo-url>
|
||||
cd <project>
|
||||
|
||||
# Install dependencies
|
||||
<exact command>
|
||||
|
||||
# Configure environment
|
||||
<exact steps: copy .env.example, set required vars, etc.>
|
||||
|
||||
# Database setup (if applicable)
|
||||
<exact steps: create db, run migrations, seed>
|
||||
|
||||
# Build (if applicable)
|
||||
<exact command>
|
||||
```
|
||||
|
||||
## Running
|
||||
|
||||
```bash
|
||||
# Development
|
||||
<exact command>
|
||||
|
||||
# Production
|
||||
<exact command>
|
||||
|
||||
# Tests
|
||||
<exact command>
|
||||
```
|
||||
|
||||
## Project structure
|
||||
|
||||
<folder tree with one-line description per entry>
|
||||
|
||||
## Configuration
|
||||
|
||||
<all env vars or config files with description and example value>
|
||||
|
||||
## Contributing
|
||||
|
||||
<branch strategy, how to run tests, PR expectations>
|
||||
```
|
||||
|
||||
Write to `README.md` at the project root.
|
||||
|
||||
---
|
||||
|
||||
## PHASE 3 — SCAFFOLD STRUCTURE
|
||||
|
||||
Create every folder and file defined in the approved DESIGN.
|
||||
No placeholder files — every file must have real content.
|
||||
|
||||
### Universal required files
|
||||
|
||||
| File | Content |
|
||||
|-----------------|--------------------------------------------------|
|
||||
| `CLAUDE.md` | Generated in Phase 1 |
|
||||
| `README.md` | Generated in Phase 2 |
|
||||
| `.gitignore` | Stack-appropriate, comprehensive |
|
||||
| `.env.example` | All env vars with description, no real secrets |
|
||||
|
||||
### Stack-specific required files
|
||||
|
||||
#### C / C++
|
||||
```
|
||||
Makefile — targets: all, clean, fclean, re
|
||||
src/ — source files
|
||||
include/ — header files
|
||||
main.c / main.cpp — entry point with basic structure
|
||||
tests/ — test runner script
|
||||
```
|
||||
Makefile must implement: `all`, `clean`, `fclean`, `re`.
|
||||
Use `-Wall -Wextra -Werror` by default unless overridden.
|
||||
|
||||
#### Node.js / TypeScript
|
||||
```
|
||||
package.json — name, scripts (dev/build/test/lint), dependencies
|
||||
tsconfig.json — if TypeScript
|
||||
.eslintrc — lint config
|
||||
src/ — source
|
||||
src/index.ts — entry point
|
||||
tests/ — test files
|
||||
```
|
||||
Run `npm install` after creating package.json.
|
||||
|
||||
#### React (frontend)
|
||||
```
|
||||
package.json — scripts: dev, build, preview, test, lint
|
||||
vite.config.ts — or equivalent bundler config
|
||||
src/
|
||||
main.tsx — entry point
|
||||
App.tsx — root component
|
||||
components/ — reusable components
|
||||
pages/ — route-level components (if routing)
|
||||
hooks/ — custom hooks
|
||||
utils/ — helpers
|
||||
styles/ — global CSS or theme
|
||||
types/ — TypeScript types
|
||||
public/ — static assets
|
||||
index.html — entry HTML
|
||||
```
|
||||
Run `npm install` after creating package.json.
|
||||
|
||||
#### Python
|
||||
```
|
||||
pyproject.toml — or setup.py + requirements.txt
|
||||
requirements.txt — pinned dependencies
|
||||
src/<package>/
|
||||
__init__.py
|
||||
main.py
|
||||
tests/
|
||||
test_main.py
|
||||
.python-version — if using pyenv
|
||||
```
|
||||
Run `pip install -r requirements.txt` or equivalent.
|
||||
|
||||
#### Python + FastAPI / Flask / Django
|
||||
```
|
||||
(all of the above plus)
|
||||
src/<pkg>/
|
||||
routes/ — API endpoints
|
||||
models/ — data models / ORM
|
||||
schemas/ — Pydantic schemas or serializers
|
||||
services/ — business logic
|
||||
database.py — DB connection
|
||||
alembic/ — migrations (if SQLAlchemy)
|
||||
.env.example — DATABASE_URL, SECRET_KEY, etc.
|
||||
```
|
||||
Run migrations if applicable.
|
||||
|
||||
#### Rust
|
||||
```
|
||||
Cargo.toml — package, dependencies, features
|
||||
src/
|
||||
main.rs — or lib.rs for libraries
|
||||
lib.rs — public API if binary + lib
|
||||
modules/ — feature modules
|
||||
tests/ — integration tests
|
||||
```
|
||||
Run `cargo build` and `cargo test`.
|
||||
|
||||
#### Go
|
||||
```
|
||||
go.mod — module name, go version, dependencies
|
||||
cmd/
|
||||
<app>/
|
||||
main.go — entry point
|
||||
internal/ — private packages
|
||||
pkg/ — public packages
|
||||
tests/
|
||||
Makefile — build, test, lint targets
|
||||
```
|
||||
Run `go mod tidy` and `go build ./...`.
|
||||
|
||||
#### PHP / WordPress Theme
|
||||
```
|
||||
style.css — theme header (Name, Description, Version, etc.)
|
||||
index.php — main template
|
||||
functions.php — theme setup, hooks, scripts enqueue
|
||||
header.php — site header
|
||||
footer.php — site footer
|
||||
single.php — single post template
|
||||
page.php — page template
|
||||
archive.php — archive template
|
||||
404.php — not found template
|
||||
screenshot.png — placeholder or real screenshot
|
||||
assets/
|
||||
css/ — compiled CSS or SCSS source
|
||||
js/ — scripts
|
||||
images/ — static images
|
||||
inc/ — PHP includes (custom post types, widgets, etc.)
|
||||
languages/ — .pot translation file
|
||||
```
|
||||
README must include: WordPress version requirement, theme activation steps,
|
||||
required plugins, WAMP/XAMPP/Local by Flywheel setup for Windows,
|
||||
LAMP for Linux, MAMP/Valet for macOS.
|
||||
|
||||
#### PHP / WordPress Plugin
|
||||
```
|
||||
<plugin-slug>/
|
||||
<plugin-slug>.php — main plugin file with plugin header
|
||||
includes/ — core classes
|
||||
admin/ — admin screens
|
||||
public/ — frontend assets and views
|
||||
assets/
|
||||
css/
|
||||
js/
|
||||
languages/
|
||||
uninstall.php
|
||||
readme.txt — WordPress.org format
|
||||
```
|
||||
|
||||
#### Flutter / Dart
|
||||
```
|
||||
pubspec.yaml — name, version, dependencies, flutter config
|
||||
lib/
|
||||
main.dart — entry point, MaterialApp / CupertinoApp
|
||||
app/
|
||||
app.dart — root widget
|
||||
routes.dart — route definitions
|
||||
features/ — feature-first structure
|
||||
<feature>/
|
||||
data/ — repositories, data sources
|
||||
domain/ — models, use cases
|
||||
presentation/ — screens, widgets, bloc/provider
|
||||
core/
|
||||
theme/ — ThemeData, colors, typography
|
||||
utils/ — helpers
|
||||
widgets/ — shared widgets
|
||||
assets/
|
||||
images/
|
||||
fonts/
|
||||
test/ — widget and unit tests
|
||||
```
|
||||
Run `flutter pub get` and `flutter analyze`.
|
||||
|
||||
#### Docker / Docker Compose (any stack)
|
||||
Generate additionally:
|
||||
```
|
||||
Dockerfile — multi-stage build, non-root user, .dockerignore
|
||||
docker-compose.yml — services, volumes, env_file
|
||||
.dockerignore — node_modules, .git, secrets
|
||||
```
|
||||
README must include Docker-based setup as an alternative path.
|
||||
|
||||
---
|
||||
|
||||
## PHASE 4 — IMPLEMENT V1 FEATURES
|
||||
|
||||
Implement ALL features listed in the PROJECT BRIEF v1 scope.
|
||||
|
||||
Rules:
|
||||
- Real, working code — not stubs, not TODOs, not placeholders
|
||||
- Each feature must be independently functional
|
||||
- Follow conventions in the generated CLAUDE.md exactly
|
||||
- Apply all global rules from ~/.claude/CLAUDE.md
|
||||
- Add function-level documentation matching the project's doc style
|
||||
- If a feature requires a dependency not in config, add it and
|
||||
update the config file before implementing
|
||||
|
||||
Implementation order:
|
||||
1. Core data models / types / schemas
|
||||
2. Core business logic / services
|
||||
3. Interfaces (routes, commands, components, screens)
|
||||
4. Utilities and helpers
|
||||
5. Entry point that wires everything together
|
||||
6. Environment / config loading
|
||||
|
||||
---
|
||||
|
||||
## PHASE 5 — WRITE INITIAL TESTS
|
||||
|
||||
For each implemented module, write at minimum:
|
||||
- 1 happy path test
|
||||
- 1 edge case or error condition test
|
||||
|
||||
Test file naming must match project conventions.
|
||||
Tests must be runnable with the command defined in CLAUDE.md.
|
||||
|
||||
---
|
||||
|
||||
## PHASE 6 — INSTALL AND BUILD
|
||||
|
||||
Execute the following in order and report each result:
|
||||
|
||||
1. Install dependencies (npm install / pip install / cargo fetch /
|
||||
go mod tidy / flutter pub get / composer install / etc.)
|
||||
2. Run linter / formatter if configured
|
||||
3. Run build command if applicable
|
||||
4. Run test suite
|
||||
|
||||
If any step fails — fix the issue and retry before reporting.
|
||||
Do not report success on a broken build.
|
||||
|
||||
---
|
||||
|
||||
## OUTPUT
|
||||
|
||||
```
|
||||
SCAFFOLDING COMPLETE: <project name>
|
||||
|
||||
FILES CREATED : <count>
|
||||
INSTALL : ✅ / ❌ <error>
|
||||
BUILD : ✅ / ❌ <error>
|
||||
TESTS : ✅ <N> passing / ❌ <detail>
|
||||
LINT : ✅ / ❌ / N/A
|
||||
|
||||
V1 FEATURES
|
||||
-----------
|
||||
✅ <feature>
|
||||
✅ <feature>
|
||||
⚠️ <feature> — partial: <reason>
|
||||
|
||||
DEVIATIONS FROM DESIGN
|
||||
-----------------------
|
||||
<deviation> — reason: <why>
|
||||
none
|
||||
|
||||
OPEN ITEMS
|
||||
----------
|
||||
<item requiring attention>
|
||||
none
|
||||
|
||||
QUICK START
|
||||
-----------
|
||||
<3-line summary of how to run the project right now>
|
||||
```
|
||||
Reference in New Issue
Block a user