NuGet.ProjectModel

Gets or sets the full path to the project file.

Gets or sets a list of package paths that must exist in order for the project to be considered up-to-date.

Since Log messages property in CacheFile is an interface type, we have the following custom converter to deserialize the IAssetsLogMessage objects.

A circular memory stream backed by a fixed-size byte buffer.

Allows a user to enable the legacy SHA512 hash function for dgSpec files which is used by no-op.

Projects to restore.

All project specs.

Retrieve a DependencyGraphSpec with the project closure.

Creates a new from a project name and project closure.

The project's unique name. The project's closure A . Thrown if is or an empty string. Thrown if is .

Retrieve the full project closure including the root project itself.

Results are not sorted in any form.

Order dependencies by children first.

PackageSpec -> id

PackageSpec -> Project dependency ids

Represents a reference to a project produced by an external build system, such as msbuild.

unique project name or full path project.json package spec. project file if one exists unique names of the referenced projects

Represents a reference to a project produced by an external build system, such as msbuild.

unique project name or full path project.json file path or null if none exists project file if one exists unique names of the referenced projects

Unique name of the external project

The path to the project.json file representing the NuGet dependencies of the project

A list of other external projects this project references. Uses the UniqueName.

Path to msbuild project file. Ex: xproj, csproj

Path to project.json

This may be null for projects that do not contain project.json.

Project name used for project.json

This may be null for projects that do not contain project.json.

Project name from the package spec or msbuild file.

A Fowler-Noll-Vo (FNV) 64-bit hash function that supports non-cryptographic hashing to optimize speed and minimize collisions. https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function

Generates a hash from an object graph. This is non-private only to facilitate unit testing.

Creates a new instance with the provide hash function.

An instance. Throws if .

Gets the hash for the object. Once GetHash is called, no further writing is allowed.

A hash of the object.

Provides external project reference closures.

Get the full p2p closure from an msbuild project path.

Returns all known entry points.

Load and parse a project.json file

project name file path

JsonLoadSettings with line info and comments ignored.

Load json from a file to a JObject using the default load settings.

Splits a string by a delimiter, producing substrings lazily during enumeration. Skips empty items, behaving equivalently to with .

Unlike and overloads, does not allocate an array for the return, and allocates strings on demand during enumeration. A custom enumerator type is used so that the only allocations made are the substrings themselves. We also avoid the large internal arrays assigned by the methods on . This extension method has special knowledge of the type and can compute its result without allocation.

Level to indicate if this is an error or wanring.

Indicates the NuGet error code.

Indicates the staring generated by the code to go with the error code.

Indicates the project for which the error was thrown.

Level to indicate the warning level for the message. This is relevant only if the Level == LogLevel.Warning.

Indicates the file for which the error was thrown.

Indicates the starting line for which the error was thrown.

Indicates the starting column for which the error was thrown.

Indicates the ending line for which the error was thrown.

Indicates the ending column for which the error was thrown.

Project or Package Id

List of TargetGraphs

Get target graphs for the current log message.

If the message does not contain target graphs all graphs in the file will be returned.

Get the library from each target graph it exists in.

Get the library by id from the target graph.

Writes the object to the .

IAssetsLogMessage representing the log message.

Relative path to the project.json file for projects

Relative path to the msbuild project file. Ex: xproj, csproj

A to allow read JSON into

{ "code": "", "level": "", "message": "test log message", "warningLevel": , "filePath": "C:\a\file\path.txt", "startLineNumber": 1, "startColumnNumber": 2, "endLineNumber": 10, "endcolumnNumber": 20, "libraryId": "libraryId", "targetGraphs": [ "targetGraph1" ] }

A to allow read JSON into

{ "version": 3, "targets": { }, "libraries": { }, "projectFileDependencyGroups": { }, "packageFolders": { }, "project": { }, "logs": [ ] }

A to allow read JSON into

"path/to/the.dll": { "property1": "val1", "property2": 2 "property3": true "property4": false }

A to allow read JSON into

