CustomProjectParserResult Class

Summary

Represents the content in an MSBuild project file.
Assembly
Cake.Incubator.dll
Namespace
Cake.Incubator.Project
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["CustomProjectParserResult"] class Type type-node

Syntax

public class CustomProjectParserResult

Constructors

Properties

Name Value Summary
AssemblyName string
Gets the build target assembly name.
Configuration string
Gets the build configuration.
Files ICollection<CustomProjectFile>
Gets the project content files. CustomProjectFile
IsNetCore bool
True if the project is a net core compatible project
IsNetFramework bool
True if the project is a net framework compatible project
IsNetStandard bool
True if the project is a net standard compatible project
IsVS2017ProjectFormat bool
Whether the project parsed is in the newer VS2017 onwards format or the legacy pre 2017 format
NetCore NetCoreProject
Contains properties specific to net core projects. See NetCoreProject
OutputPath DirectoryPath
Gets the first compiler artifact output path. Use OutputPaths for multi-targeting libraries
OutputPaths DirectoryPath[]
Gets the compiler artifact output paths.
OutputType string
Gets the compiler output type, i.e. Exe/Library.
PackageReferences ICollection<PackageReference>
The project package references. A collection of PackageReference
Platform string
Gets the target platform.
ProjectFilePath FilePath
The path for the parsed project file
ProjectGuid string
Gets the unique project identifier.
ProjectReferences ICollection<ProjectReference>
Gets the references to other projects. ProjectReference
ProjectTypeGuids string[]
Gets the project type identifiers.
ProjectXml XDocument
The project file xml source
References ICollection<ProjectAssemblyReference>
Gets the references. ProjectAssemblyReference
RootNameSpace string
Gets the default root namespace.
TargetFrameworkProfile string
Gets the compiler target framework profile.
TargetFrameworkVersion string
Gets the first compiler target framework version.
TargetFrameworkVersions string[]
Gets the first compiler target framework versions.

Extension Methods

Name Value Summary
Dump<CustomProjectParserResult>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
GetAssemblyFilePath() FilePath
Gets a parsed projects output assembly path
Requires the Cake.Incubator addin
GetAssemblyFilePaths() FilePath[]
Gets a parsed projects output assembly paths for mulit-targeting projects
Requires the Cake.Incubator addin
GetDotNetCliToolReference(string) DotNetCliToolReference
Gets a project DotNetCliToolReference
Requires the Cake.Incubator addin
GetExtension() string
Returns the parsed projects output assembly extension
Requires the Cake.Incubator addin
GetPackage(string, string) PackageReference
Gets a project package reference
Requires the Cake.Incubator addin
GetProjectProperty(string) string
Gets any project property by name. Useful for getting non-standard properties in the CustomProjectParserResult type
Requires the Cake.Incubator addin
GetReference(string) ProjectAssemblyReference
Gets a project assembly reference by name or alias
Requires the Cake.Incubator addin
HasDotNetCliToolReference(string) bool
Checks for a DotNet Cli Tool Reference by name
Requires the Cake.Incubator addin
HasPackage(string, string) bool
Checks for a project package reference by name and optional TargetFramework
Requires the Cake.Incubator addin
HasReference(string) bool
Checks for a project assembly reference by name or alias
Requires the Cake.Incubator addin
IsDotNetCliTestProject() bool
Checks if the project is a `dotnet test` compatible project
Requires the Cake.Incubator addin
IsExpectoTestProject() bool
Checks if the project is an Expecto test compatible project
Requires the Cake.Incubator addin
IsFixieTestProject() bool
Checks if the project is an fixie test compatible project
Requires the Cake.Incubator addin
IsFrameworkTestProject() bool
Checks if the project is a pre `dotnet test` compatible project
Requires the Cake.Incubator addin
IsFsUnitTestProject() bool
Checks if the project is an fsunit test compatible project
Requires the Cake.Incubator addin
IsGlobalTool() bool
Checks if the project is for a global tool
Requires the Cake.Incubator addin
IsIn<CustomProjectParserResult>(CustomProjectParserResult[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
IsLibrary() bool
Checks if the project is a library
Requires the Cake.Incubator addin
IsMSTestProject() bool
Checks if the project is an MSTest compatible project
Requires the Cake.Incubator addin
IsNUnitTestProject() bool
Checks if the project is an NUnit test compatible project
Requires the Cake.Incubator addin
IsTestProject() bool
Checks if the project is a test compatible project
Requires the Cake.Incubator addin
IsType(ProjectType) bool
Checks the parsed projects type
Requires the Cake.Incubator addin
IsWebApplication() bool
Checks if the project is a web application.
Requires the Cake.Incubator addin
IsXUnitTestProject() bool
Checks if the project is an xunit test compatible project
Requires the Cake.Incubator addin
NotNull<CustomProjectParserResult>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<CustomProjectParserResult>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<CustomProjectParserResult>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<CustomProjectParserResult>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin