https://github.com/dotnet/mvpsummithackathon2016

Samples for the CLI extensibility hackathon for MVP Summit 2016 in Redmond!
https://github.com/dotnet/mvpsummithackathon2016

cliextensions csproj hackathon

Last synced: 13 days ago
JSON representation

Samples for the CLI extensibility hackathon for MVP Summit 2016 in Redmond!

• Host: GitHub
• URL: https://github.com/dotnet/mvpsummithackathon2016
• Owner: dotnet
• License: mit
• Archived: true
• Created: 2016-11-03T03:35:57.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-02-05T03:42:12.000Z (almost 8 years ago)
• Last Synced: 2024-09-29T21:37:36.544Z (4 months ago)
• Topics: cliextensions, csproj, hackathon
• Language: C#
• Size: 41 KB
• Stars: 14
• Watchers: 15
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Extensibility of the CLI toolset - sample for the hackathon

This repository contains the basic sample of an extension to the MSBuild edition of the [CLI toolset for .NET Core](https://github.com/dotnet/cli). The idea of the repo is to provide an easy way to get started with developing extensions to the CLI and the SDK in terms of both MSBuild targets as well as "classic" tools that can be invoked using the `dotnet-` invocation pattern.

The extension in question is a proof-of-concept tool that allows the user to package a published application as a zip file. It is implemented as:

1. A target that depends on the publish target from the SDK

2. A tool that allows the user to invoke the target as `dotnet packer`

## Testing it out

While in the solution folder, run the following:

```bash

./pack.sh 

cd sample/ConsumingProject

dotnet restore

dotnet packer

```

> **Note:** if you are using Windows, use `pack.ps1` script instead of the \*.sh one.

## SampleTargets.PackerTarget

This folder contains the target implementation. It also specifies configuration within the project file to package the needed files into a nuget package. Note the `build` folder in there. It contains the targets that will extend the project file. You can read more about this approach on [NuGet documentation](https://docs.nuget.org/ndocs/create-packages/creating-a-package#including-msbuild-props-and-targets-in-a-package). 

You can create a nupkg out of this project by simply using the `dotnet pack` command.

## dotnet-packer

This is a very simple console application that allows the user to invoke MSBuild without having to learn MSBuild invocation syntax. It also demonstrates an approach to building CLI tools that can interact with the targets extensions. 

You can create a nupkg out of this project by simply using the `dotnet pack` command.

### NuGet bug

There's a bug in NuGet that doesn't include the `*.runtimeconfig.json` in the nupkg. For your project, you'll need to copy these lines from dotnet-packer.csproj to your csproj file, changing `dotnet-packer.runtimeconfig.json` to match your project name.

```  

    

      true

      lib\$(TargetFramework)

    

  ```

## A short FAQ

### Is the tool neccessary if I just want to create a target?

No, it is not. You can have a target project just include the target and invoke it using `dotnet msbuild /t:`. The tool is just a nicer user experience. 

### When should I use which one?

Targets should be used if your extension depends on something from the build process (e.g. output) or if it needs/wants to extend something in the build process (e.g. run after a given step, depend on a given step). 

A tool should be used in those situations where there is no need to interact with the build process.