Visual Studio Code Extension

The DevSkim VS Code plugin is a Language Server Protocol Client that communicates with the DevSkim Language Server. The language server uses the standard C# DevSkim engine for scanning.

Running DevSkim in VS Code

The DevSkim VS Code plugin can be installed from the VS Code Extension Marketplace. In VS Code, launch the Quick Open bar (Ctrl + P), and run the following command:

ext install ms-cst-e.vscode-devskim

This will install the DevSkim plugin in:

• Windows: %USERPROFILE%.vscode\extensions\vscode-devskim
• Mac/Linux: $HOME/.vscode/extensions/vscode-devskim

Once installed, you can use the Options panel in VS Code to modify DevSkim settings including specifying custom rules.

Getting Started with Development

Setup

1. Install the Node
2. Clone the DevSkim repository
3. Navigate to the DevSkim-VSCode-Plugin folder from a command line, and install needed dependencies: npm install

Create VSIX Package

1. From the DevSkim-VSCode-Plugin folder run: npm run pack-ext

Debug

1. Open the DevSkim-VSCode-Plugin folder in VS Code
2. Use the Debug menu in VS code and select "Clean + Launch VSC Client"

Reference

• Language Client
• Language Server