Build from Source

Jump to bottom

Gabe Stocco edited this page Apr 18, 2024 · 10 revisions

This page describes the build processes for DevSkim version 0.8 or later.

DevSkim CLI

Requirements

An existing installation of the .NET 8.0 or later SDK.

How to Build

Via IDE

Download or clone a local copy of the DevSkim repository

git clone https://github.com/microsoft/DevSkim.git
Navigate to the DevSkim-DotNet folder

cd DevSkim\DevSkim-DotNet
Open Microsoft.DevSkim.sln in your IDE
Set Microsoft.DevSkim.CLI as your startup project
Run / build / debug as desired

Via Command Line

Download or clone a local copy of the DevSkim repository

git clone https://github.com/microsoft/DevSkim.git
Navigate to the Microsoft.DevSkim.CLI folder

cd DevSkim\DevSkim-DotNet\Microsoft.DevSkim.CLI
Build the CLI using dotnet

dotnet build
Run the devskim DLL using dotnet

dotnet bin\debug\net7.0\devskim.dll

Visual Studio Extension

Requirements

An existing installation of the .NET 8.0 or later SDK.
Visual Studio Developer Command Prompt

How to Build

Via IDE

Download or clone a local copy of the DevSkim repository

git clone https://github.com/microsoft/DevSkim.git
Navigate to the DevSkim-DotNet folder

cd DevSkim\DevSkim-DotNet
Open Microsoft.DevSkim.sln in your IDE
Set Microsoft.DevSkim.VisualStudio as your startup project
Run / build / debug as desired

Via Command Line

Run the Visual Studio Developer Command Prompt
Download or clone a local copy of the DevSkim repository

git clone https://github.com/microsoft/DevSkim.git
Navigate to the Microsoft.DevSkim.VisualStudio folder

cd DevSkim\DevSkim-DotNet\Microsoft.DevSkim.VisualStudio
Build the extension using msbuild

msbuild Microsoft.DevSkim.VisualStudio.csproj -restore
Extension package is located at:

Microsoft.DevSkim.VisualStudio\bin\Debug\Microsoft.DevSkim.VisualStudio.vsix

Installation

Run (or double-click) the VSIX package for guided installation

Visual Studio Code Extension

Requirements

An existing installation of the .NET 8.0 or later SDK
An existing installation of Node.js.

How to Build

Via VS Code

Download or clone a local copy of the DevSkim repository

git clone https://github.com/microsoft/DevSkim.git
Open the DevSkim folder in VS Code
Select Run and Debug (Ctrl + Shift + D)
Select Clean + Launch VSC Client
Start Debugging (F5)

Via Command Line

Download or clone a local copy of the DevSkim repository

git clone https://github.com/microsoft/DevSkim.git
Navigate to the DevSkim-VsCode-Plugin folder

cd DevSkim\DevSkim-VsCode-Plugin
Use npm to install dependencies

npm install
Run the extension packaging script to produce a VSIX package

npm run pack-ext
Extension package is located at:

DevSkim-VsCode-Plugin\vscode-devskim-0.8.55.vsix

Installation

Install via VS Code extension manager

-or-
Install via command line using the code utility provided by VS Code

code --install-extension vscode-devskim-0.8.55.vsix

References