NuGet.PackageManagement

Before the update

After applying the changes

Sources used for package restore.

Helper class for calling the RestoreCommand

Find all packages added to .

Find the list of parent projects which directly or indirectly reference the child project.

Supporting methods for restoring sets of projects that implement . This code is used by Visual Studio to execute restores for solutions that have mixtures of UWP project.json, packages.config, and PackageReference-type projects.

Restore a solution and cache the dg spec to context.

Restore a project without writing the lock file

Restore many projects without writing the lock file SourceRepositories(sources) is only used for the CachingSourceProvider, the project-specific sources will still be resolved in RestoreRunner.

Create a restore args.

An exception containing a generic rollback message for the user and additional log messages with specific information on what caused the rollback.

Additional log messages for the error list.

Create a PackageReferenceRollbackException

High level exception message. Log messages to be shown in the error list.

Context for Package Management

Source repository provider

VS solution manager

NuGet config settings

SourceControlManager provider

CommonOperations to openfile, and so on

Resolution context such as DependencyBehavior, IncludePrerelease and so on

Public constructor to create the resolution context

Determines the dependency behavior

Determines if prerelease may be included in the installation

Determines if unlisted packages may be included in installation

Determines the containts that are placed on package update selection with respect to the installed packages

Gathe cache containing cached packages that can be used across operations. Ex: Update-Package updates all packages across all projects, GatherCache stores the gathered packages and re-uses them across all sub operations.

Http source cache context which will be shared across operations.

Determines if dependencies should be uninstalled during package uninstall

Determines if the package should be uninstalled forcefully even if it may break the build

Internal version of the public IVsPackageInstallerProjectEvents

Event arguments for nuget batch events.

A unique ID for the operation.

The project name. Usually matches the project file name.

The path for the project getting updated. May be null in the scenarios where there's no project file.

Package project events relayed to the public IVsPackageInstallerProjectEvents.

Raised when batch processing of install/ uninstall packages starts at a project level

Raised when batch processing of install/ uninstall packages ends at a project level

Provider for the PackageEvents singleton

The event args of the ActionsExecuted event.

The list of actions that are executed.

Exposes methods which mark partially deleted packages and deletes them.

Gets the list of package directories that are still need to be deleted in the local package repository.

Checks for any package directories that are pending to be deleted and raises the event.

Marks package directory for future removal if it was not fully deleted during the normal uninstall process if the directory does not contain any added or modified files.

Attempts to remove marked package directories that were unable to be fully deleted during the original uninstall.

Occurs when it is detected that the one or more packages are marked for deletion in the current solution.

Occurs when it is detected that the packages are missing or restored for the current solution.

Occurs when it is detected that the assets file is missing.

PackageRestoredEvent which is raised after a package is restored.

PackageRestoredEvent which is raised if a package restore failed.

Get the packages in the solution given the .

Returns a list of package references and the corresponding project names on which each package is installed, alongwith a bool which determines if the package is missing

Get packages restore data for given package references.

Current solution directory Dictionary of package reference with project names List of packages restore data with missing package details.

Checks the current solution if there is any package missing.

Checks if something is listening to the event of missing assets and change the status

Restores the missing packages for the current solution.

Best use case is the restore button that shows up in the UI or powershell when certain packages are missing Returns true if atleast one package was restored.

Restores the package references if they are missing

This parameter is the list of package referneces mapped to the list of project names a package is installed on. This is most likely obtained by calling GetPackagesInSolutionAsync Best use case is when GetPackagesInSolutionAsync was already called, the result can be used in this method Returns true if at least one package is restored. Raised package restored failed event with the list of project names.

If 'Restored' is false, it means that the package was already restored If 'Restored' is true, the package was restored and successfully

Event raised after user actions are executed.

Gets the current open solution directory, can only be called from the main UI thread.

Returns true if the solution is open

Returns true if the solution is available to manage nuget packages. That is, if the solution is open and a solution file is available. For solutions with only BuildIntegratedProject(s), and a globalPackagesFolder which is not a relative path, it will return true, even if the solution file is not available.

Get the safe name of the specified which guarantees not to conflict with other projects.

Returns the simple name if there are no conflicts. Otherwise returns the unique name.

Gets the corresponding to the safe name passed in

nuGetProjectSafeName is the nuGetProject's unique name if one is available or its name. Returns the in this solution manager corresponding to the safe name passed in.

Fires ActionsExecuted event.

It ensure to completely load the solution before continue if it was loaded with DPL. That is, not all the projects were loaded when solution was open.

It's a quick check to know if NuGet supports any prokect of current solution without initializing whole VSSolutionManager.

Get the missing packages in the solution given the .

Returns a read-only dictionary of missing package references and the corresponding project names on which each missing package is installed.

Get packages restore data for given package references.

Current solution directory Dictionary of package reference with project names List of packages restore data with missing package details.

Restores missing packages for the entire solution

The static method which takes in all the possible parameters

Returns true if at least one of the packages needed to be restored and got restored Best use case is 'nuget.exe restore .sln' where there is no project loaded and there is no SolutionManager. The references are obtained by parsing of solution file and by using PackagesConfigReader. In this case, you don't construct an object of PackageRestoreManager, but just the NuGetPackageManager using constructor that does not need the SolutionManager, and, optionally register to events and/or specify the source repositories

