mirrors/dotnet-installer
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

add xliff scenario

Browse source
This commit is contained in:
Maira Wenzel 2018-03-27 14:12:43 -07:00 • committed by GitHub
parent d0780d81e5
commit 04b3ff3457
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Documentation/project-docs/developer-guide.md
View file

@ -3,7 +3,7 @@ Developer Guide
## Prerequisites
In order to build .NET Command Line Interface, you need the following installed on you machine.
In order to build .NET Command-line Interface (CLI), you need the following installed on you machine:
### For Windows
@ -27,7 +27,9 @@ In order to build .NET Command Line Interface, you need the following installed
## Building/Running
1. Run `build.cmd` or `build.sh` from the root depending on your OS. If you don't want to execute tests, run `build.cmd /t:Compile` or `./build.sh /t:Compile`.
2. The CLI that is built (we call it stage 2) will be laid out in the `bin\2\{RID}\dotnet` folder. You can run `dotnet.exe` or `dotnet` from that folder to try out the `dotnet` command.
2. The CLI that is built (we call it stage 2) is laid out in the `bin\2\{RID}\dotnet` folder. You can run `dotnet.exe` or `dotnet` from that folder to try out the `dotnet` command.
> If you need to update localizable strings in resource (*.resx*) files, run `build.cmd /p:UpdateXlfOnBuild=true` or `./build.sh /p:UpdateXlfOnBuild=true` to update the XLIFF (*.xlf*) files as well.
## A simple test
Using the `dotnet` built in the previous step:
@ -56,12 +58,15 @@ The dotnet CLI supports several models for adding new commands:
4. Via the user's `PATH`
### Commands in dotnet.dll
Developers are generally encouraged to avoid adding commands to `dotnet.dll` or the CLI installer directly. This is appropriate for very general commands such as restore, build, publish, test, and clean, but is generally too broad of a distribution mechanism for new commands. Please create an issue and engage the team if you feel there is a missing core command that you would like to add.
### Tools NuGet packages
Many existing extensions, including those for ASP.NET Web applications, extend the CLI using Tools NuGet packages. For an example of a working packaged command look at `TestAssets/TestPackages/dotnet-hello/v1/`.
### MSBuild tasks & targets
NuGet allows adding tasks and targets to a project through a NuGet package. This mechanism, in fact, is how all .NET Core projects pull in the .NET SDK. Extending the CLI through this model has several advantages:
1. Targets have access to the MSBuild Project Context, allowing them to reason about the files and properties being used to build a particular project.
@ -71,7 +76,9 @@ Commands added as targets can be invoked once the target project adds a referenc
Targets are invoked by calling `dotnet msbuild /t:{TargetName}`
### Commands on the PATH
The dotnet CLI considers any executable on the path named `dotnet-{commandName}` to be a command it can call out to.
## Things to Know
- Any added commands are usually invoked through `dotnet {command}`. As a result of this, stdout and stderr are redirected through the driver (`dotnet`) and buffered by line. As a result of this, child commands should use Console.WriteLine in any cases where they expect output to be written immediately. Any uses of Console.Write should be followed by Console.WriteLine to ensure the output is written.