Visual Studio Plugin

Visual Studio Plugin

Create a Visual Studio project for the plug-in Open Visual Studio and open a new Class Library (.NET Framework) project using.NET Framework 4.6.2 The name used for the project will be the name of the assembly. This tutorial uses the name BasicPlugin. The Visual Studio Plugin adds a number of tasks to your project. The main tasks that you will use are the visualStudio, cleanVisualStudio and openVisualStudio tasks. The following diagram shows the relationships between tasks added by this plugin. Visual Studio Plugin default task graph. Visual Studio Live Share lets you collaboratively edit and debug any codebase with others in real time—each person working in their own familiar, personalized environment. To analyze all files, enable Visual Studio full solution analysis (see here) under the usual Visual Studio Analyze menu. Fine tune your rules SonarLint is integrated with Microsoft Code Analysis framework, so rules for C# and VB.NET can be fine-tuned in the. Ruleset file used by your project. You need to install the Visual Studio SDK in addition to Visual Studio in order to develop Visual Studio extensions. You can install the Visual Studio SDK as part of regular setup, or you can install it later on. For more information about installing the Visual Studio SDK, see Install the Visual Studio SDK.
Visual Studio Plug-ins
Visual Studio Plugins
Visual Studio Plugin For Qt
Visual Studio Plugin For Unity
Visual Studio Plugins For Unity
The Helix Plugin for Visual Studio (P4VS) is a fully compliant Visual Studio Integration Package. Built on P4API.NET for speed and stability, P4VS is available on 32-bit and is compatible with 64-bit Windows platforms.
P4VS - Helix Plugin for Visual StudioThe Helix Plugin for Visual Studio (P4VS) is the plugin for Helix Core –– version control by Perforce. It is tightly integrated with the Visual Studio environment, giving you:
Simplified development workflows.
Advanced file and branch visualization tools.
Built-in web code review.
Features & BenefitsThe Helix Plugin for Visual Studio (P4VS) provides seamless access to all the features of Helix Core within the Visual Studio IDE. P4VS is a fully-compliant Visual Studio solution for one-stop access to all the tools you need.
Native Support for Helix Core
With P4VS, all Helix Core version control features are directly accessible. Developers can easily check out, check in, and view file history.
Advanced Visualization Tools
Want to know who else is working on a file? Or know when a bug was first introduced? When you need more detail, you can use advanced tools like Revision Graph, Stream Graph, and Time-lapse View to get all the info. With P4VS, you don't need to waste your time switching contexts.
Simplified Workflows
Using Perforce Streams makes it easy for development teams to visualize how code flows. This is especially useful for projects with a lot of files, binaries, contributors, and changes. It offers built-in best practices for branching and merging.
Code Review Options
Capture work-in-progress and assign it to another developer for review within P4VS. Helix Swarm –– the code review tool that comes with Helix Core –– can facilitate code reviews, no matter the size of your team. Helix Swarm is both powerful and flexible helping teams ship quality software faster. You can create reviews for code and other assets before or after commits. And it can be customized to fit various workflows.
New Features in P4VSCodeLens Integration: P4VS now integrates with CodeLens in the Visual Studio editor. You can see what changes were made and by who right in the code. Bring up changelists and access Time-lapse View or File History to view more.
Enhanced Helix Swarm Integration: Swarm reviews can now be opened in the IDE by default.
Visual Studio Plug-insDocumentationTutorialContact Us | Perforce SoftwareRich PlantUML support for Visual Studio Code.
Donate by Paypal|Donate by AliPay|PlantUML Document
Notice 1Some sensitive config, like java, jar, are potentially utilized by attackers. The lastest release has disabled the workspace/work folder level settings of them by default. To enable, you have to explicitly execute the command PlantUML: Toggle Workspace Trust Flag to trust the workspace.
Thanks RyotaK for the report
Notice 2The server render is now very recommended by this extension, since it's much faster and much easier to setup, while the major weakness has been improved:
Enables POST method, you can now render very-large diagrams
The extension comes with a new include processor, you won't encounter include problems again.
To make sure you can benifit from this update, make sure your plantuml server enables POST support.
If not, like the official https://www.plantuml.com/plantuml, the extension falls back to use GET, and you may still encounter 414 URI Too Long errors. Setup your own server is recommended.
FeaturesPreview Diagram, Press Alt-D to start PlantUML preview.Auto update.
Zoom & scroll support.
Multi-Page Diagram support.
Instant preview, if diagram's been exported.
From local or server.
Snap to Border
Export DiagramsAt cursor, in current file, in whole workspace, in workspace selected.
Concurrent export.
Generate URLs.
Multi-Page Diagram support.
From local or server.
Image map (cmapx) support.
Editing SupportsFormat PlantUML code. (Deprecated)
All type syntax highlight.
All type snippets.
Basic auto completion & macro signature support
Symbol List support.
OthersMulti-root Workspace Support.
MarkDown integrating support. View Demo
Extracting source from images support.
Notice: If you use customize plantuml.jar, please update to the latest version to enable Multi-Page Diagram support. (Later than V1.2017.15)
Format PlantUML code is Deprecated. Don't depend on it, use it only when it works right. I had force disable it in auto-format cases (format on save).
Supported Formats*.wsd, *.pu, *.puml, *.plantuml, *.iuml
How to installLaunch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
ext install plantuml
RequirementsDepend on which render you choose, plugin has diffrerent requirements.
Requirements for PlantUMLServer renderA plantuml server. See Use PlantUML Server as render.
Requirements for Local renderIt's necessary to have following installed:
Java : Platform for PlantUML running.
Graphviz : PlantUML requires it to calculate positions in diagram.
Quick Install for MacQuick Install for WindowsFor windows user, majkinetor introduced a way to install plantuml and its dependencies easily. Run cmd.exe as Administrator, and run two commands as follow
Plugin has integrated a copy of 'plantuml.jar', you are good to go now. But if you want to use your own jar (maybe a newer version, or with many dependent jars), specify the jar location with setting plantuml.jar.

