Pri.Essentials.DotnetProjects.xml
|
<?xml version="1.0"?> <doc> <assembly> <name>Pri.Essentials.DotnetProjects</name> </assembly> <members> <member name="T:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute"> <summary> Indicates that a parameter captures the expression passed for another parameter as a string. </summary> <param name="parameterName"></param> </member> <member name="M:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute.#ctor(System.String)"> <summary> Indicates that a parameter captures the expression passed for another parameter as a string. </summary> <param name="parameterName"></param> </member> <member name="P:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute.ParameterName"> <summary> Gets the name of the parameter whose expression should be captured as a string. </summary> </member> <member name="T:System.Runtime.CompilerServices.IsExternalInit"> <summary> WIP </summary> </member> <member name="T:System.Runtime.CompilerServices.RuntimeHelpers"> <summary> Copied here because GetSubArray isn't in netstandard but RuntimeHelpers is. </summary> </member> <member name="M:System.Runtime.CompilerServices.RuntimeHelpers.GetSubArray``1(``0[],System.Range)"> <summary> Slices the specified array using the specified range. </summary> <typeparam name="T"></typeparam> <param name="array"></param> <param name="range"></param> <returns></returns> <exception cref="T:System.ArgumentNullException"></exception> </member> <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute"> <summary>Applied to a method that will never return under any circumstance.</summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute"> <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary> </member> <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)"> <summary>Initializes the attribute with the specified return value condition.</summary> <param name="returnValue"> The return value condition. If the method returns this value, the associated parameter will not be null. </param> </member> <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"> <summary>Gets the return value condition.</summary> </member> <member name="T:System.ExceptionExtensions"> <summary> Provides extension methods for handling exceptions and validating arguments. </summary> </member> <member name="M:System.ExceptionExtensions.ThrowIfNullOrWhiteSpace(System.String,System.String)"> <inheritdoc cref="M:System.ExceptionExtensions.<G>$2CCF93F8D1D7E0542E57DCB3AD19CD16.ThrowIfNullOrWhiteSpace(System.String,System.String)"/> </member> <member name="M:System.ExceptionExtensions.ThrowIfNull(System.Object,System.String)"> <inheritdoc cref="M:System.ExceptionExtensions.<G>$E6188BA5B951F1F7AA9135E0EBB76F2B.ThrowIfNull(System.Object,System.String)"/> </member> <member name="M:System.ExceptionExtensions.<G>$2CCF93F8D1D7E0542E57DCB3AD19CD16.ThrowIfNullOrWhiteSpace(System.String,System.String)"> <summary>Throws an exception if <paramref name="argument"/> is null, empty, or consists only of white-space characters.</summary> <param name="argument">The string argument to validate.</param> <param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param> <exception cref="T:System.ArgumentNullException"><paramref name="argument"/> is null.</exception> <exception cref="T:System.ArgumentException"><paramref name="argument"/> is empty or consists only of white-space characters.</exception> </member> <member name="M:System.ExceptionExtensions.<G>$E6188BA5B951F1F7AA9135E0EBB76F2B.ThrowIfNull(System.Object,System.String)"> <summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary> <param name="argument">The reference type argument to validate as non-null.</param> <param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param> </member> <member name="T:System.Index"> <summary>Represent a type can be used to index a collection either from the start or the end.</summary> <remarks> Index is used by the C# compiler to support the new index syntax <code> int[] someArray = new int[5] { 1, 2, 3, 4, 5 } ; int lastElement = someArray[^1]; // lastElement = 5 </code> </remarks> </member> <member name="M:System.Index.#ctor(System.Int32,System.Boolean)"> <summary>Construct an Index using a value and indicating if the index is from the start or from the end.</summary> <param name="value">The index value. it has to be zero or positive number.</param> <param name="fromEnd">Indicating if the index is from the start or from the end.</param> <remarks> If the Index constructed from the end, index value 1 means pointing at the last element and index value 0 means pointing at beyond last element. </remarks> </member> <member name="P:System.Index.Start"> <summary>Create an Index pointing at first element.</summary> </member> <member name="P:System.Index.End"> <summary>Create an Index pointing at beyond last element.</summary> </member> <member name="M:System.Index.FromStart(System.Int32)"> <summary>Create an Index from the start at the position indicated by the value.</summary> <param name="value">The index value from the start.</param> </member> <member name="M:System.Index.FromEnd(System.Int32)"> <summary>Create an Index from the end at the position indicated by the value.</summary> <param name="value">The index value from the end.</param> </member> <member name="P:System.Index.Value"> <summary>Returns the index value.</summary> </member> <member name="P:System.Index.IsFromEnd"> <summary>Indicates whether the index is from the start or the end.</summary> </member> <member name="M:System.Index.GetOffset(System.Int32)"> <summary>Calculate the offset from the start using the giving collection length.</summary> <param name="length">The length of the collection that the Index will be used with. length has to be a positive value</param> <remarks> For performance reason, we don't validate the input length parameter and the returned offset value against negative values. we don't validate either the returned offset is greater than the input length. It is expected Index will be used with collections which always have non negative length/count. If the returned offset is negative and then used to index a collection will get out of range exception which will be same affect as the validation. </remarks> </member> <member name="M:System.Index.Equals(System.Object)"> <summary>Indicates whether the current Index object is equal to another object of the same type.</summary> <param name="value">An object to compare with this object</param> </member> <member name="M:System.Index.Equals(System.Index)"> <summary>Indicates whether the current Index object is equal to another Index object.</summary> <param name="other">An object to compare with this object</param> </member> <member name="M:System.Index.GetHashCode"> <summary>Returns the hash code for this instance.</summary> </member> <member name="M:System.Index.op_Implicit(System.Int32)~System.Index"> <summary>Converts integer number to an Index.</summary> </member> <member name="M:System.Index.ToString"> <summary>Converts the value of the current Index object to its equivalent string representation.</summary> </member> <member name="T:System.Range"> <summary>Represent a range has start and end indexes.</summary> <remarks> Range is used by the C# compiler to support the range syntax. <code> int[] someArray = new int[5] { 1, 2, 3, 4, 5 }; int[] subArray1 = someArray[0..2]; // { 1, 2 } int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 } </code> </remarks> </member> <member name="P:System.Range.Start"> <summary>Represent the inclusive start index of the Range.</summary> </member> <member name="P:System.Range.End"> <summary>Represent the exclusive end index of the Range.</summary> </member> <member name="M:System.Range.#ctor(System.Index,System.Index)"> <summary>Construct a Range object using the start and end indexes.</summary> <param name="start">Represent the inclusive start index of the range.</param> <param name="end">Represent the exclusive end index of the range.</param> </member> <member name="M:System.Range.Equals(System.Object)"> <summary>Indicates whether the current Range object is equal to another object of the same type.</summary> <param name="value">An object to compare with this object</param> </member> <member name="M:System.Range.Equals(System.Range)"> <summary>Indicates whether the current Range object is equal to another Range object.</summary> <param name="other">An object to compare with this object</param> </member> <member name="M:System.Range.GetHashCode"> <summary>Returns the hash code for this instance.</summary> </member> <member name="M:System.Range.ToString"> <summary>Converts the value of the current Range object to its equivalent string representation.</summary> </member> <member name="M:System.Range.StartAt(System.Index)"> <summary>Create a Range object starting from start index to the end of the collection.</summary> </member> <member name="M:System.Range.EndAt(System.Index)"> <summary>Create a Range object starting from first element in the collection to the end Index.</summary> </member> <member name="P:System.Range.All"> <summary>Create a Range object starting from first element to the end.</summary> </member> <member name="M:System.Range.GetOffsetAndLength(System.Int32)"> <summary>Calculate the start offset and length of range object using a collection length.</summary> <param name="length">The length of the collection that the range will be used with. length has to be a positive value.</param> <remarks> For performance reason, we don't validate the input length parameter against negative values. It is expected Range will be used with collections which always have non negative length/count. We validate the range is inside the length scope though. </remarks> </member> <member name="T:Pri.Essentials.DotnetProjects.Commands.AddClassToProjectCommand"> <summary> An add class to project command abstraction. </summary> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.AddClassToProjectCommand.#ctor(Pri.Essentials.DotnetProjects.IShellExecutor,Pri.Essentials.DotnetProjects.DotnetProject,System.String)"> <summary> An add class to project command abstraction. </summary> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.AddClassToProjectCommand.Target"> <inheritdoc/> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.AddClassToProjectCommand.ActionName"> <inheritdoc/> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.AddClassToProjectCommand.Execute"> <inheritdoc/> </member> <member name="T:Pri.Essentials.DotnetProjects.Commands.AddPackageReferenceToProjectCommand"> <summary> Represents a command to add a package reference to a .NET project file. </summary> <remarks> This command utilizes a shell executor to execute the necessary `dotnet` CLI commands to add a package reference to the specified project. It supports specifying an optional package version and can handle pre-release packages. </remarks> <param name="shellExecutor">The shell executor used to execute the command.</param> <param name="targetProject">The target .NET project to which the package reference will be added.</param> <param name="packageName">The name of the package to add as a reference.</param> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.AddPackageReferenceToProjectCommand.#ctor(Pri.Essentials.DotnetProjects.IShellExecutor,Pri.Essentials.DotnetProjects.DotnetProject,System.String)"> <summary> Represents a command to add a package reference to a .NET project file. </summary> <remarks> This command utilizes a shell executor to execute the necessary `dotnet` CLI commands to add a package reference to the specified project. It supports specifying an optional package version and can handle pre-release packages. </remarks> <param name="shellExecutor">The shell executor used to execute the command.</param> <param name="targetProject">The target .NET project to which the package reference will be added.</param> <param name="packageName">The name of the package to add as a reference.</param> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.AddPackageReferenceToProjectCommand.#ctor(Pri.Essentials.DotnetProjects.IShellExecutor,Pri.Essentials.DotnetProjects.DotnetProject,System.String,System.String)"> <summary> Initializes a new instance of the <see cref="T:Pri.Essentials.DotnetProjects.Commands.AddPackageReferenceToProjectCommand"/> class with a specified package version. </summary> <param name="shellExecutor">The shell executor used to execute the command.</param> <param name="targetProject">The target .NET project to which the package reference will be added.</param> <param name="packageName">The name of the package to add as a reference.</param> <param name="packageVersion">The version of the package to add as a reference.</param> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.AddPackageReferenceToProjectCommand.Target"> <inheritdoc /> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.AddPackageReferenceToProjectCommand.ActionName"> <inheritdoc /> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.AddPackageReferenceToProjectCommand.IsPrerelease"> <summary> Whether it is a prerelease or not </summary> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.AddPackageReferenceToProjectCommand.Execute"> <inheritdoc /> </member> <member name="T:Pri.Essentials.DotnetProjects.Commands.AddProjectReferenceToProjectCommand"> <summary> Represents a command that adds a project reference to a target .NET project using the dotnet CLI. </summary> <remarks>This command automates the process of adding a project reference by invoking the 'dotnet add reference' command. It is typically used in build automation or tooling scenarios to programmatically manage project dependencies.</remarks> <param name="shellExecutor">The shell executor used to run the underlying dotnet CLI command.</param> <param name="targetProject">The target .NET project to which the reference will be added. Cannot be null.</param> <param name="referencedProject">The .NET project to add as a reference to the target project. Cannot be null.</param> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.AddProjectReferenceToProjectCommand.#ctor(Pri.Essentials.DotnetProjects.IShellExecutor,Pri.Essentials.DotnetProjects.DotnetProject,Pri.Essentials.DotnetProjects.DotnetProject)"> <summary> Represents a command that adds a project reference to a target .NET project using the dotnet CLI. </summary> <remarks>This command automates the process of adding a project reference by invoking the 'dotnet add reference' command. It is typically used in build automation or tooling scenarios to programmatically manage project dependencies.</remarks> <param name="shellExecutor">The shell executor used to run the underlying dotnet CLI command.</param> <param name="targetProject">The target .NET project to which the reference will be added. Cannot be null.</param> <param name="referencedProject">The .NET project to add as a reference to the target project. Cannot be null.</param> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.AddProjectReferenceToProjectCommand.Target"> <inheritdoc /> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.AddProjectReferenceToProjectCommand.ActionName"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.AddProjectReferenceToProjectCommand.Execute"> <inheritdoc /> </member> <member name="T:Pri.Essentials.DotnetProjects.Commands.AddProjectToSolutionCommand"> <summary> WIP </summary> <remarks> dotnet reference add --project .\UI\ .\Lib\ .NET 10+ dotnet add reference --project .\UI\ .\Lib2\ .NET 0 and earlier </remarks> <param name="shellExecutor"></param> <param name="solution"></param> <param name="project"></param> <param name="solutionFolder"></param> <param name="fileSystem"></param> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.AddProjectToSolutionCommand.#ctor(Pri.Essentials.DotnetProjects.IShellExecutor,Pri.Essentials.DotnetProjects.DotnetSolution,Pri.Essentials.DotnetProjects.DotnetProject,System.String,Pri.Essentials.Abstractions.IFileSystem)"> <summary> WIP </summary> <remarks> dotnet reference add --project .\UI\ .\Lib\ .NET 10+ dotnet add reference --project .\UI\ .\Lib2\ .NET 0 and earlier </remarks> <param name="shellExecutor"></param> <param name="solution"></param> <param name="project"></param> <param name="solutionFolder"></param> <param name="fileSystem"></param> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.AddProjectToSolutionCommand.Target"> <inheritdoc /> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.AddProjectToSolutionCommand.ActionName"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.AddProjectToSolutionCommand.Execute"> <inheritdoc /> </member> <member name="T:Pri.Essentials.DotnetProjects.Commands.CommandBase"> <summary> An abstraction of a command pattern. </summary> <param name="shellExecutor"></param> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CommandBase.#ctor(Pri.Essentials.DotnetProjects.IShellExecutor)"> <summary> An abstraction of a command pattern. </summary> <param name="shellExecutor"></param> </member> <member name="F:Pri.Essentials.DotnetProjects.Commands.CommandBase.shellExecutor"> <summary> The shell executor used to run shell commands. </summary> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.CommandBase.Target"> <summary> The target that the command will affect. Typically, file or a directory. </summary> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.CommandBase.ActionName"> <summary> The name of that action that will affect <seealso cref="P:Pri.Essentials.DotnetProjects.Commands.CommandBase.Target"/> </summary> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.CommandBase.ShouldGenerateDocumentationFile"> <summary> Gets or sets whether to generate the xml doc file </summary> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CommandBase.Execute"> <summary> Execute the command (and perform that action, affecting the target). </summary> <returns></returns> </member> <member name="T:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName"> <summary> Represents a supported .NET or .NET Standard framework name as a strongly typed value. </summary> <remarks>Use the predefined static fields, such as <see cref="F:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName.Net10"/>, <see cref="F:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName.Net9"/>, <see cref="F:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName.Net8"/>, <see cref="F:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName.NetStandard20"/>, and <see cref="F:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName.NetStandard21"/>, to refer to specific supported framework versions. This type provides type safety and avoids errors associated with using raw string literals for framework names.</remarks> </member> <member name="F:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName.All"> <summary> Gets a read-only dictionary containing all supported framework names mapped to their corresponding <see cref="T:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName"/> instances. </summary> <remarks>The dictionary keys are string representations of supported frameworks, and the values are the associated <see cref="T:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName"/> objects. This collection can be used to enumerate or look up supported frameworks by name.</remarks> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName.ToString"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName.op_Implicit(Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName)~System.String"> <summary> </summary> <param name="supportedFrameworkName"></param> <returns></returns> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName.TryParse(System.String,Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName@)"> <summary>Converts the string representation of the name of one of the constants to an equivalent object. The return value indicates whether the conversion succeeded.</summary> <param name="potentialName">The case-sensitive string representation of the SupportedFrameworkName name or underlying value to convert.</param> <param name="result">When this method returns, contains an object of type <c>SupportedFrameworkName</c> whose value is represented by <paramref name="potentialName" /> if the parse operation succeeds. If the parse operation fails, contains the default value of the underlying type of <c>TEnum</c>. This parameter is passed uninitialized.</param> <exception cref="T:System.ArgumentNullException"> <paramref name="potentialName" /> is <see langword="null" />.</exception> /// <returns> <see langword="true" /> if the <paramref name="potentialName" /> parameter was converted successfully; otherwise, <see langword="false" />.</returns> </member> <member name="T:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedProjectTemplateName"> <summary> Represents a supported project template name used to identify and work with predefined project templates. </summary> <remarks>This type provides named instances for each supported project template, such as xUnit, Console, or Blazor. It enables type-safe handling of project template names and supports conversion to and from their string representations. Use the static members to access specific templates or enumerate all supported templates via the All property.</remarks> </member> <member name="F:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedProjectTemplateName.All"> <summary> Provides a read-only dictionary containing all supported project template names, keyed by their string identifiers. </summary> <remarks>The dictionary maps each template's string name to its corresponding <see cref="T:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedProjectTemplateName"/> instance. This collection can be used to enumerate or look up all available project templates by name.</remarks> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedProjectTemplateName.ToString"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedProjectTemplateName.op_Implicit(Pri.Essentials.DotnetProjects.Commands.Constants.SupportedProjectTemplateName)~System.String"> <summary> Converts a SupportedProjectTemplateName instance to its string representation. </summary> <remarks>This operator enables implicit conversion of a SupportedProjectTemplateName to a string, allowing instances to be used wherever a string is expected. The conversion returns the underlying name value of the SupportedProjectTemplateName.</remarks> <param name="supportedFrameworkName">The SupportedProjectTemplateName instance to convert.</param> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.Constants.SupportedProjectTemplateName.TryParse(System.String,Pri.Essentials.DotnetProjects.Commands.Constants.SupportedProjectTemplateName@)"> <summary>Converts the string representation of the name of one of the constants to an equivalent object. The return value indicates whether the conversion succeeded.</summary> <param name="potentialName">The case-sensitive string representation of the SupportedProjectTemplateName name or underlying value to convert.</param> <param name="result">When this method returns, contains an object of type <c>SupportedProjectTemplateName</c> whose value is represented by <paramref name="potentialName" /> if the parse operation succeeds. If the parse operation fails, contains the default value of the underlying type of <c>TEnum</c>. This parameter is passed uninitialized.</param> <exception cref="T:System.ArgumentNullException"> <paramref name="potentialName" /> is <see langword="null" />.</exception> /// <returns> <see langword="true" /> if the <paramref name="potentialName" /> parameter was converted successfully; otherwise, <see langword="false" />.</returns> </member> <member name="T:Pri.Essentials.DotnetProjects.Commands.CreateClassLibProjectCommand"> <summary> Represents a command that creates a new .NET class library project using the specified parameters. </summary> <remarks>This command automates the creation of a .NET class library project by invoking the appropriate 'dotnet new classlib' command. After project creation, it attempts to remove the default 'Class1.cs' file if it exists. This class is typically used in build automation or tooling scenarios where programmatic project creation is required.</remarks> <param name="shellExecutor">The shell executor used to run the project creation command.</param> <param name="outputDirectory">The directory in which to create the new class library project. If empty or null, the current directory is used.</param> <param name="outputName">The name to assign to the new project. If empty or null, the default project name is used.</param> <param name="frameworkName">The target framework for the new class library project.</param> <param name="fileSystem">An optional file system abstraction used for file operations. If null, the default file system is used.</param> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CreateClassLibProjectCommand.#ctor(Pri.Essentials.DotnetProjects.IShellExecutor,System.String,System.String,Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName,Pri.Essentials.Abstractions.IFileSystem)"> <summary> Represents a command that creates a new .NET class library project using the specified parameters. </summary> <remarks>This command automates the creation of a .NET class library project by invoking the appropriate 'dotnet new classlib' command. After project creation, it attempts to remove the default 'Class1.cs' file if it exists. This class is typically used in build automation or tooling scenarios where programmatic project creation is required.</remarks> <param name="shellExecutor">The shell executor used to run the project creation command.</param> <param name="outputDirectory">The directory in which to create the new class library project. If empty or null, the current directory is used.</param> <param name="outputName">The name to assign to the new project. If empty or null, the default project name is used.</param> <param name="frameworkName">The target framework for the new class library project.</param> <param name="fileSystem">An optional file system abstraction used for file operations. If null, the default file system is used.</param> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.CreateClassLibProjectCommand.ActionName"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CreateClassLibProjectCommand.Execute"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CreateClassLibProjectCommand.TryDelete(System.String)"> <summary> Attempts to delete the file at the specified path, ignoring any I/O errors that occur during deletion. </summary> <remarks> This wraps the untestable paranoid try/catch so that it can be ignored with ExcludeFromCodeCoverageAttribute </remarks> <param name="path"> The path of the file to delete. Cannot be null or empty. </param> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CreateClassLibProjectCommand.BuildCommandLine"> <inheritdoc /> </member> <member name="T:Pri.Essentials.DotnetProjects.Commands.CreateProjectCommand"> <summary> Represents a command to create a new .NET project based on a specified template and framework. </summary> <remarks> This command is responsible for generating a .NET project file in the specified output directory with the provided name, using the given project template and framework. </remarks> <param name="shellExecutor"> The shell executor used to execute the underlying shell commands required for project creation. </param> <param name="templateName"> The name of the project template to use for creating the .NET project. </param> <param name="outputDirectory"> The directory where the new project will be created. </param> <param name="outputName"> The name of the output project file. </param> <param name="frameworkName"> The target framework for the new project. </param> <param name="fileSystem"></param> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CreateProjectCommand.#ctor(Pri.Essentials.DotnetProjects.IShellExecutor,Pri.Essentials.DotnetProjects.Commands.Constants.SupportedProjectTemplateName,System.String,System.String,Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName,Pri.Essentials.Abstractions.IFileSystem)"> <summary> Represents a command to create a new .NET project based on a specified template and framework. </summary> <remarks> This command is responsible for generating a .NET project file in the specified output directory with the provided name, using the given project template and framework. </remarks> <param name="shellExecutor"> The shell executor used to execute the underlying shell commands required for project creation. </param> <param name="templateName"> The name of the project template to use for creating the .NET project. </param> <param name="outputDirectory"> The directory where the new project will be created. </param> <param name="outputName"> The name of the output project file. </param> <param name="frameworkName"> The target framework for the new project. </param> <param name="fileSystem"></param> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.CreateProjectCommand.ActionName"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CreateProjectCommand.Execute"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CreateProjectCommand.BuildCommandLine"> <inheritdoc /> </member> <member name="T:Pri.Essentials.DotnetProjects.Commands.CreateSolutionFileCommand"> <summary> Represents a command that creates a new .NET solution file using the 'dotnet new sln' command. </summary> <param name="shellExecutor">The shell executor used to run command-line operations.</param> <param name="outputDirectory">The directory in which to create the solution file. If null or empty, the current directory is used.</param> <param name="outputName">The name of the solution file to create.</param> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CreateSolutionFileCommand.#ctor(Pri.Essentials.DotnetProjects.IShellExecutor,System.String,System.String)"> <summary> Represents a command that creates a new .NET solution file using the 'dotnet new sln' command. </summary> <param name="shellExecutor">The shell executor used to run command-line operations.</param> <param name="outputDirectory">The directory in which to create the solution file. If null or empty, the current directory is used.</param> <param name="outputName">The name of the solution file to create.</param> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CreateSolutionFileCommand.Execute"> <inheritdoc /> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.CreateSolutionFileCommand.Target"> <inheritdoc /> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.CreateSolutionFileCommand.ActionName"> <inheritdoc /> </member> <member name="T:Pri.Essentials.DotnetProjects.Commands.CreateSolutionCommand"> <summary> Represents a command that creates a new .NET solution including a sln file, global.json, etc. </summary> <param name="shellExecutor">The shell executor used to run command-line operations.</param> <param name="outputDirectory">The directory in which to create the solution file. If null or empty, the current directory is used.</param> <param name="outputName">The name of the solution file to create.</param> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CreateSolutionCommand.#ctor(Pri.Essentials.DotnetProjects.IShellExecutor,System.String,System.String,System.String)"> <summary> Represents a command that creates a new .NET solution including a sln file, global.json, etc. </summary> <param name="shellExecutor">The shell executor used to run command-line operations.</param> <param name="outputDirectory">The directory in which to create the solution file. If null or empty, the current directory is used.</param> <param name="outputName">The name of the solution file to create.</param> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CreateSolutionCommand.Execute"> <inheritdoc /> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.CreateSolutionCommand.Target"> <inheritdoc /> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.CreateSolutionCommand.ActionName"> <inheritdoc /> </member> <member name="T:Pri.Essentials.DotnetProjects.Commands.CreateXunit3ProjectCommand"> <summary> Represents a command to create a new .NET project based on a specified template and framework. </summary> <remarks> This command is responsible for generating a .NET project file in the specified output directory with the provided name, using the given project template and framework. </remarks> <param name="shellExecutor"> The shell executor used to execute the underlying shell commands required for project creation. </param> <param name="outputDirectory"> The directory where the new project will be created. </param> <param name="outputName"> The name of the output project file. </param> <param name="frameworkName"> The target framework for the new project. </param> <param name="fileSystem"></param> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CreateXunit3ProjectCommand.#ctor(Pri.Essentials.DotnetProjects.IShellExecutor,System.String,System.String,Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName,Pri.Essentials.Abstractions.IFileSystem)"> <summary> Represents a command to create a new .NET project based on a specified template and framework. </summary> <remarks> This command is responsible for generating a .NET project file in the specified output directory with the provided name, using the given project template and framework. </remarks> <param name="shellExecutor"> The shell executor used to execute the underlying shell commands required for project creation. </param> <param name="outputDirectory"> The directory where the new project will be created. </param> <param name="outputName"> The name of the output project file. </param> <param name="frameworkName"> The target framework for the new project. </param> <param name="fileSystem"></param> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.CreateXunit3ProjectCommand.ActionName"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CreateXunit3ProjectCommand.Execute"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CreateXunit3ProjectCommand.BuildCommandLine"> <inheritdoc /> </member> <member name="T:Pri.Essentials.DotnetProjects.Commands.CreateXunitProjectCommand"> <summary> Represents a command to create a new .NET project based on a specified template and framework. </summary> <remarks> This command is responsible for generating a .NET project file in the specified output directory with the provided name, using the given project template and framework. </remarks> <param name="shellExecutor"> The shell executor used to execute the underlying shell commands required for project creation. </param> <param name="outputDirectory"> The directory where the new project will be created. </param> <param name="outputName"> The name of the output project file. </param> <param name="frameworkName"> The target framework for the new project. </param> <param name="fileSystem"></param> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CreateXunitProjectCommand.#ctor(Pri.Essentials.DotnetProjects.IShellExecutor,System.String,System.String,Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName,Pri.Essentials.Abstractions.IFileSystem)"> <summary> Represents a command to create a new .NET project based on a specified template and framework. </summary> <remarks> This command is responsible for generating a .NET project file in the specified output directory with the provided name, using the given project template and framework. </remarks> <param name="shellExecutor"> The shell executor used to execute the underlying shell commands required for project creation. </param> <param name="outputDirectory"> The directory where the new project will be created. </param> <param name="outputName"> The name of the output project file. </param> <param name="frameworkName"> The target framework for the new project. </param> <param name="fileSystem"></param> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.CreateXunitProjectCommand.ActionName"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CreateXunitProjectCommand.Execute"> <inheritdoc /> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.CreateXunitProjectCommand.BuildCommandLine"> <inheritdoc /> </member> <member name="T:Pri.Essentials.DotnetProjects.Commands.ProjectCommandBase"> <summary> Provides a base class for project-related command implementations that generate output files for a specific framework. </summary> <remarks>This class is intended to be inherited by commands that operate on project files and produce output for a specified framework. Derived classes must implement the BuildCommandLine method to define the specific command-line arguments required for execution.</remarks> <param name="shellExecutor">The shell executor used to run external commands required by the project command.</param> <param name="outputDirectory">The directory where the output file will be created. Cannot be null or empty.</param> <param name="outputName">The name of the output file to generate. Cannot be null or empty.</param> <param name="frameworkName">The target framework for which the command is executed.</param> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.ProjectCommandBase.#ctor(Pri.Essentials.DotnetProjects.IShellExecutor,System.String,System.String,Pri.Essentials.DotnetProjects.Commands.Constants.SupportedFrameworkName)"> <summary> Provides a base class for project-related command implementations that generate output files for a specific framework. </summary> <remarks>This class is intended to be inherited by commands that operate on project files and produce output for a specified framework. Derived classes must implement the BuildCommandLine method to define the specific command-line arguments required for execution.</remarks> <param name="shellExecutor">The shell executor used to run external commands required by the project command.</param> <param name="outputDirectory">The directory where the output file will be created. Cannot be null or empty.</param> <param name="outputName">The name of the output file to generate. Cannot be null or empty.</param> <param name="frameworkName">The target framework for which the command is executed.</param> </member> <member name="F:Pri.Essentials.DotnetProjects.Commands.ProjectCommandBase.outputDirectory"> <summary> </summary> </member> <member name="F:Pri.Essentials.DotnetProjects.Commands.ProjectCommandBase.outputName"> <summary> </summary> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.ProjectCommandBase.Target"> <inheritdoc /> </member> <member name="P:Pri.Essentials.DotnetProjects.Commands.ProjectCommandBase.FrameworkName"> <summary> </summary> </member> <member name="M:Pri.Essentials.DotnetProjects.Commands.ProjectCommandBase.BuildCommandLine"> <summary> </summary> <returns></returns> </member> <member name="T:Pri.Essentials.DotnetProjects.DotnetFile"> <summary> An encapsulation of a .NET .file (.sln, .csproj, etc.). Subclasses will implement actions. </summary> </member> <member name="M:Pri.Essentials.DotnetProjects.DotnetFile.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the DotnetFile class with the specified directory and file name. </summary> <param name="directory"> The path to the directory containing the file. If null, the current working directory is used. </param> <param name="name"> The name of the file. If null, the file name is derived from the specified directory path. </param> </member> <member name="P:Pri.Essentials.DotnetProjects.DotnetFile.Directory"> <summary> The directory where the .sln exists or would have been created. The parameter to the <code>dotnet new sln --output</code> option </summary> </member> <member name="P:Pri.Essentials.DotnetProjects.DotnetFile.Name"> <summary> The name of the solution (filename). The parameter to the <code>dotnet new sln --name</code> option </summary> </member> <member name="P:Pri.Essentials.DotnetProjects.DotnetFile.FullPath"> <summary>The full path to the .sln file</summary> </member> <member name="T:Pri.Essentials.DotnetProjects.DotnetProject"> <summary> An encapsulation of a .NET .csproj file and the actions available via `dotnet sln` </summary> <remarks> We don't have methods on this type to add files or references because if methods on this type are called from PowerShell, the context is not known, and we won't know the real current directory. </remarks> </member> <member name="M:Pri.Essentials.DotnetProjects.DotnetProject.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the DotnetProject class with the specified project directory and name. </summary> <param name="directory">The path to the project directory. Can be null to use the current directory.</param> <param name="name">The name of the project. Can be null if the project name should be inferred.</param> </member> <member name="P:Pri.Essentials.DotnetProjects.DotnetProject.FullPath"> <inheritdoc /> </member> <member name="P:Pri.Essentials.DotnetProjects.DotnetProject.Solution"> <summary> Gets or sets the .NET solution associated with this instance. </summary> <remarks>The original intention was to be able to use this given a piped project to perform commands on the solution, but cannot have multiple pipeline inputs in a cmdlet, so this might be extraneous. </remarks> </member> <member name="T:Pri.Essentials.DotnetProjects.DotnetSolution"> <summary> An encapsulation of a .NET .sln file and the actions available via `dotnet sln` </summary> <remarks> We don't have methods on this type to create or add projects because if methods on this type are called from PowerShell, the context is not known, and we won't know the real current directory. </remarks> </member> <member name="M:Pri.Essentials.DotnetProjects.DotnetSolution.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the DotnetSolution class with the specified directory and solution name. </summary> <param name="directory"> The path to the directory containing the solution. Can be null to use the current directory. </param> <param name="name"> The name of the solution. Can be null to use a default or inferred name. </param> </member> <member name="P:Pri.Essentials.DotnetProjects.DotnetSolution.FullPath"> <summary> Gets the full file system path to the solution file, including the ".sln" extension. </summary> </member> <member name="T:Pri.Essentials.DotnetProjects.LinuxShellExecutor"> <summary> A proxy to the Linux shell </summary> </member> <member name="M:Pri.Essentials.DotnetProjects.LinuxShellExecutor.Execute(System.String)"> <inheritdoc /> </member> <member name="T:Pri.Essentials.DotnetProjects.ProjectTemplateNameMapping"> <summary> Provides a mapping between supported project template names and factory functions that create the corresponding project command instances. </summary> <remarks>This class is intended to centralize the association of project template types with their respective command creation logic. It enables consumers to retrieve a command factory for a given template, facilitating consistent project creation workflows. The class is static and cannot be instantiated.</remarks> </member> <member name="F:Pri.Essentials.DotnetProjects.ProjectTemplateNameMapping.CommandMap"> <summary> A dictionary mapping supported project template names to factory functions that create the corresponding </summary> </member> <member name="T:Pri.Essentials.DotnetProjects.Result"> <summary> Represents the result of an operation, indicating whether it was successful or not. </summary> </member> <member name="P:Pri.Essentials.DotnetProjects.Result.IsSuccessful"> <summary> Indicates whether the operation was successful. </summary> </member> <member name="T:Pri.Essentials.DotnetProjects.ShellOperationResult"> <summary> Represents the result of a shell command execution, including the exit code, standard output, and standard error output. </summary> <remarks>Use this record to capture and inspect the outcome of executing a shell or command-line process. The properties provide access to the process's exit code and any output or error messages generated during execution.</remarks> <param name="ExitCode">The exit code returned by the shell process. A value of 0 typically indicates success; nonzero values indicate an error or abnormal termination.</param> <param name="OutputText">The text written to the standard output stream by the shell command. May be empty if the command produced no output.</param> <param name="ErrorText">The text written to the standard error stream by the shell command. May be empty if no errors were reported.</param> </member> <member name="M:Pri.Essentials.DotnetProjects.ShellOperationResult.#ctor(System.Int32,System.String,System.String)"> <summary> Represents the result of a shell command execution, including the exit code, standard output, and standard error output. </summary> <remarks>Use this record to capture and inspect the outcome of executing a shell or command-line process. The properties provide access to the process's exit code and any output or error messages generated during execution.</remarks> <param name="ExitCode">The exit code returned by the shell process. A value of 0 typically indicates success; nonzero values indicate an error or abnormal termination.</param> <param name="OutputText">The text written to the standard output stream by the shell command. May be empty if the command produced no output.</param> <param name="ErrorText">The text written to the standard error stream by the shell command. May be empty if no errors were reported.</param> </member> <member name="P:Pri.Essentials.DotnetProjects.ShellOperationResult.ExitCode"> <summary> Gets the exit code returned by the process after it has terminated. </summary> </member> <member name="P:Pri.Essentials.DotnetProjects.ShellOperationResult.OutputText"> <summary> Gets the output text generated by the operation. </summary> </member> <member name="P:Pri.Essentials.DotnetProjects.ShellOperationResult.ErrorText"> <summary> Gets the error message associated with the current operation or state. </summary> </member> <member name="P:Pri.Essentials.DotnetProjects.ShellOperationResult.IsSuccessful"> <summary> Gets a value indicating whether the operation completed successfully. </summary> </member> <member name="P:Pri.Essentials.DotnetProjects.ShellOperationResult.OperationText"> <summary> Gets the command-line that was executed. </summary> </member> <member name="P:Pri.Essentials.DotnetProjects.ShellOperationResult.IsFailure"> <summary> <code>true</code> if the ExitCode is not 0, <code>false</code> otherwise. </summary> </member> <member name="T:Pri.Essentials.DotnetProjects.ShellResult"> <summary> A command execution result abstraction to encapsulate exit code, standard output, and standard error. </summary> <param name="exitCode">The exit code from the shell.</param> <param name="standardOutputText"> The standard output from the command. </param> <param name="standardErrorText"> The standard error, if any, from the command. </param> </member> <member name="M:Pri.Essentials.DotnetProjects.ShellResult.#ctor(System.Int32,System.String,System.String)"> <summary> A command execution result abstraction to encapsulate exit code, standard output, and standard error. </summary> <param name="exitCode">The exit code from the shell.</param> <param name="standardOutputText"> The standard output from the command. </param> <param name="standardErrorText"> The standard error, if any, from the command. </param> </member> <member name="P:Pri.Essentials.DotnetProjects.ShellResult.ExitCode"> <summary>The exit code returned from the command.</summary> </member> <member name="P:Pri.Essentials.DotnetProjects.ShellResult.StandardOutputText"> <summary>The standard output from the command.</summary> </member> <member name="P:Pri.Essentials.DotnetProjects.ShellResult.StandardErrorText"> <summary>The standard error from the command.</summary> </member> <member name="P:Pri.Essentials.DotnetProjects.ShellResult.IsSuccess"> <summary> <code>true</code> if the ExitCode is 0, <code>false</code> otherwise. </summary> </member> <member name="P:Pri.Essentials.DotnetProjects.ShellResult.IsFailure"> <summary> <code>true</code> if the ExitCode is not 0, <code>false</code> otherwise. </summary> </member> <member name="T:Pri.Essentials.DotnetProjects.VisualStudioProjectConfigurationService"> <summary> Provides services for configuring Visual Studio project files. </summary> <remarks> This service assumes that options are applied unconditionally in the project file; that is, they are applied to a singe unattributed ProgramGroup element in the root (<Project>) element. </remarks> </member> <member name="M:Pri.Essentials.DotnetProjects.VisualStudioProjectConfigurationService.SetRestorePackagesWithLockFile(System.String)"> <summary> Adds the RestorePackagesWithLockFile property if it doesn't exist, and sets it to true </summary> <param name="filePath"></param> <exception cref="T:System.InvalidOperationException"></exception> </member> <member name="M:Pri.Essentials.DotnetProjects.VisualStudioProjectConfigurationService.EnableRestorePackagesWithLockFile(System.IO.Stream)"> <summary> Adds the RestorePackagesWithLockFile property if it doesn't exist, and sets it to true </summary> <param name="stream"> The stream representing the project file to update. The stream must be writable and positioned at the start of the project file content. </param> <exception cref="T:System.InvalidOperationException"></exception> </member> <member name="M:Pri.Essentials.DotnetProjects.VisualStudioProjectConfigurationService.EnableGenerateDocumentationFile(System.IO.Stream)"> <summary> Enables the generation of XML documentation file output for the specified project file stream. </summary> <param name="stream"> The stream representing the project file to update. The stream must be writable and positioned at the start of the project file content. </param> </member> <member name="T:Pri.Essentials.DotnetProjects.IShellExecutor"> <summary> The base interface for a shell executor </summary> </member> <member name="M:Pri.Essentials.DotnetProjects.IShellExecutor.Execute(System.String)"> <summary> Executes the command <paramref name="commandLine"/>. </summary> <param name="commandLine">The command to execute</param> <returns>A <seealso cref="T:Pri.Essentials.DotnetProjects.ShellResult"/> with information about the execution.</returns> </member> <member name="T:Pri.Essentials.DotnetProjects.ShellExecutor"> <summary> An abstraction of a shell proxy to execute commands </summary> </member> <member name="M:Pri.Essentials.DotnetProjects.ShellExecutor.DetermineShellExecutor"> <summary> Private method to figure out and create the environment-specific shell proxy. </summary> <returns></returns> <exception cref="T:System.InvalidOperationException"></exception> </member> <member name="P:Pri.Essentials.DotnetProjects.ShellExecutor.Instance"> <summary>The environment-specific executor.</summary> </member> <member name="M:Pri.Essentials.DotnetProjects.ShellExecutor.Execute(System.String)"> <inheritdoc /> </member> <member name="T:Pri.Essentials.DotnetProjects.WindowsShellExecutor"> <summary> A proxy to the Windows command interpreter (shell) </summary> </member> <member name="M:Pri.Essentials.DotnetProjects.WindowsShellExecutor.Execute(System.String)"> <inheritdoc /> </member> </members> </doc> |