"PackageA/1.0.0": { "sha512": "ASha512", "type": "package", "path": "C:\a\test\path", "files": [ "PackageA.nuspec", "lib/netstandard2.0/PackageA.dll" ], "msbuildProject": "bar", "servicable": true, "hasTools": true, }

A to allow read JSON into

"net45/win8": { , }

A to allow read JSON into

"Lirbary/1.0.0": { "type": "package", "framework": ".NETCoreApp,Version=v6.0", "dependencies": { "Library.Name": "1.0.1", "Parser.Json": "10.0.0", }, "frameworkAssemblies": [ "System" ], "compile": { , }, "runtime": { , }, "resource": { , }, "contentFiles": { , }, "runtimeTargets": { , }, "tools": { , }, "embed": { , }, "frameworkReferences": [ "Framework1", ] }

Applies macros in place to every string in the list. Macros are applied only at the beginning of a string.

The list of elements to apply the macro on. The macro value that'll need to match from the strings. The macro that'll replace the value within the string. The comparer to use. Normally these strings are paths, so the comparer should be OS aware.

Applies macro to the string in the list.

The string to apply the macro on. The macro value that'll need to match from the string. The macro that'll replace the value within the string. The comparer to use. Normally these strings are paths, so the comparer should be OS aware.

Represents a that does not allocate a new string when accessing .

Gets or sets the line terminator string used by the current TextWriter.

The base implementation of in .NET Framework allocates a new string every time it is accessed and looks like this:


             public virtual string NewLine
             {
                 get
                 {
                     return new string (CoreNewLine);
                 }
                 set
                 {
                     if (value == null)
                     {
                         value = "\r\n";
                     }
             
                     CoreNewLine = value.ToCharArray();
                 }
             }

This implementation instead returns a cached string to be used by the caller.

Full path to the packages.config file, if it exists. Only valid when ProjectStyle is PackagesConfig.

User packages repository path.

Represents the specification of a package that can be built.

List of dependencies that apply to all frameworks. based projects must not use this list and instead use the one in the property which is a list of the type.

Project Settings is used to pass settings like HideWarningsAndErrors down to lower levels. Currently they do not include any settings that affect the final result of restore. This should not be part of the Equals and GetHashCode. Don't write this to the package spec

Additional MSBuild properties.

Optional. This is normally set for internal use only.

Clone a PackageSpec

Get the nearest framework available in the project.

Get restore metadata framework. This is based on the project's target frameworks, then an exact match is found under restore metadata.

Add or Update the dependencies in the spec. If the package exists in any of the dependencies list, only those will be updated. If the package does not exist in any of dependencies lists, if the is then the will be updated, otherwise, the generic dependencies will be updated.

PackageSpec to update. Cannot be Dependency to add. Cannot be If or is

Add or Update the dependencies in the spec. Only the frameworks specified will be considered.

PackageSpec to update. Cannot be Dependency to add. Cannot be The frameworks to be considered. If , then all frameworks will be considered. If or is

Add or Update the dependencies in the spec. Only the frameworks specified will be considered.

PackageSpec to update. Cannot be Dependency to add. Cannot be The frameworks to be considered. If , then all frameworks will be considered. If or is

Handles both external references and projects discovered through directories If the type is set to external project directory discovery will be disabled.

UWP Project.json

Apply a snapshot value.

True if the string is a snapshot version.

Writes out a PackageSpec object graph. This is non-private only to facilitate unit testing.

Writes a PackageSpec to an NuGet.Common.IObjectWriter instance.

A PackageSpec instance. An NuGet.Common.IObjectWriter instance.

Writes a PackageSpec to a file.

A PackageSpec instance. A file path to write to.

This method sets the msbuild metadata that's important for restore. Ensures that frameworks regardless of which way they're stores in the metadata(full name or short tfm name) are written out the same.

This method sorts the libraries based on the name This method also writes out the normalized versions to avoid cases where original string is set because it was gotten through project system vs being installed from PM UI

The central transitive dependecy groups are used for pack operation. The metadata needed for pack is composed from: Name, IncludeType, SuppressParent and Version

Package is directly installed into the project.

Package is transitively available to the project instead of directly installed.

Package is transitively available to the project instead of directly installed but is also enforced by the central package version file.

FrameworkName/RuntimeIdentifier combination

Target framework.

Null for RIDless graphs.

Full framework name.

The lock file will get invalidated if one or more of the below are true 1. The target frameworks list of the current project was updated. 2. The runtime list of the current project waw updated. 3. The packages of the current project were updated. 4. The packages of the dependent projects were updated. 5. The framework list of the dependent projects were updated with frameworks incompatible with the main project framework. 6. If the version of the is larger than the current tools .

The for the new project defintion. The current . Returns LockFileValidityWithInvalidReasons object with IsValid set to true if the lock file is valid false otherwise. The second return type is a localized message that indicates in further detail the reason for the inconsistency.

Compares two lock files to check if the structure is the same (all values are the same, other than SHA hash), and matches dependencies so the caller can easily compare SHA hashes.

The expected lock file structure. Usuaully generated from the project. The lock file that was loaded from the file on disk. A .

The method will return true if: 1. If a transitive dependency from the lock file is now added to the central file. or 1. If there is a mistmatch between the RequestedVersion of a lock file dependency marked as CentralTransitive and the the version specified in the central package management file. or 2. If a central version that is a transitive dependency is removed from CPVM the lock file is invalidated.

A class to return information about lock file validity

True if the lock file had the expected structure (all values expected, other than content hash)

A list of matched dependencies, so content sha can easily be checked.

A class to return information about lock file validity with invalid reasons.

True if the packages.lock.json file dependencies match project.assets.json file dependencies

A list of reasons why lock file is invalid

Restore behavior type.

MSBuild project file path.

Full path to the project.json file if it exists.

Assets file output path.

Friendly project name.

Name unique to the project across the solution.

Package feed sources.

User packages folder path.

Cache file path

Fallback folders.

ConfigFilePaths used.

Framework specific metadata, this may be a subset of the project's frameworks. Operations to determine the nearest framework should be done against the project's frameworks, and then matched directly to this section.

Original target frameworks strings. These are used to match msbuild conditionals to $(TargetFramework)

True if $(TargetFrameworks) is used and the build is using Cross Targeting.

Whether or not to restore the packages directory using the legacy format, which write original case paths instead of lowercase.

Asset files. These should be equivalent to the files that would be in the nupkg after packing the project.

Compatibility check for runtime framework assets.

True if this is a Legacy Package Reference project

Contains Project wide properties for Warnings.

Gets or sets a value indicating whether or not central package management is enabled.

Gets or sets a value indicating whether or not a package version specified centrally can be overridden.

Gets or sets a value indicating whether or not floating versions are allowed when using central package management (CPM).

A unified flag to help users manage their SDK warning levels. Example: 9.0.100. When introducing a new warning or error use this property to allow users to tell the sdk "treat me as if I were SDK x.y.z" and manage breaking changes

Indicates that Microsoft.NET.Sdk is being used.

Relative path that would be used within a package. This will be used to determine the asset type. Example: lib/net45/a.dll

Absolute path on disk.

Target framework

Project references

Project unique name.

Full path to the msbuild project file.

This class is used to hold restore related, project specific settings.

Bool property is used inr estore command to not log errors and warning. Currently this is only being used for net core based projects on nomination.

Indicates the .NET SDK Version if any. In combination with SdkAnalysisLevel, it allows us to determine whether the analysis level is the default one or manually specified.

Unknown

UAP style, project.lock.json is generated next to project.json

MSBuild style, project.assets.json is generated in the RestoreOutputPath folder

DotnetCliToolReference "project"

Non-MSBuild project with no project dependencies.

Packages.config project

DotnetToolReference project

Gets or sets a value indicating whether NuGet audit (check packages for known vulnerabilities) is enabled.

Gets or sets a value indicating the NuGet audit level threshold with which vulnerabilities are reported.

low, moderate, high, critical

Gets or sets a value indicating which audit mode to use.

direct, all

Gets or sets values indicating which advisories to suppress.

Set when customer wants to opt into packages lock file

Packages.lock.json file path including file name if customer wants to override defualt file name.

True, if updating lock file on restore is denied.

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 Argument cannot be null or empty..

