SF Metadata Tracker
Real-time Salesforce metadata sync status and code coverage for VS Code
Features •
Installation •
Usage •
Commands •
Configuration
Overview
SF Metadata Tracker provides real-time visibility into your Salesforce metadata sync status. Know instantly whether your local files match the org, who last modified them, and get comprehensive code coverage insights—all without leaving your editor.
Features
| Feature |
Description |
| Status Bar |
View sync status with last modified info |
| File Decorations |
Color-coded badges: 🟢 In Sync · 🟡 Modified · 🔵 New |
| Smart Caching |
Intelligent caching to minimize API calls |
| Background Scanning |
Automatic metadata scanning with progress indicator |
🧪 Code Coverage & Testing
| Feature |
Description |
| Coverage Panel |
Sidebar panel showing coverage for all Apex classes |
| Run All Tests |
Execute all local tests with real-time progress |
| Run Single Test |
Run tests for current file with detailed results |
| Coverage Highlighting |
Visual line-by-line coverage in editor |
| Export |
Export coverage to CSV or JSON |
☁️ Deploy & Retrieve
| Feature |
Description |
| Quick Deploy |
Deploy current file directly from VS Code |
| Quick Retrieve |
Retrieve latest version from org |
| Context Menus |
Right-click integration in Explorer and Editor |
| Org Management |
Authorize and switch between orgs |
| Type |
Extensions |
| Apex Classes |
.cls |
| Apex Triggers |
.trigger |
| Lightning Web Components |
.js, .html, .css |
| Aura Components |
.cmp, .app, .evt |
| Visualforce Pages |
.page |
| Visualforce Components |
.component |
| Flows |
.flow-meta.xml |
Installation
From VS Code Marketplace
- Open VS Code
- Press
Cmd+Shift+X (macOS) or Ctrl+Shift+X (Windows/Linux)
- Search for "SF Metadata Tracker"
- Click Install
→ Install from VS Code Marketplace
Prerequisites
- VS Code v1.61.0+
- Salesforce CLI (
sf) installed and in PATH
- Salesforce DX project with
sfdx-project.json
- Authenticated org connection
Usage
Quick Start
- Open a Salesforce DX project in VS Code
- Extension activates automatically when
sfdx-project.json is detected
- View sync status in status bar and file explorer
- Click status bar item for detailed info and quick actions
Status Bar
Click the status bar to view:
- Last modified by (with relative time)
- Created by (with relative time)
- Connected org information
- Quick actions: Deploy, Retrieve, Refresh
Code Coverage Panel
Find SF Code Coverage in the Explorer sidebar:
- View org-wide coverage summary
- Click any class to open with coverage highlighting
- Use toolbar to run tests, export, or refresh
Commands
Access via Command Palette (Cmd+Shift+P / Ctrl+Shift+P):
| Command |
Description |
| Show File Org Status |
Display detailed org status |
| Refresh File Status |
Refresh current file status |
| Refresh All File Status |
Clear cache and refresh all |
| Deploy Current File |
Deploy to connected org |
| Retrieve Current File |
Retrieve from org |
| Authorize Org |
Authorize a new org |
| Switch Default Org |
Switch to different org |
| Toggle Coverage Highlighting |
Show/hide coverage in editor |
| Refresh Code Coverage |
Refresh coverage data |
| Run Apex Tests |
Run tests for current class |
| Run All Local Tests |
Run all tests with progress |
| Export Code Coverage |
Export to CSV or JSON |
Configuration
Configure in VS Code Settings (Cmd+, / Ctrl+,):
| Setting |
Default |
Description |
sfMetadataTracker.showStatusBar |
true |
Show sync status in status bar |
sfMetadataTracker.showFileDecorations |
true |
Show decorations in Explorer |
sfMetadataTracker.cacheTTL |
60 |
Cache TTL in seconds |
sfMetadataTracker.showScanSummary |
true |
Show summary after scanning |
sfMetadataTracker.showCoverageStatus |
true |
Show coverage in status bar |
Troubleshooting
Extension not activating
- Ensure workspace contains
sfdx-project.json
- Verify Salesforce CLI:
sf --version
"No Org" or "Auth Expired" error
- Check default org:
sf org display
- Authenticate:
sf org login web
- Set default:
sf config set target-org <alias>
Status not updating
- Use "Refresh File Status" command
- Use "Refresh All File Status" to clear caches
Code coverage not showing
- Run tests in the org first
- Use "Refresh Code Coverage"
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
# Clone the repository
git clone https://github.com/Avinava/vscode-sf-metadata-tracker.git
# Install dependencies
yarn install
# Run linting
yarn lint
# Build
yarn build
Changelog
See CHANGELOG.md for version history.
Latest in v1.9.0:
- Run All Local Tests with real-time progress
- Export coverage to CSV/JSON
- Interactive Code Coverage Panel
License
MIT License - see LICENSE for details.
Built with ❤️ for the Salesforce developer community
Report Bug •
Request Feature
