Windsweeper for VS Code

Windsweeper VS Code Extension provides seamless integration between your Windsweeper projects and Visual Studio Code, offering powerful tools for managing rules and workflows directly in your development environment.

Features

Rules Management

• View and organize rules in the dedicated Rules Explorer panel
• Create new rules with customizable templates for different languages
• Apply rules to your codebase for automatic analysis and validation
• Real-time diagnostics for rule violations in your code

Workflows Integration

• Browse workflows in the Workflows Explorer panel
• Create new workflows with language-specific templates
• Apply workflows to your current file or selection
• Validate workflows for consistency and best practices

MCP Server Integration

• Start and manage the Windsweeper MCP server directly from VS Code
• Real-time feedback from the MCP server for rule application and workflow validation
• Status bar indicators for server connection status

Language Features

• Smart autocompletion for rules and workflows
• Hover information for rules, workflows, and code examples
• Document links for easy navigation between related rules and workflows

Getting Started

1. Installation: Install the extension from the VS Code Marketplace

2. Initialize Project: If you don't have a Windsweeper project yet, use the "Initialize Windsweeper Project" command or run the CLI command:

   windsweeper init
   

3. View Rules & Workflows: Open the Windsweeper Explorer panel to view your rules and workflows

4. Create Rules: Use the "Create New Rule" command to create standardized rule definitions

Requirements

• VS Code 1.60.0 or newer
• For full functionality, either:
  • Windsweeper Node.js CLI (for JavaScript/TypeScript projects)
  • Windsweeper Python CLI (for Python projects)
  • Global Windsweeper CLI installation

Extension Settings

This extension contributes the following settings:

• windsweeper.mcpServerPort: Port number for the MCP server (default: 9001)
• windsweeper.openAIApiKey: OpenAI API key for AI-powered features
• windsweeper.autoStartMcpServer: Automatically start the MCP server on launch
• windsweeper.enableDiagnostics: Enable real-time diagnostics for rule violations
• windsweeper.customTemplatesPath: Path to custom rule and workflow templates

Commands

Contributing

We welcome contributions to the Windsweeper VS Code Extension! Please see our contribution guidelines for details.

License

This extension is licensed under the MIT License.

Powered by Windsweeper - A framework for creating, managing, and applying development rules and workflows.

Release Notes

For detailed release notes, see our CHANGELOG.

0.1.0 - Initial Release

• Tree views for exploring rules and workflows
• Commands for creating and applying workflows
• Diagnostics for rule violations
• Rich editor support for workflow files
• Integration with the Windsweeper MCP server for rule validation

Known Issues

• The extension currently requires the Windsweeper CLI to be installed for some functionality
• Multi-language support requires the appropriate Windsweeper CLI variant (Node.js or Python)

Roadmap

• Enhanced error diagnostics with quick fix suggestions
• Direct integration with version control systems
• Template management interface
• Customizable rule severity settings
• Performance optimizations for large codebases