Project Scaffolder
A systematic workflow for scaffolding new projects, installing dependencies, compiling, and preparing for launch.
Instructions
Work through the following checklist systematically. After completing each step, mark it complete and add a brief summary.
1. Verify Copilot Instructions File
Ensure the `.github/copilot-instructions.md` file exists in the workspace.
2. Clarify Project Requirements
Ask for project type, language, and frameworks if not already specified. Examples:
"Local Vite + React TS dashboard""Express Node.js API""Python Flask app"**Skip if the user has already provided this information.**
3. Scaffold the Project
**Prerequisites:** Step 2 must be completed.
Call project setup tool with `projectType` parameter if availableRun scaffolding command to create project files and foldersUse '.' as the working directory (do NOT create new folders unless explicitly requested)If no appropriate `projectType` is available, search documentation or create structure manuallyExample: `npx create-vite@latest . --template react-ts`Run dependency installation (e.g., `npm install`, `pip install -r requirements.txt`)**Note:** If scaffolding fails due to folder name issues, inform the user to create a correctly named folder and reopen in VS Code.
4. Customize the Project
**Prerequisites:** Step 3 must be completed.
Develop a plan to modify the codebase according to user requirementsApply modifications using appropriate tools and user-provided references**Skip this step for "Hello World" projects****Content Rules:**
Do not add links, integrations, media, or external assets unless explicitly requestedUse placeholders sparingly and note they should be replacedEnsure all generated components serve a clear purposePrompt for clarification if a feature is assumed but not confirmed5. Install Required Extensions
**Prerequisites:** Step 4 must be completed.
ONLY install extensions mentioned in `get_project_setup_info` toolDO NOT install any other extensions**If no extensions are specified, mark this step as completed and skip**6. Compile the Project
**Prerequisites:** Step 5 must be completed.
Install any missing dependenciesRun diagnostics and resolve issuesCheck markdown files in the project folder for build instructionsExample: `npm run build`, `dotnet build`, `cargo build`7. Create and Run Task (if needed)
**Prerequisites:** Step 6 must be completed.
Check if the project needs a VS Code task (refer to https://code.visualstudio.com/docs/debugtest/tasks)If needed, use `create_and_run_task` based on `package.json`, `README.md`, and project structureCreate `.vscode/tasks.json` if necessary**Skip otherwise**8. Launch the Project
**Prerequisites:** All previous steps must be completed.
Prompt the user: "Would you like to launch the project in debug mode?"Launch only if confirmedProvide clear instructions for manual launch if declined9. Ensure Documentation is Complete
**Prerequisites:** Step 8 must be completed.
Verify `README.md` exists and contains current project informationVerify `.github/copilot-instructions.md` exists and is up to dateClean up `.github/copilot-instructions.md` by removing all HTML commentsUpdate both files as neededExecution Guidelines
**Progress Tracking:**
Use available todo list tools to track progress through the checklistMark each step complete with a brief summary after finishingRead current status before starting each new step**Communication Rules:**
Keep explanations concise and focusedAvoid verbose explanations or printing full command outputsIf a step is skipped, state that briefly (e.g., "No extensions needed")Do not explain project structure unless asked**Development Rules:**
Always use '.' as the working directory unless user specifies otherwiseDo not create new folders except `.vscode` for `tasks.json`Use '.' argument for all terminal commands to ensure correct working directoryAvoid adding media or external links unless explicitly requested**Task Completion Criteria:**
Project successfully scaffolded and compiled without errors`.github/copilot-instructions.md` file exists`README.md` file exists and is up to dateUser provided with clear instructions to debug/launch the projectExample Usage
**User:** "Set up a new React TypeScript project with Vite"
**Agent:**
1. ✓ Copilot instructions verified
2. ✓ Requirements clarified: Vite + React TS
3. ✓ Scaffolded with `npx create-vite@latest . --template react-ts` and ran `npm install`
4. ✓ Customization skipped (basic setup)
5. ✓ No extensions required
6. ✓ Compiled successfully with `npm run build`
7. ✓ No task needed
8. Prompting for launch...