@halospv3/hce.shared-config 3.0.0-develop.2 → 3.0.0-develop.21

package/mjs/dotnet/MSBuildProjectProperties.mjs

@@ -0,0 +1,260 @@
+import { strictEqual } from 'node:assert/strict';
+import { existsSync } from 'node:fs';
+import node_path from 'node:path';
+import { CaseInsensitiveMap } from '../CaseInsensitiveMap.mjs';
+
+/**
+ * Known properties. Additional properties may be added upon request.
+ *
+ * todo: add Reserved properties, Well-Known properties, Common properties, and more. Maybe as sub classes.
+ * See:
+ * - {@link https://learn.microsoft.com/en-us/visualstudio/msbuild/msbuild-reserved-and-well-known-properties?view=vs-2022 MSBuild Reserved and Well-known Properties}
+ * - {@link https://learn.microsoft.com/en-us/visualstudio/msbuild/common-msbuild-project-properties?view=vs-2022 Common MSBuild project properties}
+ * - {@link https://learn.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props Microsoft.NET.Sdk}
+ * - {@link https://learn.microsoft.com/en-us/aspnet/core/razor-pages/web-sdk?view=aspnetcore-8.0&toc=%2Fdotnet%2Fnavigate%2Ftools-diagnostics%2Ftoc.json&bc=%2Fdotnet%2Fbreadcrumb%2Ftoc.json#properties Microsoft.NET.Sdk.Web}
+ * - {@link https://learn.microsoft.com/en-us/aspnet/core/razor-pages/sdk?view=aspnetcore-8.0&toc=%2Fdotnet%2Fnavigate%2Ftools-diagnostics%2Ftoc.json&bc=%2Fdotnet%2Fbreadcrumb%2Ftoc.json Microsoft.NET.Sdk.Razor}
+ * - {@link https://learn.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props-desktop Microsoft.NET.Sdk.Desktop}
+ */
+class MSBuildProjectProperties {
+  // #region static
+
+  /**
+   * Resolve the given path if it is not absolute. If the path exists, it is returned. Else, an Error is thrown.
+   * @param path The full file path of an MSBuild project.
+   * @returns The absolute path to the MSBuild project file.
+   * @throws {Error} if the path cannot be resolved to an existing file.
+   */
+  static GetFullPath(path) {
+    if (!node_path.isAbsolute(path)) path = node_path.resolve(path);
+    if (!existsSync(path)) throw new Error(`${node_path.basename(path)} could not be found at "${path}"`);
+    return path;
+  }
+
+  /**
+   * Note: This method may remove elements from {@link properties}.\
+   * Try to get an element from {@link properties} by its {@link key}.
+   * If an element is found, it is removed and the value of the element is returned.
+   * Otherwise, `undefined` is returned.
+   * @param properties The CaseInsensitiveMap of properties passed to the constructor.
+   * @param key The key of the property to get from {@link properties}
+   * @returns If found, the value of the `[string, string]` tuple found in {@link properties}. Else, `undefined`.
+   */
+  static getAndForget(properties, key) {
+    const v = properties.get(key);
+    if (v !== undefined) properties.delete(key);
+    return v;
+  }
+
+  // #endregion static
+  // #endregion static
+
+  // #region private
+  _msbuildProjectFullPath;
+  _assemblyName;
+  _baseIntermediateOutputPath;
+  _baseOutputPath;
+  _description;
+  _intermediateOutputPath;
+  _outDir;
+  _outputPath;
+  _runtimeIdentifier;
+  _runtimeIdentifiers;
+  _targetFramework;
+  _targetFrameworks;
+  _version;
+  _versionPrefix;
+  _versionSuffix;
+  // #endregion private
+
+  constructor(msbuildProjectFullPath, properties) {
+    // runtime type checks
+    strictEqual(typeof msbuildProjectFullPath, 'string', new TypeError(`msbuildProjectFullPath should be a string, not ${typeof msbuildProjectFullPath}!`));
+    strictEqual(properties instanceof CaseInsensitiveMap, true, `arg 'properties' should be instanceof ${CaseInsensitiveMap.name}`);
+    strictEqual([...properties.keys()].every(v => typeof v === 'string'), true, 'all keys in arg \'properties\' should be strings');
+    this._msbuildProjectFullPath = MPP.GetFullPath(msbuildProjectFullPath);
+    this._assemblyName = MPP.getAndForget(properties, 'AssemblyName');
+    this._description = MPP.getAndForget(properties, 'Description');
+    this._outputPath = MPP.getAndForget(properties, 'OutputPath');
+    this._runtimeIdentifier = MPP.getAndForget(properties, 'RuntimeIdentifier');
+    this._runtimeIdentifiers = MPP.getAndForget(properties, 'RuntimeIdentifiers');
+    this._targetFramework = MPP.getAndForget(properties, 'TargetFramework');
+    this._targetFrameworks = MPP.getAndForget(properties, 'TargetFrameworks');
+    this._version = MPP.getAndForget(properties, 'Version');
+    this._versionPrefix = MPP.getAndForget(properties, 'VersionPrefix');
+    this._versionSuffix = MPP.getAndForget(properties, 'VersionSuffix');
+    // rest
+    for (const key of properties.keys()) {
+      const value = MPP.getAndForget(properties, key);
+      if (value !== undefined) {
+        Object.defineProperty(this, key, {
+          value: value,
+          writable: false,
+          enumerable: true,
+          configurable: true
+        });
+      }
+    }
+  }
+  get MSBuildProjectFullPath() {
+    return this._msbuildProjectFullPath ??= '';
+  }
+
+  /**
+   * @returns The name of the assembly.
+   *
+   * Default: {@link https://learn.microsoft.com/en-us/visualstudio/msbuild/msbuild-reserved-and-well-known-properties#:~:text=MSBuildProjectDirectory,-Reserved MSBuildProjectDirectory}
+   */
+  get AssemblyName() {
+    return this._assemblyName ??= '';
+  }
+
+  /**
+   * @returns The top-level folder where all configuration-specific intermediate output
+   * folders are created. The default value is `obj\`.
+   * @example
+   * ```xml
+   * <BaseIntermediateOutputPath>c:\xyz\obj\</BaseIntermediateOutputPath>
+   * ```
+   */
+  get BaseIntermediateOutputPath() {
+    return this._baseIntermediateOutputPath ??= '';
+  }
+
+  /**
+   * @returns The base path for the output file.
+   * If it's set, MSBuild uses `OutputPath = $(BaseOutputPath)\$(Configuration)\`.
+   * @example ```xml
+   * <BaseOutputPath>c:\xyz\bin\</BaseOutputPath>
+   * ```
+   */
+  get BaseOutputPath() {
+    return this._baseOutputPath ??= '';
+  }
+
+  /**
+   * A long description for the assembly.
+   * If {@link NugetProperties.PackageDescription} is not specified, then this property is also used as the description of the package.
+   * @returns The value of the `Description` property.
+   */
+  get Description() {
+    return this._description ??= '';
+  }
+
+  /**
+   * @returns The full intermediate output path as derived from
+   * {@link BaseIntermediateOutputPath}, if no path is specified.
+   * @example "obj\\debug\\"
+   */
+  get IntermediateOutput() {
+    return this._intermediateOutputPath ??= '';
+  }
+
+  /**
+   * @returns The final output location for the project or solution.
+   * When you build a solution, OutDir can be used to gather multiple project outputs in one location.
+   * In addition, OutDir is included in AssemblySearchPaths used for resolving references.
+   * @example
+   * `bin/Debug`
+   */
+  get OutDir() {
+    return this._outDir ??= '';
+  }
+
+  /**
+   * @returns The path to the output directory, relative to the project
+   * directory.
+   * @example
+   * `bin/Debug`
+   * /// non-AnyCPU builds
+   * `bin/Debug/${Platform}`
+   */
+  get OutputPath() {
+    return this._outputPath ??= '';
+  }
+
+  /**
+   * Set Version -OR- VersionPrefix.
+   * @returns The value of the `Version` property.
+   *
+   * Default: `"1.0.0"`
+   */
+  get Version() {
+    return this._version ??= '1.0.0';
+  }
+
+  /**
+   * Set Version -OR- VersionPrefix.\
+   * Setting {@link NugetProperties.PackageVersion} overwrites {@link VersionPrefix}
+   * @returns The MAJOR.MINOR.PATCH string of the version.
+   * @see {@link VersionSuffix}
+   */
+  get VersionPrefix() {
+    return this._versionPrefix ??= '';
+  }
+
+  /**
+   * The effect of this property on the package version depends on the values of the Version and VersionPrefix properties, as shown in the following table:
+   * | Properties with values | Package version |
+   * | ---------------------- | --------------- |
+   * | None                   | 1.0.0           |
+   * | Version                | $(Version)      |
+   * | VersionPrefix only     | $(VersionPrefix) |
+   * | VersionSuffix only     | 1.0.0-$(VersionSuffix) |
+   * | VersionPrefix and VersionSuffix | $(VersionPrefix)-$(VersionSuffix) |
+   * \
+   * Setting {@link PackageVersion} overwrites {@link VersionSuffix}
+   * @returns The string appended to the end of the MAJOR.MINOR.PATCH semver string (i.e. {@link VersionPrefix})
+   */
+  get VersionSuffix() {
+    return this._versionSuffix ??= '';
+  }
+
+  /**
+   * @returns The {@link https://learn.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#targetframework Target Framework}
+   * @see
+   * https://learn.microsoft.com/en-us/nuget/reference/target-frameworks#supported-frameworks
+   * https://learn.microsoft.com/en-us/dotnet/standard/frameworks
+   */
+  get TargetFramework() {
+    return this._targetFramework ??= '';
+  }
+
+  /**
+   * @returns The {@link https://learn.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#targetframeworks Target Frameworks} (plural)
+   * @see
+   * https://learn.microsoft.com/en-us/nuget/reference/target-frameworks#supported-frameworks
+   * https://learn.microsoft.com/en-us/dotnet/standard/frameworks
+   */
+  get TargetFrameworks() {
+    return this._targetFrameworks ??= '';
+  }
+
+  /**
+   * @returns
+   * > The {@link https://learn.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#runtimeidentifier `Runtime Identifier`} property lets you specify a single runtime
+   * > identifier (RID) for the project. The RID enables publishing a
+   * > self-contained deployment.
+   * @see
+   * https://learn.microsoft.com/en-us/dotnet/core/rid-catalog
+   */
+  get RuntimeIdentifier() {
+    return this._runtimeIdentifier ??= '';
+  }
+
+  /**
+   * @returns
+   * > The {@link https://learn.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#runtimeidentifiers `RuntimeIdentifiers`} property lets you specify a
+   * > semicolon-delimited list of runtime identifiers (RIDs) for the project.
+   * > Use this property if you need to publish for multiple runtimes.
+   * > `RuntimeIdentifiers` is used at restore time to ensure the right assets
+   * > are in the graph.
+   * @see
+   * https://learn.microsoft.com/en-us/dotnet/core/rid-catalog
+   */
+  get RuntimeIdentifiers() {
+    return this._runtimeIdentifiers ??= '';
+  }
+}
+const MPP = MSBuildProjectProperties;
+export { MSBuildProjectProperties };
+//# sourceMappingURL=MSBuildProjectProperties.mjs.map

