https://github.com/httpdss/vscode-struct
VSCode extension for STRUCT — generate and validate project structures from YAML files with autocompletion, schema support, and more.
https://github.com/httpdss/vscode-struct
automation boilerplate cli-tool developer-tools devops file-structure project-generator scaffolding schema struct vscode-extension yaml
Last synced: 6 months ago
JSON representation
VSCode extension for STRUCT — generate and validate project structures from YAML files with autocompletion, schema support, and more.
- Host: GitHub
- URL: https://github.com/httpdss/vscode-struct
- Owner: httpdss
- License: apache-2.0
- Created: 2025-07-30T19:27:41.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-07-31T14:13:11.000Z (6 months ago)
- Last Synced: 2025-08-10T03:44:33.048Z (6 months ago)
- Topics: automation, boilerplate, cli-tool, developer-tools, devops, file-structure, project-generator, scaffolding, schema, struct, vscode-extension, yaml
- Language: TypeScript
- Homepage: https://httpdss.github.io/struct/
- Size: 124 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Struct YAML Support for VS Code
A VS Code extension that provides enhanced support for struct YAML configuration files with schema validation and intelligent autocomplete.
## Features
- **Schema Validation**: Automatic validation of `*.struct.yaml` files using the official struct schema
- **Custom Schema Generation**: Generate custom schemas based on your struct configurations
- **Intelligent Autocomplete**: Get suggestions and validation while editing struct files
- **Configurable Struct Path**: Set custom path to your struct command executable
- **Custom Structures Support**: Configure path to custom structures for enhanced validation
## Configuration
### Extension Settings
This extension contributes the following settings:
- `struct.commandPath`: Path to the struct command executable (default: `struct`)
- `struct.customStructuresPath`: Path to custom structures directory (default: empty)
### Setting up the Extension
1. Install the extension
2. Configure the struct command path in VS Code settings:
- Open VS Code settings (Ctrl/Cmd + ,)
- Search for "struct"
- Set `struct.commandPath` to the path of your struct executable
- Optionally set `struct.customStructuresPath` to your custom structures directory
## Commands
- `Struct: Generate Custom Schema` - Generate a custom schema based on your struct configuration
- `Struct: Refresh Schema` - Refresh the schema validation
## Usage
1. Create or open a file with the `.struct.yaml` extension
2. The extension will automatically apply schema validation
3. If you have custom structures configured, use the "Generate Custom Schema" command to create enhanced validation
4. Enjoy intelligent autocomplete and validation while editing your struct files
## Requirements
- VS Code 1.74.0 or higher
- struct command-line tool (optional, for custom schema generation)
## Extension Settings
This extension contributes the following settings:
* `struct.commandPath`: Path to the struct command executable
* `struct.customStructuresPath`: Path to custom structures directory
## Known Issues
- Custom schema generation requires the struct command to be available in your system
- Schema validation is currently limited to `*.struct.yaml` files
## Release Notes
### 0.1.0
Initial release of Struct YAML Support extension:
- Basic schema validation for `*.struct.yaml` files
- Custom schema generation support
- Configurable struct command path
- Custom structures path configuration
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
MIT