ThrottledPackageRestoreAsync method throttles the number of tasks created to perform package restore in parallel The maximum number of parallel tasks that may be created can be specified via The method creates a ConcurrentQueue of passed in . And, creates a fixed number of tasks that dequeue from the ConcurrentQueue and perform package restore. So, this method should pre-populate the queue and must not enqueued to by other methods

This is the runner which dequeues package references from , and performs package restore Note that this method should only Dequeue from the concurrent queue and not Enqueue

ThrottledCopySatelliteFilesAsync method throttles the number of tasks created to perform copy satellite files in parallel The maximum number of parallel tasks that may be created can be specified via The method creates a ConcurrentQueue of passed in . And, creates a fixed number of tasks that dequeue from the ConcurrentQueue and perform copying of satellite files. So, this method should pre-populate the queue and must not enqueued to by other methods

This is the runner which dequeues package references from , and performs copying of satellite files Note that this method should only Dequeue from the concurrent queue and not Enqueue

Event arguments for event.

Gets the directories which are marked for deletion.

Creates a new instance of .

The directory paths that are marked for deletion.

Validates the compatibility of a installed packages for the given project type. This component should be used after packages have been downloaded to disk but have not yet been installed to the project. If an installed package is not compatibile with the given project, an exception is thrown. The checks performed by this class are based on package minimum client versions and package types.

Validates the compatibility of a multiple installed packages for the given project type.

The NuGet project. The type of the NuGet project determines the sorts or validations that are done. The path context used to find the installed packages. The project actions. The restore result generated during installation.

Asynchronously validates the compatibility of a single downloaded package.

The NuGet project. The type of the NuGet project determines the sorts or validations that are done. The identity of that package contained in the download result. The downloaded package. A cancellation token.. A task that represents the asynchronous operation. Thrown if is . Thrown if is . Thrown if is . Thrown if is cancelled.

Asynchronously validates the compatibility of a single downloaded package.

NuGetPackageManager orchestrates a nuget package operation such as an install or uninstall It is to be called by various NuGet Clients including the custom third-party ones

Event to be raised when batch processing of install/ uninstall packages starts at a project level

Event to be raised when batch processing of install/ uninstall packages ends at a project level

The telemetry service to use for telemetry events. The setter is exposed for test purposes.

To construct a NuGetPackageManager that does not need a SolutionManager like NuGet.exe

To construct a NuGetPackageManager with a mandatory SolutionManager lke VS

SourceRepositories for the user global package folder and all fallback package folders.

Installs the latest version of the given to NuGetProject and are used in the process.

Installs given to NuGetProject and are used in the process.

Gives the preview as a list of NuGetProjectActions that will be performed to install into and are used in the process.

Update Package logic specific to build integrated style NuGet projects

Update Package logic specific to classic style NuGet projects

The package dependency info for the given project. The project needs to be packages.config, otherwise returns an empty list.

The project is question cancellation token Whether to include the unresolved packages. The unresolved packages include packages that are not restored and cannot be found on disk.

Returns all installed packages in order of dependency. Packages with no dependencies come first.

Packages with unresolved dependencies are NOT returned since they are not valid.

Filter down the reinstall list to just the ones we need to reinstall (i.e. the dependencies)

A walk through the dependencies to collect the additional package identities that are involved in the current set of packages to be installed

Gives the preview as a list of NuGetProjectActions that will be performed to install into and are used in the process.

Check all sources in parallel to see if the package exists while respecting the order of the list. This is only used by PreviewInstall with DependencyBehavior.Ignore. Since, resolver gather is not used when dependencies are not used, we simply get the source repository using MetadataResource.Exists

Gives the preview as a list of NuGetProjectActions that will be performed to uninstall for many NuGetProjects.

Gives the preview as a list of NuGetProjectActions that will be performed to uninstall into and are used in the process.

Gives the preview as a list of that will be performed to uninstall into and are used in the process.

Executes the list of on list of , which is likely obtained by calling into is used in the process.

Executes the list of on , which is likely obtained by calling into is used in the process.

Run project actions for a build integrated project.

Run project actions for build integrated many projects.

Build a context for package given package id. The "successful" frameworks are the ones that contain the package and are not part of the failed list. The "unsuccessful" frameworks are the ones that never had the package or are part of the unsuccessful list.

Reads existing Package Source Mappings from settings and appends a new mapping for the and a glob "*" pattern for the . The intention is that Preview Restore can run and expect all newly installed packages to be source mapped to the new source.

If a new mapping was provided, returns all persisted mappings appended with the new mapping. Otherwise, null.

Run project actions for build integrated projects.

RestorePackage is only allowed on a folderNuGetProject. In most cases, one will simply use the packagesFolderPath from NuGetPackageManager to create a folderNuGetProject before calling into this method

Checks whether package exists in packages folder and verifies that nupkg and nuspec are present as specified by packageSaveMode

Checks if package that is installed in project is also installed in any other projects in the solution.

NuGetProjectAction

PackageIdentity on which the action is performed

Type of NuGetProjectAction. Install/Uninstall

For NuGetProjectActionType.Install, SourceRepository from which the package should be installed For NuGetProjectActionType.Uninstall, this will be null

NugetProject for which the action is created

Enum for the type of NuGetProjectAction