package/mjs/dotnet/MSBuildProjectProperties.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"MSBuildProjectProperties.mjs","sources":["../../src/dotnet/MSBuildProjectProperties.ts"],"sourcesContent":null,"names":[],"mappings":";;;;;AAIA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAM,wBAAwB,CAAC;AACtC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,OAAO,WAAW,CAAC,IAAI,EAAE;AAC3B,IAAI,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC;AACnE,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,IAAI,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AACzG,IAAI,OAAO,IAAI;AACf;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,OAAO,YAAY,CAAC,UAAU,EAAE,GAAG,EAAE;AACvC,IAAI,MAAM,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC;AACjC,IAAI,IAAI,CAAC,KAAK,SAAS,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC;AAC/C,IAAI,OAAO,CAAC;AACZ;;AAEA;AACA;;AAEA;AACA,EAAE,uBAAuB;AACzB,EAAE,aAAa;AACf,EAAE,2BAA2B;AAC7B,EAAE,eAAe;AACjB,EAAE,YAAY;AACd,EAAE,uBAAuB;AACzB,EAAE,OAAO;AACT,EAAE,WAAW;AACb,EAAE,kBAAkB;AACpB,EAAE,mBAAmB;AACrB,EAAE,gBAAgB;AAClB,EAAE,iBAAiB;AACnB,EAAE,QAAQ;AACV,EAAE,cAAc;AAChB,EAAE,cAAc;AAChB;;AAEA,EAAE,WAAW,CAAC,sBAAsB,EAAE,UAAU,EAAE;AAClD;AACA,IAAI,WAAW,CAAC,OAAO,sBAAsB,EAAE,QAAQ,EAAE,IAAI,SAAS,CAAC,CAAC,+CAA+C,EAAE,OAAO,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3J,IAAI,WAAW,CAAC,UAAU,YAAY,kBAAkB,EAAE,IAAI,EAAE,CAAC,sCAAsC,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;AACnI,IAAI,WAAW,CAAC,CAAC,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,CAAC,EAAE,IAAI,EAAE,kDAAkD,CAAC;AACnI,IAAI,IAAI,CAAC,uBAAuB,GAAG,GAAG,CAAC,WAAW,CAAC,sBAAsB,CAAC;AAC1E,IAAI,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,YAAY,CAAC,UAAU,EAAE,cAAc,CAAC;AACrE,IAAI,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC,UAAU,EAAE,aAAa,CAAC;AACnE,IAAI,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,YAAY,CAAC,UAAU,EAAE,YAAY,CAAC;AACjE,IAAI,IAAI,CAAC,kBAAkB,GAAG,GAAG,CAAC,YAAY,CAAC,UAAU,EAAE,mBAAmB,CAAC;AAC/E,IAAI,IAAI,CAAC,mBAAmB,GAAG,GAAG,CAAC,YAAY,CAAC,UAAU,EAAE,oBAAoB,CAAC;AACjF,IAAI,IAAI,CAAC,gBAAgB,GAAG,GAAG,CAAC,YAAY,CAAC,UAAU,EAAE,iBAAiB,CAAC;AAC3E,IAAI,IAAI,CAAC,iBAAiB,GAAG,GAAG,CAAC,YAAY,CAAC,UAAU,EAAE,kBAAkB,CAAC;AAC7E,IAAI,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAC;AAC3D,IAAI,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,YAAY,CAAC,UAAU,EAAE,eAAe,CAAC;AACvE,IAAI,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,YAAY,CAAC,UAAU,EAAE,eAAe,CAAC;AACvE;AACA,IAAI,KAAK,MAAM,GAAG,IAAI,UAAU,CAAC,IAAI,EAAE,EAAE;AACzC,MAAM,MAAM,KAAK,GAAG,GAAG,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,CAAC;AACrD,MAAM,IAAI,KAAK,KAAK,SAAS,EAAE;AAC/B,QAAQ,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,EAAE;AACzC,UAAU,KAAK,EAAE,KAAK;AACtB,UAAU,QAAQ,EAAE,KAAK;AACzB,UAAU,UAAU,EAAE,IAAI;AAC1B,UAAU,YAAY,EAAE;AACxB,SAAS,CAAC;AACV;AACA;AACA;AACA,EAAE,IAAI,sBAAsB,GAAG;AAC/B,IAAI,OAAO,IAAI,CAAC,uBAAuB,KAAK,EAAE;AAC9C;;AAEA;AACA;AACA;AACA;AACA;AACA,EAAE,IAAI,YAAY,GAAG;AACrB,IAAI,OAAO,IAAI,CAAC,aAAa,KAAK,EAAE;AACpC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,IAAI,0BAA0B,GAAG;AACnC,IAAI,OAAO,IAAI,CAAC,2BAA2B,KAAK,EAAE;AAClD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,IAAI,cAAc,GAAG;AACvB,IAAI,OAAO,IAAI,CAAC,eAAe,KAAK,EAAE;AACtC;;AAEA;AACA;AACA;AACA;AACA;AACA,EAAE,IAAI,WAAW,GAAG;AACpB,IAAI,OAAO,IAAI,CAAC,YAAY,KAAK,EAAE;AACnC;;AAEA;AACA;AACA;AACA;AACA;AACA,EAAE,IAAI,kBAAkB,GAAG;AAC3B,IAAI,OAAO,IAAI,CAAC,uBAAuB,KAAK,EAAE;AAC9C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,IAAI,MAAM,GAAG;AACf,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,EAAE;AAC9B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,IAAI,UAAU,GAAG;AACnB,IAAI,OAAO,IAAI,CAAC,WAAW,KAAK,EAAE;AAClC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,IAAI,OAAO,GAAG;AAChB,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,OAAO;AACpC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,IAAI,aAAa,GAAG;AACtB,IAAI,OAAO,IAAI,CAAC,cAAc,KAAK,EAAE;AACrC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,IAAI,aAAa,GAAG;AACtB,IAAI,OAAO,IAAI,CAAC,cAAc,KAAK,EAAE;AACrC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,IAAI,eAAe,GAAG;AACxB,IAAI,OAAO,IAAI,CAAC,gBAAgB,KAAK,EAAE;AACvC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,IAAI,gBAAgB,GAAG;AACzB,IAAI,OAAO,IAAI,CAAC,iBAAiB,KAAK,EAAE;AACxC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,IAAI,iBAAiB,GAAG;AAC1B,IAAI,OAAO,IAAI,CAAC,kBAAkB,KAAK,EAAE;AACzC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,IAAI,kBAAkB,GAAG;AAC3B,IAAI,OAAO,IAAI,CAAC,mBAAmB,KAAK,EAAE;AAC1C;AACA;AACA,MAAM,GAAG,GAAG,wBAAwB;;;;"}