Looks up a localized string similar to The {0} value: `{1}` is invalid. Valid example: `{2}`.

Looks up a localized string similar to Invalid dependency target value '{0}'..

Looks up a localized string similar to The pack options package type must be a string or array of strings in '{0}'..

Looks up a localized string similar to Error loading lock file '{0}' : {1}.

Looks up a localized string similar to Error reading '{0}' : {1}.

Looks up a localized string similar to Error reading '{0}' at line {1} column {2} : {3}.

Looks up a localized string similar to Imports contains an invalid framework: '{0}' in '{1}'..

Looks up a localized string similar to Problem reading the cache file {0} : {1}.

Looks up a localized string similar to Package dependencies must specify a version range..

Looks up a localized string similar to Tools must specify a version range..

Looks up a localized string similar to None.

Looks up a localized string similar to Central package management file(s) doesn't contain version range for {0} package which is specified as CentralTransitive dependency in the lock file..

Looks up a localized string similar to Version specified in the packages.lock.json file is incompatible. Current tooling supports version {0} and previous formats..

Looks up a localized string similar to The project target frameworks are different than the lock file's target frameworks. Lock file target frameworks: {0}. Project target frameworks {1}..

Looks up a localized string similar to The project target framework {0} was not found in the lock file..

Looks up a localized string similar to A new package reference was found {0} for the project target framework {1}..

Looks up a localized string similar to The package references have changed for {0}. Lock file's package references: {1}, project's package references: {2}..

Looks up a localized string similar to The package reference {0} version has changed from {1} to {2}..

Looks up a localized string similar to A new project reference to {0} was found for {1} target framework..

Looks up a localized string similar to The project references {0} whose dependencies has changed..

Looks up a localized string similar to The project {0} has no compatible target framework. .

Looks up a localized string similar to The project reference {0} has changed. Current dependencies: {1} lock file's dependencies: {2}..

Looks up a localized string similar to Transitive dependency {0} moved to be centraly managed invalidated the lock file..

Looks up a localized string similar to Mistmatch between the requestedVersion of a lock file dependency marked as CentralTransitive and the the version specified in the central package management file. Lock file version {0}, central package management version {1}..

Looks up a localized string similar to Restore metadata is mising the required target frameworks list. Please file a bug with repro steps on NuGet/Home if seen..

Looks up a localized string similar to The project's runtime identifiers have changed from. Project's runtime identifiers: {0}, lock file's runtime identifiers {1}..

Looks up a localized string similar to Unable to load package spec for {0} project..

A fallback PCL framework to use when no compatible items were found for .

If True AssetTargetFallback behavior will be used for Imports.

Display warnings when the Imports framework is used.

List of dependencies that are not part of the graph resolution.

Package versions defined in the Central package versions management file.

A set of unique FrameworkReferences

A dictionary of packages to be pruned from the graph. An item existing in this dictionary means the pruning capability is enabled. If pruning is not enabled, this property return Empty regardless of what was specified in the items.

The project provided runtime.json

Given a toolDirectory path, it returns the full assets file path

Given a package id, version and framework, returns the full assets file path

Given a package id, version and framework, returns the tool directory path where the assets/cache file are located for tools

The base path for all restored tools

Returns the directory (packagesFolder/.tools/id/version for example) for the best matching version if any.

Given a package id, looks in the base tools folder and returns all the version available on disk, possibly none

A to allow reading JSON into

"net45": [ "Json.Parser (>= 1.0.1)", ]

This struct is used to read over a memeory stream in parts, in order to avoid reading the entire stream into memory. It functions as a wrapper around , while maintaining a stream and a buffer to read from.

Loops through the stream and reads it into the buffer until the buffer is full or the stream is empty, creates the Utf8JsonReader.

An abstract class that defines a function for reading a into a

Class to hold warning properties given by project system.

List of Warning Codes that should be treated as Errors.

List of Warning Codes that should be ignored.

Indicates if all warnings should be ignored.

List of Warning Codes that should not be treated as Errors.

Create warning properties from the msbuild property strings.

Create warning properties from NuGetLogCode collection.

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

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.

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.