Install

Uninstall

Update

Abstracts the logic to get a package stream for a given package identity from a given source repository

Asynchronously returns a for a given package identity and enumerable of source repositories.

An enumerable of source repositories. A package identity. A package download context. A global packages folder path. A logger. A cancellation token. A task that represents the asynchronous operation. The task result () returns a instance. Thrown if is either or empty. Thrown if is either or empty. Thrown if is either or empty. Thrown if is either or empty. Thrown if is cancelled.

Asynchronously returns a for a given package identity and source repository.

A source repository. A package identity. A package download context. A global packages folder path. A logger. A cancellation token. A task that represents the asynchronous operation. The task result () returns a instance. Thrown if is either or empty. Thrown if is either or empty. Thrown if is either or empty. Thrown if is either or empty. Thrown if is cancelled.

Default MaxDegreeOfParallelism to use for restores and other threaded operations.

Default amount of time a source request can take before timing out. This includes both UNC shares and online sources.

Download all needed packages for install actions.

Log a message to indicate where each package is being downloaded from

True if the result came from the packages folder.

Not thread safe.

Package identity.

PackageSource for the download. This is null if the packages folder was used.

True if the download is complete.

Create a PreFetcher result for a downloaded package.

Create a PreFetcher result for a package in the packages folder.

A safe wait for the download task. Exceptions are caught and stored.

Ensure and retrieve the download result.

GatherCache contains cached results from DependencyInfoResource providers This class is for internal use or testing only.

Add a single package

Add the full list of versions for a package

Retrieve an exact version of a package

Retrieve all versions of a package id

Cache key for a package id and version

Cache key for a package id and all versions

The result of a cache look up. HasEntry determines if the query has already been made. If a result has zero packages HasEntry will be true, but Packages will be empty. If the query has not been done HasEntry will be false. This class is for internal use or testing only.

True if an entry has been added (including a result with zero packages). This will be false if the package has not been searched for in the source.

Cached packages

Project target framework

Primary sources - Primary targets must exist here.

All sources - used for dependencies

Packages folder

Target ids

Targets with an id and version

Already installed packages

If false dependencies from downgrades will be ignored.

Resolution context containing the GatherCache and DependencyBehavior.

Project context for logging

If true, missing primary targets will be ignored.

PackageSourceMapping section value from nuget.config file, if section doesn't exist then it's null.

Logging adapter

Throw if packages.config contains an AllowedVersions entry for the target, and no packages outside of that range have been found.

target package id entries from packages.config gathered packages

Throw if packages.config contains an AllowedVersions entry for the target, and no packages outside of that range have been found.

target package ids entries from packages.config gathered packages

Throw if packages.config contains a newer version of the package already

target package id entries from packages.config gathered packages

Helpers to reduce down the gathered package dependency info to the allowed set

Remove some of the prerelease packages in update scenarios

Remove all prerelease packages for stable targets

Remove all versions of a package id from the list, except for the target version

Keep only stable versions of a package

Clear out all versions less than the minimuim. This can be used to prevent downgrading

This is used in update scenarios to remove packages that are of the same Id but different version than the primartTargets

Maximum number of threads to use when gathering packages.

The value must be >= 1.

Timeout when waiting for source requests

Gather packages

Start tasks for queued requests and process finished tasks. This method will continue until at least 1 task has finished, and keep going until all queued requests have been started.

Retrieve already installed packages

Find the closure of required package ids

Retrieve results from completed tasks

Load up to the MaxThread count

Retrieve the packages from the cache or source

Call the DependencyInfoResource safely

Get the current request id number, and increment it for the next count

Holds a Source and DependencyInfoResource

Request info

Contains the original request along with the resulting packages.

A strongly-typed resource class, for looking up localized strings, etc.

Returns the cached ResourceManager instance used by this class.

Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.

Looks up a localized string similar to Added package '{0}' to folder '{1}'.

Looks up a localized string similar to Added package '{0}' to folder '{1}' from source '{2}'.

Looks up a localized string similar to Added package '{0}' to '{1}'.

Looks up a localized string similar to Adding package '{0}' to folder '{1}'.

Looks up a localized string similar to Adding package '{0}', which only has dependencies, to project '{1}'..

Looks up a localized string similar to Adding package '{0}', which only has tools group, to project '{1}'.

Looks up a localized string similar to Argument cannot be null or empty.

Looks up a localized string similar to Attempting to gather dependency information for package '{0}' with respect to project '{1}', targeting '{2}'.

Looks up a localized string similar to Attempting to gather dependency information for multiple packages with respect to project '{0}', targeting '{1}'.

Looks up a localized string similar to Attempting to resolve dependencies for package '{0}' with DependencyBehavior '{1}'.

Looks up a localized string similar to Attempting to resolve dependencies for multiple packages..

Looks up a localized string similar to Added file '{0}'..

Looks up a localized string similar to Added file '{0}' to folder '{1}'..

Looks up a localized string similar to Removed file '{0}'..

Looks up a localized string similar to Removed file '{0}' from folder '{1}'..

Looks up a localized string similar to Removed folder '{0}'..

Looks up a localized string similar to >> {0} are being added from '{1}'{2}.

Looks up a localized string similar to For adding package '{0}' to project '{1}' that targets '{2}'..

