This Visual Studio Code extension provides visualizations for Salesforce metadata within your workspace. It helps developers quickly understand the composition and history of their projects.
Features
- Current Overview Tab:
- Displays the total count of analyzed metadata files.
- Shows separate counts and totals for "Code" components (Apex, LWC, Aura, VF) and "Configuration" components (Objects, Fields, Flows, Profiles, etc.).
- Presents a pie chart visualizing the overall split between Code and Configuration components.
- Provides separate breakdown sections for Code and Configuration components, each including:
- A detailed summary list with counts and percentages for each metadata type within that category.
- Filter controls to include/exclude specific metadata types (with counts > 0) from the category chart.
- A pie chart visualizing the distribution of the filtered metadata types within that category.
- History Tab:
- Allows selection of a specific metadata type (that has a defined base path, e.g., Classes, Objects, Flows).
- Allows selection of a start and end date.
- Generates a line chart showing the count of the selected metadata type over the specified time period based on Git commit history.
- Tooltip on history chart data points shows:
- Commit hash (shortened).
- Author of the commit.
- List of files of the selected type that were added in that specific commit.
- Deep Dependency View:
- Provides a multi-level, interactive dependency tree visualization of Salesforce metadata.
- Allows users to select a component (e.g., Apex Class, Apex Trigger, Custom Object, Flow) and explore its direct and indirect dependencies.
- Dynamically loads child nodes on demand when a node is expanded, ensuring fast initial loading and responsive exploration of complex dependency chains.
- Identifies cross-metadata type dependencies, such as:
- Apex Triggers/Classes calling other Apex Classes, Flows, or interacting with Custom Objects.
- Flows interacting with Custom Objects, invoking Apex, or calling Subflows.
- Custom Objects linking to Validation Rules, Apex Triggers, Flows, Workflows, and Process Builders defined on them.
- Workflows and Process Builders invoking Apex or other Flows.
- Features zoom in and zoom out capabilities for easy navigation of large dependency graphs.
- Configuration:
- Users can configure which metadata types are included in the analysis via VS Code settings (
Salesforce Metadata Visualizer > Included Types). This affects all summaries, charts, and filters.
- The settings page provides suggestions for available metadata types.
Requirements
- Git: The "History" tab functionality requires
git to be installed and accessible in your system's PATH, and the opened workspace must be a Git repository.
Extension Settings
This extension contributes the following settings:
sfdcMetadataVisualizer.includedTypes: An array of metadata type display names (e.g., "Apex Classes", "Custom Objects") to include in the analysis and visualization. Default includes most common types. The settings UI will provide suggestions based on all known types in the extension.
Known Issues
- Git History Path Accuracy: The history analysis relies on finding the correct base path for metadata types (e.g.,
force-app/main/default/classes). This might need adjustment if your project structure deviates significantly. It currently checks common paths (force-app/main/default/, src/) and the direct path from the root.
- Git History Performance: Analyzing history on very large repositories with long histories might take some time. The analysis currently samples commits to improve performance.
- Nested Metadata History: History tracking is currently focused on top-level metadata types defined with a
basePath and extension (e.g., Apex Classes, Custom Objects). Tracking deeply nested items like Custom Fields or Validation Rules historically is not yet implemented.
- Deep Dependency Performance: While the "Deep Dependency View" loads dependencies, there is a hard "Max Depth" limit of 5 levels.
Release Notes
1.1.1 (Initial Release - 2025-05-15)
- Initial Release of Salesforce Metadata Visualizer!
- Overview Tab:
- Visual breakdown of metadata into "Code" and "Configuration" categories.
- Pie chart showing the overall Code vs. Configuration split.
- Detailed summaries and filterable pie charts for each category (Code and Configuration).
- History Tab:
- Line chart to track the count of a selected metadata type over a user-defined date range using Git history.
- Tooltips on history data points display commit hash, author, and files of the selected type added in that commit.
- Settings:
- Configurable list of metadata types to include in the analysis, with suggestions in the settings UI.
- Visuals:
- Distinct color palettes for charts.
- Layout adjustments for better alignment and readability.
1.2.2 (Major Release - 2025-05-23)
- Bug Fixes
- Deep Dependency View:
- Provides a multi-level, interactive dependency tree visualization of Salesforce metadata.
- Allows users to select a component (e.g., Apex Class, Apex Trigger, Custom Object, Flow) and explore its direct and indirect dependencies.
- Dynamically loads child nodes on demand when a node is expanded, ensuring fast initial loading and responsive exploration of complex dependency chains.
Following extension guidelines
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
Working with Markdown
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
- Split the editor (
Cmd+\ on macOS or Ctrl+\ on Windows and Linux).
- Toggle preview (
Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux).
- Press
Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets.
Enjoy!
| |
