arthri / belp.build.packinf

A package that extends MSBuild to make it easier to make NuGet packages.

Belp.Build.Packinf

An MSBuild extension that makes it easier to create and maintain NuGet packages.

Installation

Requirements

• A project written in SDK-style. This includes any project for .NET Core(or newer) or .NET 5(or newer).

Install using an Editor

1. Locate the project file(for example, Project.csproj, Project.fsproj).
2. Open the project file in an editor.
3. Locate the an <ItemGroup>.
4. Add a new PackageReference element to the item group with the Include attribute set to Belp.Build.Packinf and the Version attribute set to 0.0.1. For example, <PackageReference Include="Belp.Build.Packinf" Version="0.0.1" />.
5. Run dotnet restore.

Uninstallation

1. Locate the project file(for example, Project.csproj, Project.fsproj).
2. Open the project file in an editor.
3. Locate the PackageReference element with an Include attribute set to Belp.Build.Packinf.
4. Delete the element.

Install using the .NET CLI

1. Open a terminal.
2. Navigate to the containing directory of the project file.
3. Run the command dotnet add package Belp.Build.Packinf.

Uninstallation

1. Open a terminal.
2. Navigate to the containing directory of the project file.
3. Run the command dotnet remove package Belp.Build.Packinf.

Install using Visual Studio Package Manager

1. Open Visual Studio.
2. Right click the project in the Solution Explorer.
3. Click on "Manage NuGet Packages".
4. Go to the "Browse" tab.
5. Search for Belp.Build.Packinf.
6. Install.

Uninstallation

1. Open Visual Studio.
2. Right click the project in the Solution Explorer.
3. Click on "Manage NuGet Packages".
4. Go to the "Installed" tab.
5. Click on Belp.Build.Packinf.
6. Click on "Uninstall".

Usage

_Package files

Files that are named _Package will be automatically renamed to $(PackageId) when packed. For example, if $(PackageId) is Belp.Build.XYZ and a file is named _Package.txt, it will be packed as Belp.Build.XYZ.txt. This feature makes it easier for forks to edit and maintain files that are required to be named in that manner.

Caution

Files named _Package or files containing a _Package folder in its path must have a file extension.

Assets/ folder

By default, all files inside Assets/ will be packed. This behavior can be disabled by setting $(EnableDefaultPackItems) to false.

Assets/content folder

All files in this folder will be packed into the package's content/ folder, as well as the contentFiles/ folder(s) matching the target frameworks of the project.

Assets can opt-out of automatic contentFiles/ packing globally by setting the MSBuild property $(IncludeContentInContentFiles) to false or individually by setting the item metadata %(IncludeInContentFiles) to false.

README file

Files that are named README(case-insensitive) and are placed beside the project will be packed as the package's README file. If no READMEs are present beside the project, and SourceLink is installed in the project, the file named README.md at the repository's root(if present) will be used instead. Only one README should be defined.

Autoasmver

Enabled by default, can be disabled by setting $(DisableAutoasmver) to true. Autoasmver will automatically set the assembly version of compiled assemblies to Major.0.0.0. Set $(DisableAutoasmver) to true to disable Autoasmver.

AutoCopyright

Enabled by default, can be disabled by setting $(DisableAutoCopyright) to true. AutoCopyright makes it easier to define the copyright. For example, the configuration below will result in the copyright notice Copyright (C) 2023 Arthri.\nAll Rights Reserved

  <ItemGroup>
    <CopyrightOwner Include="Arthri" Years="2023" />
  </ItemGroup>

Autorh

Enabled by default, can be disabled by setting $(DisableAutorh) to true. Autorh makes it easier to define authors. By default, all copyright owners are included as authors, so authors wouldn't need to be redefined. To opt-out of this feature, set the property $(IncludeCopyrightOwnersInAuthors) to false or exclude only some copyright owners by using the property $(DefaultAuthorCopyrightOwnerExcludes). The following example adds "John Doe" as an author, but does not include them in the copyright notice.

  <ItemGroup>
    <Author Include="John Doe" />
  </ItemGroup>

Library Placeholder

A library placeholder refers to a file named _._ in the NuGet package under the directories lib/**/_._. The purpose of this file is to indicate a package supports a target framework, but does not have any binaries for that target framework. This file can be added by setting the MSBuild property AddMetapackagePlaceholderLibrary to true in the project file.

Development

Prerequisites

• Install the .NET 7.0 SDK version 7.0.100 or newer.

Building with Visual Studio

1. Open Belp.SDK.Packinf.sln.
2. Open the Solution Explorer.
3. Right click on the project Belp.SDK.Packinf in the Solution Explorer.
4. Click on Pack.

Building with .NET CLI

1. Open a terminal in the repository root.
2. Run dotnet pack

Output

By default, the output is located in src/Belp.SDK.Packinf/Belp.SDK.Packinf/bin/Release/.