Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sboulema/NuGetMonitor

A Visual Studio extension that checks and notifies about available updates for the installed NuGet packages for the open solution.
https://github.com/sboulema/NuGetMonitor

Last synced: 7 days ago
JSON representation

A Visual Studio extension that checks and notifies about available updates for the installed NuGet packages for the open solution.

Host: GitHub
URL: https://github.com/sboulema/NuGetMonitor
Owner: sboulema
License: mit
Created: 2023-06-14T23:09:37.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-10-21T08:17:59.000Z (23 days ago)
Last Synced: 2024-10-21T10:46:39.136Z (23 days ago)
Language: C#
Size: 504 KB
Stars: 16
Watchers: 3
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # NuGet Monitor

A Visual Studio extension that checks and notifies about available updates

for the installed NuGet packages in the current solution.

[![Build Status](https://github.com/sboulema/NuGetMonitor/actions/workflows/workflow.yml/badge.svg)](https://github.com/sboulema/NuGetMonitor/actions/workflows/workflow.yml)

[![Sponsor](https://img.shields.io/badge/-Sponsor-fafbfc?logo=GitHub%20Sponsors)](https://github.com/sponsors/sboulema)

## Features

- Checks for updates, deprecations and vulnerabilities when a solution is opened

- Shows an info bar with the number of available updates, deprecations and vulnerabilities

- Shows an info bar with vulnerabilities found in transient packages

- Provides a package management tool window that gives an instant overview over all packages, with a lean and fast package update functionality

- Works with .NET Framework projects and with .NET projects using `PackageReference` items

## Supported Visual Studio versions

- Visual Studio 2022

## Installing

[Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=SamirBoulema.NuGetMonitor) [![Visual Studio Marketplace](https://img.shields.io/vscode-marketplace/v/SamirBoulema.NuGetMonitor.svg?style=flat)](https://marketplace.visualstudio.com/items?itemName=SamirBoulema.NuGetMonitor)

[GitHub Releases](https://github.com/sboulema/NuGetMonitor/releases)

[Open VSIX Gallery](https://www.vsixgallery.com/extension/NuGetMonitor.2a6fbffe-f3fd-4bf8-98cc-5ae2c833a1c7)

## Usage

### After a solution is loaded, available updates and possible issues are shown in the Solution Explorer

![InfoBar](art/Screenshot2.png)

Dependent on the size of the solution it may take some time until the info bars appear. 

---

### Package Manager

The package manager can be opened via the entry in the `Tools` menu.

![MenuEntry](art/MenuEntry.png)

The package manager shows all installed packages of the current solution. Updating a single package is just one click, multiple packages can be updated via the tool bar button after selecting the packages.

Compared to the original NuGet Package Manager updating packages is very fast, because the package version is instantly updated without validation against other packages - however version conflicts may show up only at the next build and have to be resolved manually.

![ToolWindow](art/ToolWindow.png)

Shared package references, e.g. in the `Directory.Build.props` file, are handled gracefully, and will not be replaced by `Update` entries in every project.

CentralPackageManagement (`PackageVersion` entries) are supported as well.

A justification property can be added to `PackageReference` or `PackageVersion` entries, to e.g. document why a reference is pinned and can't be updated

```xml

```

A mitigation element can be added to suppress warnings for transitive dependencies that can't be updated due to project limitations but have been evaluated to not affect the product security.

```xml

```

---

### Dependency Tree

This view allows to investigate how transitive dependencies are introduced into the projects.

It lists all transitive dependencies per project, and shows their ancestor tree, where the terminal bold entry is the package reference used in the project.

The context menu for every entry offers to copy ready made XML snippets for `PackageReference`, `PackageVersion` or `PackageMitigation` that can be directly inserted into the project file to fix transitive dependencies.

![DependencyTree](art/DependencyTree.png)

## Thanks

### AnushaG2201

A big thanks goes to [AnushaG2201](https://github.com/AnushaG2201)!

I was playing with the idea for this extension for quite a while but never figured out how I would create this extension.

That is until I saw the [Nuget-updates-notifier](https://marketplace.visualstudio.com/items?itemName=Anusha.NugetPackageUpdateNotifier) ([GitHub](https://github.com/AnushaG2201/Nuget-updates-notifier)) which gave me the remaining puzzle pieces, so that I could create my own version.

### tom-englert

A big thanks goes to [tom-englert](https://github.com/tom-englert)!

A massive improvement [PR](https://github.com/sboulema/NuGetMonitor/pull/4) really improved the quality of this extension.

## Links

[NuGet Client SDK / NuGet.Protocol](https://learn.microsoft.com/en-us/nuget/reference/nuget-client-sdk)

[Visual Studio Extensibility Cookbook - Notifications](https://www.vsixcookbook.com/recipes/notifications.html)

[Invoke the Manage NuGet Packages dialog programmatically](https://devblogs.microsoft.com/nuget/invoke-manage-nuget-packages-dialog-programmatically/)

[UpdatR packages](https://github.com/OskarKlintrot/UpdatR)