VS Code extension that brings first-class support for Azure Service Fabric
application projects (.sfproj) — recognising the project, showing a
Solution-Explorer-style tree, validating manifests, building/packaging via
MSBuild, deploying to a connected cluster, attaching the .NET debugger to a
running service, and inspecting cluster diagnostic events.
Features
- Project recognition & tree — Auto-activates on workspaces containing
*.sfproj. The Service Fabric activity-bar view shows applications, service-manifest packages, code/config/data packages, endpoints, default services, parameters, publish profiles, startup-service parameters, StartupServices.xml, and scripts.
- Manifest authoring — XSD validation (via
redhat.vscode-xml), F12 navigation between manifests, custom diagnostics (parameter usage SFD002/SFD003, version drift SFD001, duplicates SFD004), and "Promote literal to parameter" code action.
- Build & package — MSBuild task provider with auto-discovered toolchain (
vswhere.exe or dotnet msbuild). Right-click .sfproj → Build / Rebuild / Clean / Package. NuGet restore runs automatically before each target via a three-strategy fallback (nuget.exe → MSBuild /t:Restore → in-process HTTPS download from api.nuget.org).
- Local cluster lifecycle — Start / Stop / Reset / Switch-mode commands for the SDK dev cluster. 1-node for fast inner loop, 5-node for failover and rolling-upgrade testing.
- Cluster connections — Local + remote (X.509 thumbprint) connections, persisted per-workspace, with status-bar health/node/app indicator.
- Deploy / Remove — Wraps the Service Fabric SDK PowerShell modules; pick a publish profile, watch logs stream live, error-aware.
- Scaffolding — Create New Application… produces the same project layout Visual Studio's Service Fabric Application template emits:
{Cloud,Local.1Node,Local.5Node} triads under ApplicationParameters/, PublishProfiles/, and StartupServiceParameters/, a top-level StartupServices.xml, a packages.config, and the verbatim VS Scripts/Deploy-FabricApplication.ps1. Add Service offers the full VS .NET Core (net10.0/9.0/8.0) / .NET Framework / Guest Executable matrix; Add / Remove Library Project scaffolds and unwires shared class libraries between services without polluting the SF application model.
- HTTPS scaffolding option — Add Service with an ASP.NET Core kind can also generate a second
<Endpoint Protocol="https">, dual-scheme launchSettings.json, and a Kestrel listener that binds both schemes. The bundled Trust ASP.NET Core Dev Certificate command wraps dotnet dev-certs https so the first F5 just works.
- Debug attach — Attach Debugger to Deployed Service… resolves the host PID via the SF gateway and attaches the .NET (coreclr) or .NET Framework (clr) debugger. A pre-flight check offers a one-click install of the C# extension when it's missing.
- Diagnostic Events webview — Polls
/EventsStore and renders cluster events in a sortable, refreshing panel.
- Bundled how-to guide — Run Service Fabric: Open Help Guide for an offline, end-to-end walkthrough of every feature, setting, command, and troubleshooting tip.
Requirements
- VS Code 1.90+
redhat.vscode-xml (declared as an extension dependency, installed automatically).- Windows for build / package / deploy / local-cluster lifecycle. Authoring features (tree, schemas, diagnostics, scaffolding) work on macOS / Linux.
- Visual Studio 2022 or Build Tools for VS 2022, with the Azure development workload + Service Fabric Tools component.
- For debug attach:
ms-dotnettools.csharp (or compatible CoreCLR debugger).
Get started
- Install the extension from the Marketplace (or
code --install-extension <path>.vsix).
- Open a folder containing a
*.sfproj.
- Run Service Fabric: Get Started for the in-product walkthrough, or jump straight in with Service Fabric: Connect to Local Cluster.
- For an end-to-end reference, run Service Fabric: Open Help Guide (also reachable from the book icon in the Service Fabric view title bar).
Documentation
- In-product: Service Fabric: Open Help Guide (HOWTO.md).
- Release notes: CHANGELOG.md.
Contributing
Issues and pull requests welcome — see CONTRIBUTING.md for development setup, project layout, and coding conventions.
Telemetry
This extension does not transmit telemetry. The optional serviceFabric.telemetry.enabled setting only logs structured events to the local Service Fabric output channel at debug verbosity, and is off by default. VS Code's global telemetry.telemetryLevel is also honored.
Disclaimer
This extension is an independent project and is not affiliated with or endorsed by Microsoft.
License
MIT
| |
