Workspace Command Toolkit

A VS Code extension that helps you quickly generate project documentation from customizable templates via the Command Palette.

Features

• Quick Document Generation: Generate common project documentation files (Implementation, Design System, Page Specs) with a single command
• Template Variables: Automatically populate templates with project name, tech stack, notes, and date
• Workspace Customization: Override built-in templates with your own workspace-specific templates
• Smart File Handling: Automatically handles existing files with options to open, overwrite, or create timestamped copies
• Configurable Output: Customize where generated files are saved and which templates to use

Commands

Access all commands via the Command Palette (Ctrl+Shift+P / Cmd+Shift+P):

• WCT: Create Implementation.md - Generate an implementation documentation file
• WCT: Create design-system.md - Generate a design system documentation file
• WCT: Create page-specs.md - Generate page specifications documentation file
• WCT: Create From Template - Interactive picker to select and generate any template
• WCT: Configure Templates - Open extension settings

Usage

1. Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
2. Type "WCT" to see available commands
3. Select a command (e.g., "WCT: Create Implementation.md")
4. If prompted, enter:
   • Project name (defaults to workspace folder name)
   • Tech stack (e.g., "Next.js, Prisma, Postgres")
   • Optional notes
5. The document will be generated in your configured output directory and opened automatically

Example Workflow

1. Press Ctrl+Shift+P
2. Type "WCT: Create Implementation.md"
3. Enter project details when prompted
4. Document is created in docs/Implementation.md (or your configured directory)

Extension Settings

This extension contributes the following settings:

workspace-command-toolkit.targetDir

• Type: string
• Default: "docs"
• Description: Output directory relative to workspace root where generated documents will be saved.

workspace-command-toolkit.promptForVariables

• Type: boolean
• Default: true
• Description: Whether to prompt for template variables (project name, stack, notes) before generating documents. If disabled, uses workspace folder name as project name.

workspace-command-toolkit.workspaceTemplateDir

• Type: string
• Default: ".vscode/templates"
• Description: Directory path (relative to workspace root) where workspace-local template overrides are stored.

workspace-command-toolkit.templates

• Type: object
• Default:

  {
    "Implementation.md": ".vscode/templates/implementation.md",
    "design-system.md": ".vscode/templates/design-system.md",
    "page-specs.md": ".vscode/templates/page-specs.md"
  }
  

• Description: Map of output filename to workspace-relative template override path. If a template file exists at the specified path, it will be used instead of the built-in template.

Customizing Templates

You can override the built-in templates by creating custom templates in your workspace:

1. Create a .vscode/templates directory in your workspace root (or configure a custom path)
2. Add template files with the same names as the output files (e.g., implementation.md, design-system.md, page-specs.md)
3. Use template variables in your custom templates:
   • {{projectName}} - Project name
   • {{stack}} - Tech stack
   • {{notes}} - Optional notes
   • {{dateISO}} - Current date in ISO format

Example Custom Template

# {{projectName}} - Implementation Guide

Created: {{dateISO}}

## Tech Stack
{{stack}}

## Project Notes
{{notes}}

## Your Custom Sections
...

Requirements

• VS Code version 1.105.0 or higher

Known Issues

None at this time. If you encounter any issues, please report them on the GitHub repository.

Release Notes

See CHANGELOG.md for detailed release notes.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This extension is licensed under the MIT License. See LICENSE for details.

Enjoy generating documentation faster!