Looks up a localized string similar to Dependency '{0}' has invalid version specification..

Looks up a localized string similar to Cannot download packages from '{0}'..

Looks up a localized string similar to Package stream for '{0}' cannot be found at '{1}'..

Looks up a localized string similar to Directory {0} does not exist..

Looks up a localized string similar to File {0} does not exist..

Looks up a localized string similar to You are running the '{0}' operation with an 'HTTP' source: {1}. NuGet requires HTTPS sources. To use an HTTP source, you must explicitly set 'allowInsecureConnections' to true in your NuGet.Config file. Refer to https://aka.ms/nuget-https-everywhere for more information..

Looks up a localized string similar to Invalid restore input where RestorePackagesWithLockFile property is set to false but a packages lock file exists at {0}..

Looks up a localized string similar to Package content hash validation failed for {0}. The package is different than the last restore..

Looks up a localized string similar to The packages lock file is inconsistent with the project dependencies so restore can't be run in locked mode. Run restore without using restore locked mode to update the lock file..

Looks up a localized string similar to Error occurred while getting package vulnerability data: {0}.

Looks up a localized string similar to An error occurred while reading file '{0}': {1}.

Looks up a localized string similar to An error occurred while writing file '{0}': {1}.

Looks up a localized string similar to Exception '{0}' thrown when trying to add source '{1}'. Please verify all your online package sources are available..

Looks up a localized string similar to File '{0}' already exists in project '{1}'. Do you want to overwrite it?.

Looks up a localized string similar to Found package '{0} {1}' in '{2}'..

Looks up a localized string similar to Gathering dependency information took {0}.

Looks up a localized string similar to Overwriting existing file '{0}'...

Looks up a localized string similar to Unable to determine the project name for '{0}'..

Looks up a localized string similar to Package '{0}' has multiple package types, which is not supported..

Looks up a localized string similar to Already referencing a newer version of '{0}'...

Looks up a localized string similar to No latest version found for '{0}' for the given source repositories and resolution context.

Looks up a localized string similar to No packages were found in packages.config for project '{0}'..

Looks up a localized string similar to No package updates are available from the current package source for project '{0}'..

Looks up a localized string similar to There are no new updates available..

Looks up a localized string similar to Executing nuget actions took {0}.

Looks up a localized string similar to Package '{0}' already exists in folder '{1}'.

Looks up a localized string similar to Package '{0}' already exists in '{1}'.

Looks up a localized string similar to Package '{0}' already exists in project '{1}'.

Looks up a localized string similar to Getting package '{0}' from source '{1}' was cancelled..

Looks up a localized string similar to Package '{0}' could not be installed.

Looks up a localized string similar to Package '{0}' does not exist in folder '{1}'.

Looks up a localized string similar to Package '{0}' does not exist in project '{1}'.

Looks up a localized string similar to Package '{0}' does not exists in '{1}'.

Looks up a localized string similar to Unable to uninstall '{0}' because '{1}' depends on it..

Looks up a localized string similar to Unable to uninstall '{0}' because '{1}' depend on it..

Looks up a localized string similar to Package '{0}' is not found.

Looks up a localized string similar to Package '{0}' is not found in the following primary source(s): '{1}'. Please verify all your online package sources are available (OR) package id, version are specified correctly..

Looks up a localized string similar to Package '{0}' is not found on source '{1}'..

Looks up a localized string similar to Unable to resolve '{0}'. An additional constraint '{1}' defined in {2} prevents this operation..

Looks up a localized string similar to Applying constraint '{0}' defined in '{1}'..

Looks up a localized string similar to Packages could not be installed.

Looks up a localized string similar to Package source mapping matches found for package ID '{0}' are: '{1}'.

Looks up a localized string similar to Package source mapping match not found for package ID '{0}'.

Looks up a localized string similar to Package stream should be seekable.

Looks up a localized string similar to Package '{0}' to be uninstalled could not be found in project '{1}'.

Looks up a localized string similar to Parameter cannot be zero or negative.

Looks up a localized string similar to The operation failed as details for project {0} could not be loaded..

Looks up a localized string similar to '{0}' cannot be null..

Looks up a localized string similar to Removed package '{0}' from folder '{1}'.

Looks up a localized string similar to Removed package '{0}' from '{1}'.

Looks up a localized string similar to Removing package '{0}' from folder '{1}'.

Looks up a localized string similar to Resolution was successful but resulted in no action.

Looks up a localized string similar to Resolved actions to install package '{0}'.

Looks up a localized string similar to Resolved actions to uninstall package '{0}'.

Looks up a localized string similar to Resolving actions install multiple packages.

Looks up a localized string similar to Resolving actions to install package '{0}'.

Looks up a localized string similar to Resolving actions to uninstall package '{0}'.

Looks up a localized string similar to Package restore failed. Rolling back package changes for '{0}'..

Looks up a localized string similar to Restoring NuGet package {0}..

Looks up a localized string similar to Retrieving package '{0} {1}' from '{2}'..

Looks up a localized string similar to Signed package validation failed with multiple errors:{0}.

Looks up a localized string similar to Solution is not opened or not saved. Please ensure you have an open and saved solution..

Looks up a localized string similar to Uninstall is not supported when SolutionManager is not available.

Looks up a localized string similar to Successfully installed '{0}' to {1}.

