@halospv3/hce.shared-config
Version:
Automate commit message quality, changelogs, and CI/CD releases. Exports a semantic-release shareable configuration deserialized from this package's '.releaserc.yml'. Shared resources for .NET projects are also distributed with this package.
379 lines • 14.7 kB
TypeScript
import { type } from 'arktype';
import { CaseInsensitiveMap } from '../CaseInsensitiveMap.js';
import { type BooleanString, type EmptyOrBooleanString } from '../utils/miscTypes.js';
import { type ClassLike, type WithProto } from '../utils/reflection.js';
import { MSBuildProjectProperties, type Class_MSBPP } from './MSBuildProjectProperties.js';
declare const Type_RepositoryType: type<'' | 'git' | 'tfs'>;
declare const Type_SymbolPackageFormat: type<'symbols.nupkg' | 'snupkg'>;
/**
* A readonly record of a .csproj or .fsproj with NuGet configuration properties in
* addition to those specified by {@link MSBuildProjectProperties}. This record
* should be considered immutable. A new instance should be constructed from MSBuild's evaluation output.
* @see https://learn.microsoft.com/en-us/nuget/reference/msbuild-targets#pack-target-inputs
*/
export declare class NugetProjectProperties extends MSBuildProjectProperties {
private _isPackable;
private _suppressDependenciesWhenPacking;
private _packageVersion;
private _packageId;
private _packageDescription;
private _authors;
private _copyright;
private _packageRequireLicenseAcceptance;
private _developmentDependency;
private _packageLicenseExpression;
private _packageLicenseFile;
private _packageProjectUrl;
private _packageIcon;
private _packageReleaseNotes;
private _packageReadmeFile;
private _packageTags;
private _packageOutputPath;
private _includeSymbols;
private _includeSource;
private _packageType;
private _isTool;
private _repositoryUrl;
private _repositoryType;
private _repositoryCommit;
private _symbolPackageFormat;
private _noPackageAnalysis;
private _minClientVersion;
private _includeBuiltOutput;
private _includeContentInPack;
private _buildOutputTargetFolder;
private _contentTargetFolders;
private _nuspecFile;
private _nuspecBasePath;
private _nuspecProperties;
private _title;
private _company;
private _product;
/**
* Initialize a readonly record of an MSBuild project's properties, including those related to NuGet.
* @param msbuildProjectFullPath @inheritdoc {@link NugetProjectProperties.MSBuildProjectFullPath}
* @param properties The dictionary returned by MSBuild's `-getProperty:propname,...` argument
*/
constructor(msbuildProjectFullPath: string, properties: CaseInsensitiveMap<string, string>);
/**
* @returns A string-formatted boolean. If 'false', the project's `Pack`
* Target (if available) will no-op.
*
* Default: `"true"`
*/
get IsPackable(): BooleanString;
/**
* @returns `"true"` or `"false"`. If "true", the package's dependencies are
* excluded from the generated NuGet package.
*
* Default: `"false"`
*/
get SuppressDependenciesWhenPacking(): BooleanString;
/**
* @returns A semver-compatible version number in the form
* Major.Minor.Patch[-Suffix], where -Suffix identifies prerelease versions.
*
* Default: {@link Version}
* @example "1.0.0", "1.0.0-beta", "1.0.0-beta-00345"
*/
get PackageVersion(): string;
/**
* @returns The ID of the resulting NuGet package.
*
* Default: {@link AssemblyName}
*/
get PackageId(): string;
/**
* @returns A long description of the package for UI display.
*
* Default: {@link Description}
*/
get PackageDescription(): string;
/**
* @returns A semicolon-separated list of the package's authors, matching the
* profile names on nuget.org. These are displayed in the NuGet Gallery on
* nuget.org and are used to cross-reference packages by the same authors.
*
* Default: {@link AssemblyName `AssemblyName`}
*/
get Authors(): string;
/**
* @returns Copyright details for the package.
*
* Default: `''`
*/
get Copyright(): string;
/**
* @returns A string-formatted boolean. If `"true"`, the client must prompt the
* consumer to accept the package license before installing the package.
*
* Default: `"false"`
*/
get PackageRequireLicenseAcceptance(): BooleanString;
/**
* This boolean only affects the package created from the project.
* @see
* {@link https://github.com/NuGet/Home/wiki/DevelopmentDependency-support-for-PackageReference DevelopmentDependency support for PackageReference}
* @returns A string-formatted boolean. If `"true"`, the package is marked as
* a development-only dependency and is prevented from being included as a
* dependency in other packages. With PackageReference (NuGet 4.8+), this flag
* also means that compile-time assets are excluded from compilation.
*
* Default: `''` (`false`-y)
*/
get DevelopmentDependency(): EmptyOrBooleanString;
/**
* @returns The {@link https://spdx.org/licenses/ SPDX license identifier} or
* expression.
*
* Default: `''`
* @see
* {@link https://learn.microsoft.com/en-us/nuget/reference/msbuild-targets#packing-a-license-expression-or-a-license-file Packing a license expression or a license file}
* @example "Apache-2.0"
*/
get PackageLicenseExpression(): string;
/**
* @returns The path to a license file within the package if you're using a
* custom license or a license that hasn't been assigned an SPDX identifier.
*
* Default: `''`
*/
get PackageLicenseFile(): string;
/**
* @returns The package's project URL.
*
* Default: `''`
*/
get PackageProjectUrl(): string;
/**
* @returns The package icon path, relative to the root of the package.
*
* Default: `''`
* @description You must pack the referenced icon image file. By default, it
* is not packed.
* @see
* {@link https://learn.microsoft.com/en-us/nuget/reference/msbuild-targets#packing-an-icon-image-file Packing an icon image file},
* {@link https://learn.microsoft.com/en-us/nuget/reference/nuspec#icon icon metadata}
*/
get PackageIcon(): string;
/**
* @returns Release notes for the package.
*
* Default: `''`
*/
get PackageReleaseNotes(): string;
/**
* @returns The path of the package's README file relative to the package's
* root.
*
* Default: `''`
* @description You must pack the referenced readme file. By default, it is
* not packed.
*/
get PackageReadmeFile(): string;
/**
* @returns A semicolon-delimited list of tags that designates the package.
*
* Default : `''`
*/
get PackageTags(): string;
/**
* @returns A relative or absolute path determining the where the packed
* package will be dropped.
*
* Default: {@link OutputPath}
*/
get PackageOutputPath(): string;
/**
* @returns A string-formatted boolean indicating whether the package should
* create an additional symbols package when the project is packed. The
* symbols package's format is controlled by the `SymbolPackageFormat`
* property.
*
* Default: `''` (false-y)
* @description When using `MSBuild -t:pack -p:IncludeSymbols=true`, the
* corresponding .pdb files are copied along with other output files (.dll,
* .exe, .winmd, .xml, .json, .pri). Note that setting `IncludeSymbols=true`
* creates a regular package and a symbols package.
* @see
* {@link https://learn.microsoft.com/en-us/nuget/reference/msbuild-targets#includesymbols IncludeSymbols}
*/
get IncludeSymbols(): EmptyOrBooleanString;
/**
* @returns A string-formatted boolean indicating whether the pack process
* should create a source package. The source package contains the library's
* source code as well as PDB files. Source files are put under the
* `src/ProjectName` directory in the resulting package file.
*
* Default: `''` (false-y)
* @see
* {@link https://learn.microsoft.com/en-us/nuget/reference/msbuild-targets#includesource IncludeSource}
*/
get IncludeSource(): EmptyOrBooleanString;
/**
* @returns A semicolon-separated list of tags indicating the package's
* intended use. Custom types are allowed, but cannot be installed via Visual
* Studio nor nuget.exe. See https://github.com/NuGet/Home/issues/10468.
*
* Package types can be version e.g. `PackageType1, 1.0.0.0;PackageType2`
*
* Default: `''`
* @example "Dependency ", "DotnetTool", "MSBuildSdk", "Template"
* @see {@link https://learn.microsoft.com/en-us/nuget/create-packages/set-package-type?tabs=dotnet Set a NuGet package type}
*/
get PackageType(): string;
/**
* @returns A string-formatted boolean specifying whether all output files are
* copied to the *tools* folder instead of the *lib* folder.
*
* Default: `''` (false-y)
* @see
* {@link https://learn.microsoft.com/en-us/nuget/reference/msbuild-targets#istool IsTool}
*/
get IsTool(): EmptyOrBooleanString;
/**
* @returns The repository URL used to clone or retrieve source code.
*
* Default: `''`
* @example "https://github.com/NuGet/NuGet.Client.git".
*/
get RepositoryUrl(): string;
/**
* @returns The repository type.
*
* Default: `''`
* @example "git", "fts"
*/
get RepositoryType(): typeof Type_RepositoryType.inferOut;
/**
* @returns The (optional) repository commit or changeset to indicate which
* source the package was built against. {@link RepositoryUrl} must also be
* specified for this property to be included.
*
* Default: `''`
* @description This is evaluated only during the "Pack" and "Publish"
* Targets. If using nuget.exe or Visual Studio, NuGet 4.7.0 or later is
* required.
* @example "0e4d1b598f350b3dc675018d539114d1328189ef"
*/
get RepositoryCommit(): string;
/**
* @returns A string specifying the format of the symbols package. If
* "symbols.nupkg", a legacy symbols package is created with a .symbols.nupkg
* extension containing PDBs, DLLs, and other output files. If "snupkg", a
* snupkg symbol package is created containing the portable PDBs. The default
* is "symbols.nupkg".
*
* Default: "symbols.nupkg"
* @example "symbols.nupkg", "snupkg"
*/
get SymbolPackageFormat(): typeof Type_SymbolPackageFormat.inferOut;
/**
* @returns A string-formatted boolean specifying that `pack` should not run
* package analysis after building the package.
*
* Default: `''` (false-y)
*/
get NoPackageAnalysis(): EmptyOrBooleanString;
/**
* @returns A string specifying the minimum version of the NuGet client that
* can install this package, enforced by nuget.exe and the Visual Studio
* Package Manager.
*
* Default: `''`
*/
get MinClientVersion(): string;
/**
* @returns A string-formatted boolean value specifying whether the build
* output assemblies should be packed into the .nupkg file or not.
*
* Default: `"true"`
*/
get IncludeBuildOutput(): BooleanString;
/**
* @returns A string-formatted boolean specifying whether any items that have
* a type of Content are included in the resulting package automatically.
*
* Default: `"true"`
*/
get IncludeContentInPack(): BooleanString;
/**
* @returns The output directory of the output assemblies relative to the root
* of the package. The output assemblies (and other output files) are copied
* into their respective framework folders.
*
* Default: `''`
* @see
* {@link https://learn.microsoft.com/en-us/nuget/reference/msbuild-targets#output-assemblies Output assemblies}
*/
get BuildOutputTargetFolder(): string;
/**
* @returns A semicolon-separated list of default locations of where all the
* content files should go if `PackagePath` is not specified for them.
*
* Default: `"content;contentFiles"`
* @see
* {@link https://learn.microsoft.com/en-us/nuget/reference/msbuild-targets#including-content-in-a-package Including content in a package}
*/
get ContentTargetFolders(): string;
/**
* @returns The relative or absolute path to the `*.nuspec` file being used
* for packing. If specified, it's used **exclusively** for packaging
* information, and any information in the projects is not used.
*
* Default: `''`
* @see
* {@link https://learn.microsoft.com/en-us/nuget/reference/msbuild-targets#packing-using-a-nuspec-file Packing using a .nuspec}
*/
get NuspecFile(): string;
/**
* @returns The base path for the *.nuspec* file.
*
* Default: `''`
* @see
* {@link https://learn.microsoft.com/en-us/nuget/reference/msbuild-targets#packing-using-a-nuspec-file Packing using a .nuspec}
*/
get NuspecBasePath(): string;
/**
* @returns A semicolon-separated list of key=value pairs.
*
* Default: `''`
* @see
* {@link https://learn.microsoft.com/en-us/nuget/reference/msbuild-targets#packing-using-a-nuspec-file Packing using a .nuspec}
*/
get NuspecProperties(): string;
/**
* @returns A human-friendly title of the package, typically used in UI displays as
* on nuget.org and the Package Manager in Visual Studio.
* Default: {@link PackageId}
*/
get Title(): string;
/**
* @returns Company name or information.
*
* Default: {@link Authors}
*/
get Company(): string;
/**
* @returns Product name or information.
*
* Default: {@link AssemblyName}
*/
get Product(): string;
}
export type Class_NPP = ClassLike<typeof NugetProjectProperties & WithProto<Class_MSBPP>>;
export declare class NPPGetterNames {
private static _prototypeChain;
private static get PrototypeChain();
private static _instanceGetters;
private static _instanceGettersRecursive;
private static _StaticGetters;
private static _StaticGettersRecursive;
static get InstanceGetters(): Exclude<keyof NugetProjectProperties, keyof MSBuildProjectProperties>[];
static get InstanceGettersRecursive(): (keyof NugetProjectProperties)[];
static get StaticGetters(): never[];
static get StaticGettersRecursive(): ('prototype' | 'GetFullPath')[];
}
export {};
/** @module NugetProjectProperties */
//# sourceMappingURL=NugetProjectProperties.d.ts.map