|
| 1 | +# RAZ VS Code Extension - Installation Guide |
| 2 | + |
| 3 | +## Quick Installation |
| 4 | + |
| 5 | +The RAZ VS Code extension has been packaged with a simplified, cleaner UI for better user experience. |
| 6 | + |
| 7 | +### Installation Steps |
| 8 | + |
| 9 | +1. **Install the VSIX file:** |
| 10 | + ```bash |
| 11 | + code --install-extension raz-vscode-0.2.2.vsix |
| 12 | + ``` |
| 13 | + |
| 14 | +2. **Restart VS Code** to ensure the extension loads properly. |
| 15 | + |
| 16 | +3. **Open a Rust project** to activate the extension. |
| 17 | + |
| 18 | +## What's New & Fixed |
| 19 | + |
| 20 | +### Override Commands |
| 21 | +- ✅ **List All Overrides** - Shows picker to select project when multiple .raz directories exist |
| 22 | +- ✅ **Show Override Statistics** - Properly detects project context from active file or shows picker |
| 23 | +- ✅ **Clear Saved Overrides** - Shows picker to select which project to clear overrides from |
| 24 | + |
| 25 | +### Simplified Tree View |
| 26 | +- ✅ **Cleaner UI** - Less nesting, shows only what matters |
| 27 | +- ✅ **Direct Function Names** - Shows just the function name without file details |
| 28 | +- ✅ **One-Line Override Display** - Shows `▶ -- --test-threads=1` format |
| 29 | +- ✅ **Simple Interactions**: |
| 30 | + - **Click** the item to run with the override |
| 31 | + - **Right-click** → Edit to modify the override |
| 32 | +- ✅ **Workspace Aggregation** - Workspaces show all member crate overrides directly |
| 33 | + |
| 34 | +## Using the Simplified UI |
| 35 | + |
| 36 | +### Tree View Structure |
| 37 | +``` |
| 38 | +⚡ RAZ: OVERRIDES |
| 39 | + taxman (2 overrides) ← Workspace total count, not expandable |
| 40 | + > taxman-domain (1 override) ← Member crate, expandable |
| 41 | + v taxman (1 override) ← Member crate, expandable |
| 42 | + v test_create_transaction_simple |
| 43 | + ▶ -- --test-threads=1 |
| 44 | +``` |
| 45 | + |
| 46 | +### How to Use |
| 47 | +1. Click the ⚡ (RAZ) icon in the activity bar |
| 48 | +2. Expand projects to see function overrides |
| 49 | +3. Expand functions to see their override settings |
| 50 | +4. **Click** `▶ -- --test-threads=1` to run |
| 51 | +5. **Right-click** → Edit to modify the override |
| 52 | + |
| 53 | +### Key Improvements |
| 54 | +- **Flattened workspace structure** - Workspace shows total count, member crates as siblings |
| 55 | +- **No duplicate nesting** - Clean hierarchy without redundant folders |
| 56 | +- **Clean function names** - Just shows the function name |
| 57 | +- **Single action line** - Play button and args in one line |
| 58 | +- **Direct execution** - Click to run, right-click to edit |
| 59 | + |
| 60 | +## Configuration Hierarchy |
| 61 | + |
| 62 | +The extension supports hierarchical configuration: |
| 63 | +- **Project** (.raz in project root) - Highest priority |
| 64 | +- **Workspace** (.raz in workspace root) - Medium priority |
| 65 | +- **Global** (~/.raz) - Lowest priority |
| 66 | + |
| 67 | +## Tips |
| 68 | + |
| 69 | +- The `▶` indicates a runnable override |
| 70 | +- Hover over items to see tooltips with full details |
| 71 | +- The tree automatically refreshes when override files change |
| 72 | + |
| 73 | +## Troubleshooting |
| 74 | + |
| 75 | +If you don't see your overrides: |
| 76 | +1. Make sure you're in a Rust project with saved overrides |
| 77 | +2. Check that `.raz/overrides.toml` exists in your project |
| 78 | +3. Try refreshing the tree view with the refresh button |
| 79 | +4. Check the Output panel (View → Output → RAZ) for any errors |
| 80 | + |
| 81 | +## Need Help? |
| 82 | + |
| 83 | +- Check the [README](readme.md) for detailed usage instructions |
| 84 | +- Report issues at: https://github.com/codeitlikemiley/raz/issues |
0 commit comments