Looks up a localized string similar to Successfully uninstalled '{0}' from {1}.

Looks up a localized string similar to Could not install package '{0}'. You are trying to install this package into a project that targets '{1}', but the package does not contain any assembly references or content files that are compatible with that framework. For more information, contact the package author..

Looks up a localized string similar to Either should have value in {0} for {1} or {2} & {3}..

Looks up a localized string similar to Unable to gather dependency information for package '{0}'.

Looks up a localized string similar to Unable to gather dependency information for multiple packages.

Looks up a localized string similar to Unable to gather package '{0}' from source '{1}'. Please verify all your online package sources are available. .

Looks up a localized string similar to Unable to resolve dependencies for package '{0}' with DependencyBehavior '{1}'.

Looks up a localized string similar to Unable to resolve dependencies for multiple packages.

Looks up a localized string similar to Unable to find package '{0}'.

Looks up a localized string similar to Unable to find version '{1}' of package '{0}'..

Looks up a localized string similar to Package '{0}' has a package type '{1}' that is not supported by project '{2}'..

Looks up a localized string similar to Audit source '{0}' did not provide any vulnerability data..

Looks up a localized string similar to Directory '{0}' is not empty. Skipping....

Looks up a localized string similar to Error finding repository for '{0}': {1}.

Looks up a localized string similar to '{0}' already exists. Skipping....

Looks up a localized string similar to Skipping '{0}' because it was modified..

Looks up a localized string similar to Package '{0}' {1} has a known {2} severity vulnerability, {3}.

Looks up a localized string similar to Install failed. Rolling back....

Looks up a localized string similar to An error occurred while applying transformation to '{0}' in project '{1}'.

Base class to generate telemetry data for nuget operations like install, update or restore.

Telemetry event data for nuget operations like install, update, or uninstall.

This class contains telemetry events name and properties name.

Converts an IAssetsLogMessage into a RestoreLogMessage. This is needed when an IAssetsLogMessage needs to be logged and loggers do not have visibility to IAssetsLogMessage.

IAssetsLogMessage to be converted. RestoreLogMessage equivalent to the IAssetsLogMessage.

Generic EventArg class for NuGet.

Class type of the argument Arg.

Argument data of the EventArg.

Constructor for creating NuGetEventArgs object.

Argument to NuGetEventArgs of type T.

Returns package dependency info for the given package identities in the given resource. It returns null if any protocol errors occur. For example, the feed is not accessible.

A collection of to get info for. Framework for determining the dependency groups of packages The resource to fetch dependency info from. Could be http/file feed/global packages folder/solution packages folder. Caching context. Only really applicable when the dependency info resource is http based. Whether to include unresolved packages in the list. If true, the unresolved packages will have an empty dependencies collection. logger cancellation token A collection of , null if a protocol exception happens.

Return the packages from a list that have a dependency on a specific package (id and version).

Given generates a collection of with the dependants populated correctly.

A collection of

Static class to help get PackagesFolderPath

Static class for UriHelper

Open external link

Determine if Http Source via Uri.TryCreate()

Determine if active package source is http source

Determine if source is http source

Determine is any source is local source

Determine if any source is available

Information used by when installing a package.

Shows the frameworks for which a preview restore operation was successful. Only use it in case of single package install case, and only for CpsPackageReference projects.

Shows the frameworks for which a preview restore operation was unsuccessful. Only use it in case of single package install case, and only for CpsPackageReference projects.

A mapping to allow the original framework string to fetched. This is important because MSBuild target framework evaluation depends on the target framework string matching exactly.

Indicates that all packages are suspected to be conditionally installed. In particular, a package is installed to all frameworks, but it is expected to use the conditional updating/unisntalling APIs. Indicators of packages being conditional is that a package contains different versions in different frameworks. This value is only relevant when is empty, and contains all frameworks.

Define transitive behavior for each package dependency for the current project.

Define what all sections of the current package to include in this project.

Extends PackageReference to include the original LibraryDependency data.

LibraryDependency from the project.

Create a PackageReference based on a LibraryDependency.

Full PackageReference metadata.

Create a PackageReference based on a LibraryDependency.

Full PackageReference metadata. Package installed.

Convert range to a PackageIdentity

Get allowed version range.

Unique name to dg

Unique name to PackageSpec

Cache for direct project references of a project

Logger

Internal version of the public IVsPackageInstallerEvents

Default constructor for events where no info is known

Package identity

Folder path of the package

Project where the action occurred

Package events relayed to the public IVsPackageInstallerEvents

Raised when a package is about to be installed into the current solution.

Raised after a package has been installed into the current solution.

Raised when a package is about to be uninstalled from the current solution.

Raised after a package has been uninstalled from the current solution.

Raised after a package has been installed into a project within the current solution.

Raised after a package has been uninstalled from a project within the current solution.

Provider for the PackageEvents singleton

Represents a package file transformer.

Asynchronously transforms a file.

A stream task factory. A path to the file to be transformed. The project where this change is taking place. A cancellation token. A task that represents the asynchronous operation. Thrown if is . Thrown if is . Thrown if is cancelled.

Asynchronously reverses the transform on the targetPath, using all the potential source of change.

