Belp.Build.Packinf 0.6.0

dotnet add package Belp.Build.Packinf --version 0.6.0                
NuGet\Install-Package Belp.Build.Packinf -Version 0.6.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Belp.Build.Packinf" Version="0.6.0">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Belp.Build.Packinf --version 0.6.0                
#r "nuget: Belp.Build.Packinf, 0.6.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Belp.Build.Packinf as a Cake Addin
#addin nuget:?package=Belp.Build.Packinf&version=0.6.0

// Install Belp.Build.Packinf as a Cake Tool
#tool nuget:?package=Belp.Build.Packinf&version=0.6.0                

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/.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.6.0 131 6/15/2024
0.5.0 98 6/8/2024
0.4.0 427 11/3/2023
0.3.1 178 7/23/2023
0.3.0 178 7/23/2023
0.2.0 180 6/26/2023
0.1.0 166 6/8/2023

## 🆕 Features
- Added the `$(IncludeContentInContentFiles)` property for opting-out of including `Assets/content` in `contentFiles/`
- Added the `%(IncludeInContentFiles)` item metadata for opting-out of including `Assets/content` in `contentFiles/`

## 🐞 Fixes
- Packages created with Packinf are now more similar to packages created by NuGet