SF Preflight

Environment health checks and setup verification for Salesforce development in VS Code.

Features

• 🔍 Environment Health Check - Comprehensive check of your Salesforce development environment
• ⚙️ Explicit Project Setup - Creates recommended configuration files only when you run the setup command
• 📝 Spell Checker - Configures Code Spell Checker with Salesforce-specific dictionary
• ⚡ Smart Caching - Caches successful health checks for 24 hours to speed up startup
• ☕ Java Check - Verify Java installation and version (11+ required for Apex Language Server)
• 📦 Node.js Check - Verify Node.js installation and version (18+ recommended)
• ☁️ Salesforce CLI Check - Verify SF CLI installation and provide update guidance
• 🔌 SF CLI Plugins Check - Verify required plugins like sfdx-scanner and code-analyzer
• 📊 Status Bar - Quick visual indicator of environment health (green ✓, yellow ⚠, red ✗)

Recommended Setup

SF Preflight can create recommended Salesforce project configuration files:

• .prettierrc (Optimized for Apex/LWC)
• .prettierignore
• .editorconfig (Apex tab size: 2 spaces)
• .gitignore (Standard Salesforce ignore rules)
• .vscode/settings.json (Standard file exclusions)
• cspell.json (Salesforce dictionary configuration)

This behavior can be disabled or customized in Settings. By default, setup is explicit and does not create workspace files on project open. Run SF Preflight: Apply Recommended Setup when you want SF Preflight to create missing files. Existing files are respected during normal setup.

Configuration Templates

You can override the standard templates used for provisioning by editing these settings in your settings.json:

• sfPreflight.provisioning.templates.prettierrc (Object)
• sfPreflight.provisioning.templates.prettierignore (String)
• sfPreflight.provisioning.templates.editorConfig (String)
• sfPreflight.provisioning.templates.vscodeSettings (Object)

Re-provisioning

If you need to update your configuration files to the latest standards, you can force a re-provision:

1. Open Command Palette (Cmd+Shift+P / Ctrl+Shift+P)
2. Run SF Preflight: Force Re-provision Configuration
3. Confirm the warning dialog.

Note: This overwrites enabled config files (.prettierrc, .editorconfig, etc.) with the extension's templates, but creates timestamped backups first.

Status Bar

The extension shows your environment status in the status bar:

• ✓ Green - All checks passed

• ✓ Green (Cached) - Environment confirmed healthy (check skipped for performance)

• ⚠ Yellow - Warnings (e.g., non-critical missing plugins)

• ✗ Red - Issues detected that need attention

• ✗ Red - Issues detected that need attention

Clicking the status bar item opens a Quick Menu with options to:

• Run System Health Check
• Fix Environment Issues
• Apply Recommended Setup
• Force Re-provision Configuration
• Show Project Info
• Show Logs

Commands

All commands are available via the Command Palette (Cmd+Shift+P / Ctrl+Shift+P):

Settings

Installation

Install from the VS Code Marketplace or search for "SF Preflight" in VS Code Extensions.

License

MIT