A factory for accessing the file to be reverted from the nupkg being uninstalled. A path to the file to be reverted. Other files in other packages that may have changed the . The project where this change is taking place. A cancellation token. A task that represents the asynchronous operation. Thrown if is . Thrown if is . Thrown if is . Thrown if is cancelled.

Simple token replacement system for content files.

Asynchronously transforms a file.

Asynchronously reverses the transform on the targetPath, using all the potential source of change.

An XDT project file transformer.

Asynchronously transforms a file.

Asynchronously reverses the transform on the targetPath, using all the potential source of change.

An XML project file transformer.

Initializes a new class.

A dictionary of XML node names to node actions. Thrown if is .

Asynchronously transforms a file.

Asynchronously reverses the transform on the targetPath, using all the potential source of change.

Represents the interface necessary for adding a project to a -based restore. This interface has logic for creating the as well as for detecting no-op cases where a restore is not necessary.

Gets the path to the MSBuild project file. This is an absolute path.

Project specs related to this project. This must include the project's own spec, and may optionally include more specs to restore such as tools.

Comprises of the various client context such as logging, fileconflictaction

Logs a message for the given project context

Logs an error for the given project context

Logs an error or warning for the given project context

Resolves a file conflict for the given project context

The original packages.config. This is set by package management before the actions are executed.

ILogger -> INuGetProjectContext

MessageLevel

Information

Warning

Debug only

Error

Extension methods for .

Convert to .

Message level. Corresponding log level.

Enum for the type of NuGetAction

Install

Uninstall

Reinstall

Update

UpdateAll

A NuGet integrated MSBuild project.k These projects contain a project.json or package references in CSProj

Project name

Returns the path to the assets file or the lock file. Throws an exception if the assets file path cannot be determined.

Returns the path to the assets file or the lock file. Returns null if the assets file path cannot be determined.

Add specified file to Project system

file to be added

A NuGet aware project system

A NuGet integrated MSBuild project.k These projects contain a project.json

Project.json based project system.

Path to project.json. Path to the msbuild project file.

project.json path

Project name

Uninstall a package from the config file.

Null-object with no-op implementation of project services.

This class represents a NuGetProject based on a folder such as packages folder on a VisualStudio solution

Gets the folder project's root path.

Initializes a new class.

The folder project root path. Thrown if is .

Initializes a new class.

The folder project root path. A package path resolver. Thrown if is . Thrown if is .

Initializes a new class.

The folder project root path. A package path resolver. Project target framework. Thrown if is . Thrown if is . Thrown if is .

Asynchronously gets installed packages.

A cancellation token. A task that represents the asynchronous operation. The task result () returns an .

Asynchronously installs a package.

A package identity. A download resource result. A NuGet project context. A cancellation token. A task that represents the asynchronous operation. The task result () returns a indication successfulness of the operation. Thrown if is . Thrown if is . Thrown if is . Thrown if the package stream for is not seekable.

Asynchronously uninstalls a package.

A package identity. A NuGet project context. A cancellation token. A task that represents the asynchronous operation. The task result () returns a indication successfulness of the operation.

Determines if a package is installed based on the presence of a .nupkg file.

A package identity. A flag indicating whether or not the package is installed. Thrown if is .

Determines if a package is installed based on the provided package save mode.

A package identity. A package save mode. A flag indicating whether or not the package is installed. Thrown if is .

Determines if a manifest is installed.

A package identity. A flag indicating whether or not the package is installed. Thrown if is .

Determines if a manifest is installed.

A package identity. A flag indicating whether or not the package is installed. Thrown if is .

Asynchronously copies satellite files.

A package identity. A NuGet project context. A cancellation token. A task that represents the asynchronous operation. The task result () returns a indication successfulness of the operation. Thrown if is . Thrown if is . Thrown if is cancelled.

Gets the package .nupkg file path if it exists; otherwise, .

A package identity. The package .nupkg file path if it exists; otherwise, . Thrown if is .

Gets the package .nuspec file path if it exists; otherwise, .

A package identity. The package .nuspec file path if it exists; otherwise, . Thrown if is .

Gets the package download marker file path if it exists; otherwise, .

A package identity. The package download marker file path if it exists; otherwise, . Thrown if is .

Gets the package directory path if the package exists; otherwise, .

A package identity. The package directory path if the package exists; otherwise, . Thrown if is .

Asynchronously deletes a package.

Method called when adding an assembly reference to the project.

Physical path to the assembly file relative to the project root.

Adds an assembly reference to a framework assembly (one in the GAC).

name of the assembly

This method can be called multiple times during a batch operation in between a single BeginProcessingAsync/EndProcessingAsync calls.

a list of files being changed.

Returns the list of full paths of the files in the project that match the file name.

the file name The list of full paths. We should combine GetFiles & GetFullPaths into one method.

Returns the directories under the directory .

The directory under which to search for subdirectories. The list of subdirectories in relative path.

Provides an API to a collection of scoped services, such as - project references - assembly references - project capabilities - binding redirects - script executor

Service to query project system capabilities.

Service providing read-only access to references.

Service to control references.

Service providing project system generic functionality.

Service to execute package scripts.

A service API providing methods of executing package scripts for the underlying project.

Executes a package script in the project's context.

Package id Package install path Script path relative to the package install path Project context Flag to control error handling A cancellation token

Executes init.ps1 package script in the project's context.

