ReSim VS Code Extension

The ReSim VS Code Extension provides intelligent code assistance for working with ReSim's metrics configuration and Python emit calls. Get real-time validation, smart autocompletion, and comprehensive documentation in your editor to streamline your ReSim development workflow.

Features

Smart YAML Configuration Support - Write ReSim metrics configurations with confidence using intelligent autocompletion for topic names, field types, and schema definitions. Real-time validation will catch errors as you type.

Python Validation - Automatically validates topics passed to your emit() function calls based on your configuration, ensuring data consistency and catching mismatches before runtime.

Rich Documentation on Hover - Get instant access to comprehensive documentation with examples and schema information by hovering over ReSim config elements.

Jump-to-Definition Navigation - Navigate from topics in your emit() calls directly to their corresponding topic definitions in your YAML configuration files.

Development Installation

git clone https://github.com/resim-ai/resim-vscode-extension.git
cd resim-vscode-extension
npm install
npm run package
# Install the generated .vsix file

System Requirements

• VS Code: Version 1.90.0 or higher
• Node.js: Version 16+ (for development only)
• Operating System: Windows, macOS, or Linux

Configuration

ReSim Project Structure

The extension automatically activates when it detects a ReSim project structure:

your-project/
├── .resim/
│   └── metrics/
│       └── config.yml (or config.yaml)
└── **/your-python-files.py

Troubleshooting

Extension Not Activating

• Ensure you have a .resim/metrics/config.{yml,yaml} file in your workspace
• Check the VS Code output panel (View → Output → ReSim) for error messages

Python Features Not Working

• Ensure you have Python files open in your workspace
• Check that tree-sitter initialization succeeded in the output panel

YAML Validation Issues

• Install the RedHat YAML extension for enhanced YAML features
• Verify your config file follows the expected schema

Performance Issues

• Large Python files will take longer to parse
• Check the ReSim output panel for performance warnings

Support

• Issues: GitHub Issues
• Documentation: ReSim Documentation
• Community: ReSim Community

Development

See CONTRIBUTING.md for development setup and contribution guidelines.