Summary
Defines the base class for
ITask classes that invoke a command line tool.
- Namespace
- NBuildKit
.MsBuild .Tasks .Core - Base Types
-
- Task
- BaseTask
- Derived Types
-
- Fx
Cop Command Line Tool Task - ValidateGpgSignature
- ILRepack
- GitHubReleaseCreate
- GitHubReleaseUpload
- Git
Command Line Tool Task - Ms
Build Command Line Tool Task - OpenCover
- Public
Key Signature From Key File - Calculate
Semantic Version With Git Version - InvokeNodeTool
- Generate
Internals Visible To Attributes - ExecWithArguments
- Powershell
Command Line Tool Task - GetToolFullPath
- Nu
Get Command Line Tool Task - ReportGenerator
- Fx
graph TD
Base0["BaseTask"]-->Type
click Base0 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/BaseTask"
Base1["Task"]-->Base0
Type["CommandLineToolTask"]
class Type type-node
Type-->Derived0["FxCopCommandLineToolTask"]
click Derived0 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/FxCopCommandLineToolTask"
Type-->Derived1["ValidateGpgSignature"]
click Derived1 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.FileSystem/ValidateGpgSignature"
Type-->Derived2["ILRepack"]
click Derived2 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Code/ILRepack"
Type-->Derived3["GitHubReleaseCreate"]
click Derived3 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Projects/GitHubReleaseCreate"
Type-->Derived4["GitHubReleaseUpload"]
click Derived4 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Projects/GitHubReleaseUpload"
Type-->Derived5["GitCommandLineToolTask"]
click Derived5 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/GitCommandLineToolTask"
Type-->Derived6["MsBuildCommandLineToolTask"]
click Derived6 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/MsBuildCommandLineToolTask"
Type-->Derived7["OpenCover"]
click Derived7 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Testing/OpenCover"
Type-->Derived8["PublicKeySignatureFromKeyFile"]
click Derived8 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks/PublicKeySignatureFromKeyFile"
Type-->Derived9["CalculateSemanticVersionWithGitVersion"]
click Derived9 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Versions/CalculateSemanticVersionWithGitVersion"
Type-->Derived10["InvokeNodeTool"]
click Derived10 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Script/InvokeNodeTool"
Type-->Derived11["GenerateInternalsVisibleToAttributes"]
click Derived11 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Code/GenerateInternalsVisibleToAttributes"
Type-->Derived12["ExecWithArguments"]
click Derived12 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Script/ExecWithArguments"
Type-->Derived13["PowershellCommandLineToolTask"]
click Derived13 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/PowershellCommandLineToolTask"
Type-->Derived14["GetToolFullPath"]
click Derived14 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.FileSystem/GetToolFullPath"
Type-->Derived15["NuGetCommandLineToolTask"]
click Derived15 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/NuGetCommandLineToolTask"
Type-->Derived16["ReportGenerator"]
click Derived16 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Testing/ReportGenerator"
Syntax
public abstract class CommandLineToolTask : BaseTaskConstructors
| Name | Summary |
|---|---|
| CommandLineToolTask |
Initializes a new instance of the CommandLineToolTask class.
|
| CommandLineToolTask |
Initializes a new instance of the CommandLineToolTask class.
|
Properties
| Name | Value | Summary |
|---|---|---|
| DefaultDataHandler | Data |
Gets the event handler that processes data from the data stream, or standard output stream, of
the command line application.By default logs a message for each output.
|
| DefaultErrorHandler | Data |
Gets the event handler that processes data from the data stream, or standard output stream, of
the command line application.By default logs a message for each output.
|
| ErrorInformation | ITaskItem[] |
Gets or sets the collection containing the error codes for the task.
Inherited from BaseTask
|
| Log |
bool |
Gets or sets a value indicating whether the environment variables for the process should be logged.
|
Methods
| Name | Value | Summary |
|---|---|---|
| ErrorCodeById |
string |
Returns the error code for the given ID.
Inherited from BaseTask
|
| GetAbsolutePath |
string |
Returns the absolute path for the given path item.
Inherited from BaseTask
|
| GetAbsolutePath |
string |
Returns the absolute path for the given path item.
Inherited from BaseTask
|
| GetAbsolutePath |
string |
Returns the absolute path for the given path item.
Inherited from BaseTask
|
| GetFullToolPath |
string |
Returns the most complete path for the given executable tool. May return just the name of the tool if the tool path is found via the
PATH environment variable.
|
| GetFullToolPath |
string |
Returns the most complete path for the given executable tool. May return just the name of the tool if the tool path is found via the
PATH environment variable.
|
| Invoke |
int |
Invokes the command line tool at the given path with the given arguments.
|
| Invoke |
int |
Invokes the command line tool at the given path with the given arguments.
|
| Update |
void |
Updates the environment variables for the application prior to execution.
|
| Verbosity |
string |
Gets the verbosity that the current MsBuild instance is running at.
Inherited from BaseTask
static
|