Package id Package files location Project context Flag to control error handling A cancellation token true if succeeded, otherwise - false.

Represents an API providing different capabilities exposed by a project system

Represents an API providing read-only access to references as exposed by the underlying project system.

Returns a collection of package references in associated project.

Target framework for evaluation. A cancellation token. Collection of package references as Thrown when the project system doesn't support package references. A caller should verify project system's capabilities before calling this method.

Returns a collection of project references in the associated project.

Logger instance A cancellation token.

Returns a collection of items of the specified item type name.

A service API providing methods of altering references as exposed by the underlying project system.

Adds a new package reference or updates the existing one.

A package reference with metadata. A cancellation token. Thrown when the project system doesn't support package references. A caller should verify project system's capabilities before calling this method.

Removes a package reference from a legacy CSProj project

Name of a package to remove from project Thrown when the project system doesn't support package references. A caller should verify project system's capabilities before calling this method.

Represents generic service API as provided by a project system.

Saves the underlying project.

Cancellation token Completion task

This class represents a NuGetProject based on a .NET project. This also contains an instance of a FolderNuGetProject

Event to be raised while installing a package

Event to be raised while added references to project

Event to be raised while removed references from project

This installs a package into the NuGetProject using the passed in should be seekable

Returns false if the package was already present in the NuGetProject. On successful installation, returns true

This uninstalls the package from the NuGetProject, if found

Returns false if the package was not found. On successful uninstallation, returns true

GetInstalledPackages will be used by Dependency Resolver and more

Get metadata value, or return null if it doesn't exist.

This static helper method returns the unique name on the project if present Otherwise, returns the name. If name is not present, it will throw

The name of the project, e.g. "ConsoleApplication1"

The name of the project, relative to the solution. e.g. "src\ConsoleApplication1"

Used by Project K projects

Represents a NuGet project as represented by packages.config

Represents the full path to "packages.config"

Represents the full path to "packages.'projectName'.config"

Checks if there is a packages.config or packages.'projectName'.config file in the current project.

Retrieve the packages.config XML. This will return null if the file does not exist.

Collection of constants representing project build property names.

Collection of constants representing project item properties names.

Collection of constants representing project items names.

CreateFile does the following Marks the file for edit if it already exists Calls File.Create which creates a file or opens it if already exists Marks the file for add if it was just created It will perform necessary operations such as undoing pending changes and so on as appropriate

Marks the files for addition It will perform necessary operations such as undoing pending changes and so on as appropriate

Marks the files for deletion It will perform necessary operations such as undoing pending changes and so on as appropriate

Determines if the packages folder is bound to SourceControl If so, files added to packages folder must be checked-in to SourceControl

Utilities for project.json

Orders all package dependencies in a project. Project must be restored.

Read lock file

Lock file dependencies - packages only

Get ordered dependencies from the lock file

Creates a file, and adds it to source control.

Root folder. Relative path in the root folder. the project context. A writeable filestream.

Creates a file, and adds it to source control.

Full path to the suggest file. A writeable filestream.

Creates a file, but doesn't add it to source control

Full path to the suggest file. A writeable filestream.

Determines if the contents of a file and stream are equal.

The path to a file. A stream task factory. if contents are equal; otherwise, . Thrown if is either or an empty string. Thrown if is .

Asynchronously determines if the contents of a file and stream are equal.

The path to a file. A stream task factory. A task that represents the asynchronous operation. The task result () returns a which is if contents are equal; otherwise, . Thrown if is either or an empty string. Thrown if is .

project.json utils

Read dependencies from a project.json file

Convert a dependency entry into an id and version range

Add a dependency to a project.json file

Remove a dependency from a project.json file

Retrieve the NuGetFrameworks under frameworks

Add the specified framework to JSON object

Clear all frameworks from the JSON object

Sort child properties

Filter out invalid package items and replace the directory separator with the correct slash for the current OS.

If the group is null or contains only only _._ this method will return the same group.

Compare the content of the two streams of data, ingoring the content within the NUGET: BEGIN LICENSE TEXT and NUGET: END LICENSE TEXCT markers.

First stream Second stream which MUST be a seekable stream. true if the two streams are considered equal.

Read the specified stream and return all lines, but ignoring those within the NUGET: BEGIN LICENSE TEXT and NUGET: END LICENSE TEXT markers, case-insenstively.

Compares two enumerables for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.

The type of the list The type of the sorting key This list The other list The function to extract the key from each item in the list An optional comparer for comparing keys An optional comparer for sequences

Compares two collections for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.

Compares two lists for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.

Compares two sequence for equality, allowing either sequence to be null. If one is null, both have to be null for equality.

Compares two collections for equality, allowing either collection to be null. If one is null, both have to be null for equality.

Compares two lists for equality, allowing either list to be null. If one is null, both have to be null for equality.

Compares two sets for equality, allowing either sequence to be null. If one is null, both have to be null for equality.

Determines if the current string contains a value equal "false". Leading and trailing whitespace are trimmed and the comparison is case-insensitive

The string to compare. if the current string is equal to a value of "false", otherwise .

Hash code creator, based on the original NuGet hash code combiner/ASP hash code combiner implementations

Create a unique hash code for the given set of items

Return the enumerable as a List of T, copying if required. Optimized for common case where it is an List of T. Avoid mutating the return value.