If you've installed java, but still prompts 'java not installed', please add java bin path to PATH environment variable.
Typical Files OrganizationDefault extension settings works for independent Plantuml projects.
If Plantuml files are only part of your project (as documetation), use plantuml.diagramsRoot and plantuml.exportOutDir to setting up the organization, for example:
You'll get export results like:
Include Files Search LogicLatest version has changed the include files search logic once again.It is possible to configure includepaths now in settings.json.
The new search order is as follows:
The folder of the rendered file
The includepaths as configured in settings.json
The diagramsRoot
The setting includeSearch is not needed anymore, since the folder of the plantuml file and the diagramsRoot are always both in the include path.
To new projects, it's recommended not to rely on diagramsRoot and configure all required includepaths explicitly.
Thanks anotherandi for the brilliant idea and implementation!
Preview DemosPreview page provides various zoom/pan actions and snap feature:
Zoom operations (since version 2.7.0):Zoom to select area
Pinch to zoom (TouchPad)
Click to zoom in, alt + click to zoom out
Ctrl + mouse scroll to zoom in/out
Middle mouse button click to toggle zoom
Zoom in / zoom out / toggle buttons of the controls bar.
Pan operations (since version 2.7.0):Right mouse button drag
Two-finger move to pan (TouchPad)
Mouse scroll
Snap to border (since v2.8.0):Scroll to most bottom/right/top/left, preview will snap to that border.
e.g. Snap to Bottom is useful while writing long activity diagrams, which helps you keep focus in the latest part in the bottom.
Auto update:

zoom & scroll:
Multi-Page View:
Export DemosExport diagram:
Generate URLsExtract Diagram Source

If you've installed java, but still prompts 'java not installed', please add java bin path to PATH environment variable.
Typical Files OrganizationDefault extension settings works for independent Plantuml projects.
If Plantuml files are only part of your project (as documetation), use plantuml.diagramsRoot and plantuml.exportOutDir to setting up the organization, for example:
You'll get export results like:
Include Files Search LogicLatest version has changed the include files search logic once again.It is possible to configure includepaths now in settings.json.
The new search order is as follows:
The folder of the rendered file
The includepaths as configured in settings.json
The diagramsRoot
The setting includeSearch is not needed anymore, since the folder of the plantuml file and the diagramsRoot are always both in the include path.
To new projects, it's recommended not to rely on diagramsRoot and configure all required includepaths explicitly.
Thanks anotherandi for the brilliant idea and implementation!
Preview DemosPreview page provides various zoom/pan actions and snap feature:
Zoom operations (since version 2.7.0):Zoom to select area
Pinch to zoom (TouchPad)
Click to zoom in, alt + click to zoom out
Ctrl + mouse scroll to zoom in/out
Middle mouse button click to toggle zoom
Zoom in / zoom out / toggle buttons of the controls bar.
Pan operations (since version 2.7.0):Right mouse button drag
Two-finger move to pan (TouchPad)
Mouse scroll
Snap to border (since v2.8.0):Scroll to most bottom/right/top/left, preview will snap to that border.
e.g. Snap to Bottom is useful while writing long activity diagrams, which helps you keep focus in the latest part in the bottom.
Auto update:
zoom & scroll:
Multi-Page View:
Export DemosExport diagram:
Generate URLsExtract Diagram SourceAbout FormatPlantUML formatter is disabled (since v2.8.3) if editor.formatOnSave is on.Because the formatter is not reliable enough according to user feedbacks.
About SnippetsThis plugin integrates all type diagram snippets. They are splitted into 9 sections:
diagram: snippets for general diagrams elements.
activity: snippets for activity diagrams.
class: snippets for class diagrams.
component: snippets for component diagrams.
state: snippets for state diagrams.
usecase: snippets for usecase diagrams.
sequence: snippets for sequence diagrams.
ui: snippets for salt diagrams.
egg: snippets for some funny diagrams, like sudoku, earth.
For exsample, type acife (short version) to trigge following snippet (activity➤if・else):
Visual Studio PluginsAbout Symbol List (List diagrams of file)Press Ctrl+Shift+O to list all diagrams in the file. You can name the diagram when diagram starts.
@startuml diagram namesudoku@enduml
About RenderPlugin supports two renders: Local and PlantUMLServer.
Local is the default and traditional way. If you care more about export speed, you should try PlantUMLServer.
Advantages and Disadvantages of PlantUMLServer RenderAdvantages:
15X times faster export and much quicker preview response.
Don't have to set local enviroments if you have a server in your team.
You don't need plantuml.exportConcurrency, because it's unlimited in concurrency.
Disadvantages:
~~Cannot render very-large diagrams (414 URI Too Long).~~
~~Cannot render diagrams with !include in it.~~
Less format support: png, svg, txt.
Some settings are not applicable: plantuml.jar, plantuml.commandArgs, plantuml.jarArgs.
Use PlantUML Server as RenderTo render very-large diagrams with include support, please make sure your plantuml server enables POST support.
If not, like the official https://www.plantuml.com/plantuml, the extension falls back to use GET, and you may still encounter 414 URI Too Long errors.
Setup your own server is recommended.
You may already have a PlantUML server in your team, find the server address, like: http://192.168.1.100:8080.
If don't have one, set up following the instructions, run with Docker is recommended. Find the server address, like: http://localhost:8080, or http://192.168.1.100:8080 which is ready for sharing to your team.
Open user setting, and configure like:
Multiple languages supportTranslations are welcome. lang.nls.json, package.nls.json
MarkDown integrating@startuml / @enduml is still recommended, so that PlantUML code in Markdown can be managed by other function of this plugin.
Extension SettingsThis extension contributes the following settings.
Render Select:
plantuml.render: Select diagram render for both export and preview.
PlantUMLServer Render Settings:
plantuml.server: PlantUML server to generate UML diagrams on-the-fly.
Local Render Settings:
plantuml.java: Java executable location.
plantuml.commandArgs: commandArgs allows you add command arguments to java command, such as -DPLANTUML_LIMIT_SIZE=8192.
plantuml.jar: Alternate plantuml.jar location. Leave it blank to use integrated jar.
plantuml.jarArgs: jarArgs allows you add arguments to plantuml.jar, such as -config plantuml.config.
plantuml.includepaths: Specifies the include paths besides source folder and the diagramsRoot.
Export Settings:
plantuml.diagramsRoot: Specifies where all diagram files located (relative to workspace folder).
plantuml.exportOutDir: Exported workspace diagrams will be organized in this directory (relative path to workspace folder).
plantuml.fileExtensions: File extensions that find to export. Especially in workspace settings, you may add your own extensions so as to export diagrams in source code files, like '.java'.
plantuml.exportFormat: format to export. default is not set, user may pick one format everytime exports. You can still set a format for it if you don't want to pick.
plantuml.exportSubFolder: export diagrams to a folder which has same name with host file.
plantuml.exportConcurrency: decides concurrency count when export multiple diagrams.
plantuml.exportMapFile: Determine whether export image map (.cmapx) file when export.
Preview Settings:
plantuml.previewAutoUpdate: Dedecides if automatically update the preview window.
URL Generating Settings:
plantuml.urlFormat: URL format. Leave it blank to pick format everytime you generate a URL.
plantuml.urlResult: URL result type. Simple URL or ready for MarkDown use.
Known IssuesPlease post and view issues on GitHub
ThanksTranslatorsJapanese: Kohei Arao, kannkyo
Tranditional Chinese: Alan Tsai
German: Fabian F.
French: Zepmanbc, FlorianKempenich
Danish: Mikkel O. Laursen
DonatorsVisual Studio Plugin For QtThanks for your encouragements!
Visual Studio Plugin For UnityClaus Appel, 三島木​一磨, 富吉​佑季, 黒田悦成, Jared Birdsall, Suleyman Cabir Ciplak, Malcolm Learner, Сысоев Максим, Gokan Kenichi, anb0s, Lawrence Yarian, Ahmad Ragab, 山田​暁通
Visual Studio Plugins For UnityEnjoy!