package/mjs/dotnet/NugetProjectProperties.d.ts

@@ -0,0 +1,379 @@
+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';
+import type { StringType } from 'arktype/internal/methods/string.ts';
+declare const Type_RepositoryType: StringType<'' | 'git' | 'tfs'>;
+declare const Type_SymbolPackageFormat: StringType<'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

package/mjs/dotnet/NugetProjectProperties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NugetProjectProperties.d.ts","sourceRoot":"","sources":["../../src/dotnet/NugetProjectProperties.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAGL,KAAK,aAAa,EAClB,KAAK,oBAAoB,EAC1B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAGL,KAAK,SAAS,EAEd,KAAK,SAAS,EACf,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,wBAAwB,EAAE,KAAK,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC3F,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAErE,QAAA,MAAM,mBAAmB,EAAE,UAAU,CAAC,EAAE,GAAG,KAAK,GAAG,KAAK,CAA0B,CAAC;AACnF,QAAA,MAAM,wBAAwB,EAAE,UAAU,CAAC,eAAe,GAAG,QAAQ,CAAsC,CAAC;AAE5G;;;;;GAKG;AACH,qBAAa,sBAAuB,SAAQ,wBAAwB;IAElE,OAAO,CAAC,WAAW,CAA4B;IAC/C,OAAO,CAAC,gCAAgC,CAA4B;IACpE,OAAO,CAAC,eAAe,CAAqB;IAC5C,OAAO,CAAC,UAAU,CAAqB;IACvC,OAAO,CAAC,mBAAmB,CAAqB;IAChD,OAAO,CAAC,QAAQ,CAAqB;IACrC,OAAO,CAAC,UAAU,CAAqB;IACvC,OAAO,CAAC,gCAAgC,CAA4B;IACpE,OAAO,CAAC,sBAAsB,CAAmC;IACjE,OAAO,CAAC,yBAAyB,CAAqB;IACtD,OAAO,CAAC,mBAAmB,CAAqB;IAChD,OAAO,CAAC,kBAAkB,CAAqB;IAC/C,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,oBAAoB,CAAqB;IACjD,OAAO,CAAC,kBAAkB,CAAqB;IAC/C,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,kBAAkB,CAAqB;IAC/C,OAAO,CAAC,eAAe,CAAmC;IAC1D,OAAO,CAAC,cAAc,CAAmC;IACzD,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,OAAO,CAAmC;IAClD,OAAO,CAAC,cAAc,CAAqB;IAC3C,OAAO,CAAC,eAAe,CAAiC;IACxD,OAAO,CAAC,iBAAiB,CAAqB;IAC9C,OAAO,CAAC,oBAAoB,CAAyC;IACrE,OAAO,CAAC,kBAAkB,CAAmC;IAC7D,OAAO,CAAC,iBAAiB,CAAqB;IAC9C,OAAO,CAAC,mBAAmB,CAA4B;IACvD,OAAO,CAAC,qBAAqB,CAA4B;IACzD,OAAO,CAAC,wBAAwB,CAAqB;IACrD,OAAO,CAAC,qBAAqB,CAAqB;IAClD,OAAO,CAAC,WAAW,CAAqB;IACxC,OAAO,CAAC,eAAe,CAAqB;IAC5C,OAAO,CAAC,iBAAiB,CAAqB;IAC9C,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,QAAQ,CAAqB;IACrC,OAAO,CAAC,QAAQ,CAAqB;IAGrC;;;;OAIG;gBAED,sBAAsB,EAAE,MAAM,EAC9B,UAAU,EAAE,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC;IA8EhD;;;;;OAKG;IACH,IAAI,UAAU,IAAI,aAAa,CAE9B;IAED;;;;;OAKG;IACH,IAAI,+BAA+B,IAAI,aAAa,CAEnD;IAED;;;;;;OAMG;IACH,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED;;;;OAIG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;;;OAIG;IACH,IAAI,kBAAkB,IAAI,MAAM,CAE/B;IAED;;;;;;OAMG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED;;;;OAIG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;;;;OAKG;IACH,IAAI,+BAA+B,IAAI,aAAa,CAEnD;IAED;;;;;;;;;;OAUG;IACH,IAAI,qBAAqB,IAAI,oBAAoB,CAEhD;IAED;;;;;;;;OAQG;IACH,IAAI,wBAAwB,IAAI,MAAM,CAErC;IAED;;;;;OAKG;IACH,IAAI,kBAAkB,IAAI,MAAM,CAE/B;IAED;;;;OAIG;IACH,IAAI,iBAAiB,IAAI,MAAM,CAE9B;IAED;;;;;;;;;OASG;IACH,IAAI,WAAW,IAAI,MAAM,CAExB;IAED;;;;OAIG;IACH,IAAI,mBAAmB,IAAI,MAAM,CAEhC;IAED;;;;;;;OAOG;IACH,IAAI,iBAAiB,IAAI,MAAM,CAE9B;IAED;;;;OAIG;IACH,IAAI,WAAW,IAAI,MAAM,CAExB;IAED;;;;;OAKG;IACH,IAAI,iBAAiB,IAAI,MAAM,CAE9B;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,cAAc,IAAI,oBAAoB,CAEzC;IAED;;;;;;;;;OASG;IACH,IAAI,aAAa,IAAI,oBAAoB,CAExC;IAED;;;;;;;;;;OAUG;IACH,IAAI,WAAW,IAAI,MAAM,CAExB;IAED;;;;;;;OAOG;IACH,IAAI,MAAM,IAAI,oBAAoB,CAEjC;IAED;;;;;OAKG;IACH,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED;;;;;OAKG;IACH,IAAI,cAAc,IAAI,OAAO,mBAAmB,CAAC,QAAQ,CAExD;IAED;;;;;;;;;;OAUG;IACH,IAAI,gBAAgB,IAAI,MAAM,CAE7B;IAED;;;;;;;;;OASG;IACH,IAAI,mBAAmB,IAAI,OAAO,wBAAwB,CAAC,QAAQ,CAElE;IAED;;;;;OAKG;IACH,IAAI,iBAAiB,IAAI,oBAAoB,CAE5C;IAED;;;;;;OAMG;IACH,IAAI,gBAAgB,IAAI,MAAM,CAE7B;IAED;;;;;OAKG;IACH,IAAI,kBAAkB,IAAI,aAAa,CAEtC;IAED;;;;;OAKG;IACH,IAAI,oBAAoB,IAAI,aAAa,CAExC;IAED;;;;;;;;OAQG;IACH,IAAI,uBAAuB,IAAI,MAAM,CAEpC;IAED;;;;;;;OAOG;IACH,IAAI,oBAAoB,IAAI,MAAM,CAEjC;IAED;;;;;;;;OAQG;IACH,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED;;;;;;OAMG;IACH,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED;;;;;;OAMG;IACH,IAAI,gBAAgB,IAAI,MAAM,CAE7B;IAED;;;;OAIG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;CACF;AAED,MAAM,MAAM,SAAS,GAAG,SAAS,CAC/B,OAAO,sBAAsB,GAC3B,SAAS,CAAC,WAAW,CAAC,CACzB,CAAC;AAGF,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAC,eAAe,CAA2C;IACzE,OAAO,CAAC,MAAM,KAAK,cAAc,GAEhC;IAED,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAsF;IACrH,OAAO,CAAC,MAAM,CAAC,yBAAyB,CAA+C;IACvF,OAAO,CAAC,MAAM,CAAC,cAAc,CAAsB;IACnD,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAsD;IAE5F,WAAkB,eAAe,IAAI,OAAO,CAAC,MAAM,sBAAsB,EAAE,MAAM,wBAAwB,CAAC,EAAE,CAE3G;IAED,WAAkB,wBAAwB,IAAI,CAAC,MAAM,sBAAsB,CAAC,EAAE,CAI7E;IAED,WAAkB,aAAa,IAAI,KAAK,EAAE,CAEzC;IAED,WAAkB,sBAAsB,IAAI,CAAC,WAAW,GAAG,aAAa,CAAC,EAAE,CAI1E;CACF;;AAED,qCAAqC"}