https://aspnetwebstack.codeplex.com/SourceControl/latest#src/Common/CollectionExtensions.cs

Return the ISet as a HashSet of T, copying if required. Optimized for common case where it is a HashSet of T. Avoid mutating the return value.

Helper function to append an to a . Calling directly causes an allocation by first converting the to a string and then appending that result:


             public StringBuilder Append(int value)
             {
                 return Append(value.ToString(CultureInfo.CurrentCulture));
             }

Note that this uses the current culture to do the conversion while does not do any cultural sensitive conversion.

The to append to. The to append.

Creates a new from a file.

The complete file path to be read into a new . An that contains the contents of the specified file.

Creates a new from a file. Optionally, whitespace can be preserved.

The complete file path to be read into a new . A set of . An that contains the contents of the specified file.

Creates a new from a stream.

The stream that contains the XML data. An that contains the contents of the specified stream.

Creates a new System.Xml.Linq.XDocument from a stream. Optionally, whitespace can be preserved.

The stream that contains the XML data. A set of . An that contains the contents of the specified stream.

Converts the name to a valid XML local name, if it is invalid.

The name to be encoded. The encoded name.

Creates an instance of with safe settings A set of .

Avoids allocating an enumerator when enumerating an .

Returns a struct-based enumerator that avoids heap allocation during enumeration. If the underlying type is then this method will delegate to , otherwise the collection's items are accessed by index via 's indexer directly. When using a struct-based enumerator, no heap allocation occurs during enumeration via . This is in contrast to the interface-based enumerator which will always be allocated on the heap.


              list = ...;
            
             foreach (string item in list.NoAllocEnumerate())
             {
                 // ...
             }]]>

Provides a struct-based enumerator for use with . Do not use this type directly. Use instead.

A struct-based enumerator for use with . Do not use this type directly. Use instead.

Avoids allocating an enumerator when enumerating an where the concrete type has a well known struct enumerator, such as for , or when index-based access is possible via .

Several collection types (e.g. ) provide a struct-based enumerator type (e.g. ) which the compiler can use in statements. When using a struct-based enumerator, no heap allocation occurs during such enumeration. This is in contrast to the interface-based enumerator which will always be allocated on the heap. This method returns a custom struct enumerator that will avoid any heap allocation if (which is declared via interface ) is actually of known concrete type that provides its own struct enumerator. If so, it delegates to that type's enumerator without any boxing or other heap allocation. If is not of a known concrete type, the returned enumerator falls back to the interface-based enumerator, which will be allocated on the heap. Benchmarking shows the overhead in such cases is low enough to be within the measurement error, meaning this is an inexpensive optimization that won't regress behavior and with low downside for cases where it cannot apply an optimization.


              source = ...;
            
             foreach (string item in source.NoAllocEnumerate())
             {
                 // ...
             }]]>

Provides a struct-based enumerator for use with . Do not use this type directly. Use instead.

A struct-based enumerator for use with . Do not use this type directly. Use instead.

Avoids allocating an enumerator when enumerating an where the concrete type has a well known struct enumerator, such as for .


              dictionary = ...;
            
             foreach ((string key, string value) in dictionary.NoAllocEnumerate())
             {
                 // ...
             }]]>

Provides a struct-based enumerator for use with . Do not use this type directly. Use instead.

A struct-based enumerator for use with . Do not use this type directly. Use instead.

Gets a that's completed successfully with the result of .

Returns a that's completed successfully with the result of .

Gets a that's completed successfully with the result of .

Returns a that's completed successfully with the result of .

Returns a of type that's completed successfully with the result of .

Returns a whose value is an empty enumerable of type .

Returns a whose value is an empty array with element type .

Specifies that null is allowed as an input even if the corresponding type disallows it.

Specifies that null is disallowed as an input even if the corresponding type allows it.

Specifies that an output may be null even if the corresponding type disallows it.

Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.

Specifies that when a method returns , the parameter may be null even if the corresponding type disallows it.

Initializes the attribute with the specified return value condition.

The return value condition. If the method returns this value, the associated parameter may be null.

Gets the return value condition.

Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it.

Initializes the attribute with the specified return value condition.

The return value condition. If the method returns this value, the associated parameter will not be null.

Gets the return value condition.

Specifies that the output will be non-null if the named parameter is non-null.

Initializes the attribute with the associated parameter name.

The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.

Gets the associated parameter name.

Applied to a method that will never return under any circumstance.

Specifies that the method will not return if the associated Boolean parameter is passed the specified value.

Initializes the attribute with the specified parameter value.

The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to the associated parameter matches this value.

Gets the condition parameter value.

Specifies that the method or property will ensure that the listed field and property members have not-null values.

Initializes the attribute with a field or property member.

The field or property member that is promised to be not-null.

Initializes the attribute with the list of field and property members.

The list of field and property members that are promised to be not-null.

Gets field or property member names.

Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.

Initializes the attribute with the specified return value condition and a field or property member.

The return value condition. If the method returns this value, the associated parameter will not be null. The field or property member that is promised to be not-null.

Initializes the attribute with the specified return value condition and list of field and property members.

The return value condition. If the method returns this value, the associated parameter will not be null. The list of field and property members that are promised to be not-null.

Gets the return value condition.

Gets field or property member names.