Companion to StructKit. Schema validation and autocomplete for .structkit.yaml (legacy .struct.yaml is still supported). Install the CLI with pip install structkit. Star the core repo.
- Schema Validation: Automatic validation of
.structkit.yaml/*.structkit.yamlfiles (and legacy.struct.yaml/*.struct.yaml) using the official StructKit schema - Custom Schema Generation: Generate custom schemas based on your StructKit configurations
- Intelligent Autocomplete: Get suggestions and validation while editing StructKit files
- Configurable CLI Path: Set custom path to your
structkitcommand executable - Custom Structures Support: Configure path to custom structures for enhanced validation
Install the StructKit CLI:
pip install structkit- From Marketplace (coming soon): Search for "StructKit" in VS Code/Cursor extensions
- From VSIX: Download the
.vsixfile and install viacode --install-extension vscode-structkit-*.vsix
This extension contributes the following settings:
structkit.commandPath: Path to the structkit command executable (default:structkit)structkit.customStructuresPath: Path to custom structures directory (default: empty)
- Install the extension
- Install StructKit CLI:
pip install structkit - Configure the structkit command path in VS Code settings (optional):
- Open VS Code settings (Ctrl/Cmd + ,)
- Search for "structkit"
- Set
structkit.commandPathto the path of your structkit executable - Optionally set
structkit.customStructuresPathto your custom structures directory
StructKit: Generate Custom Schema- Generate a custom schema based on your StructKit configurationStructKit: Refresh Schema- Refresh the schema validation
- Create or open a file named
.structkit.yaml(or any*.structkit.yaml). Legacy.struct.yaml/*.struct.yamlfiles still work. - The extension will automatically apply schema validation
- If you have custom structures configured, use the "Generate Custom Schema" command to create enhanced validation
- Enjoy intelligent autocomplete and validation while editing your StructKit files
See example.structkit.yaml for a sample project file.
- VS Code or Cursor 1.74.0 or higher
- StructKit CLI:
pip install structkit(required for custom schema generation)
- Custom schema generation requires the
structkitcommand to be available in your system - Schema validation applies to
.structkit.yaml/*.structkit.yaml, with legacy.struct.yaml/*.struct.yamlstill recognized
- Recognize StructKit's default project file
.structkit.yaml/*.structkit.yaml(introduced in structkit v3.3.0) - Continue supporting legacy
.struct.yaml/*.struct.yaml - Rename the extension package to
vscode-structkit(Marketplace ID becomeskennethbelitzky.vscode-structkit)
Initial release of the official StructKit extension:
- Schema validation for
*.struct.yamlfiles using official StructKit schema - Custom schema generation support
- Configurable structkit command path
- Custom structures path configuration
- Support for VS Code and Cursor
Contributions are welcome! Please feel free to submit a Pull Request.
MIT