@halospv3/hce.shared-config 2.2.4 → 2.3.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Noah Sherwin
+Copyright (c) 2024 Noah Sherwin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/README.md

@@ -1,14 +1,15 @@
 # HCE.Shared
+
 Infrastructure resources shared with other HaloSPV3 repositories.
 
 It is recommended to "install" this repo via [Node Package Manager](#npm)
 
 ## Usage
 
-
 ### 1. Install `@halospv3/hce.shared-config`
 
 This project is packaged and published via NPM. As such...
+
 ```sh
 npm install --save-dev @halospv3/hce.shared-config
 ```
@@ -18,53 +19,61 @@ npm install --save-dev @halospv3/hce.shared-config
 ```json
 // package.json
 {
-  "release": {
-    "extends": [
-        "@halospv3/hce.shared-config"
-    ]
-  }
+	"release": {
+		"extends": ["@halospv3/hce.shared-config"]
+	}
 }
 ```
 
-WARNING! Defining a property will *overwrite* the previous value. Arrays and objects are *not* merged. You can...
+WARNING! Defining a property will _overwrite_ the previous value. Arrays and objects are _not_
+merged. You can...
+
 - Assign to top-level variables to avoid modifying the plugins array.
 - Write your config in CJS and manually merge objects and arrays.
 
 **Configs**
+
 - `hce.shared-config`: [static/.releaserc.yml](static/.releaserc.yml)
 - [dotnet/.releaserc.cjs](dotnet/.releaserc.cjs) based on [BinToss/GroupBox.Avalonia's Semantic Release config](https://github.com/BinToss/GroupBox.Avalonia).
 
 **Notable Plugin Properties**
+
 - [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer#options)
-  - preset (set to conventionalcommits)
-  - parserOpts
-  - releaseRules
+	- preset (set to conventionalcommits)
+	- parserOpts
+	- releaseRules
 - [`@semantic-release/release-notes-generator`](https://github.com/semantic-release/release-notes-generator#options)
-  - preset (set to conventionalcommits)
-  - parserOpts
-  - writerOpts
+	- preset (set to conventionalcommits)
+	- parserOpts
+	- writerOpts
 - [`@semantic-release/changelog`](https://github.com/semantic-release/changelog#options)
-  - changelogFile (default: CHANGELOG.md)
+	- changelogFile (default: CHANGELOG.md)
 - [`@semantic-release/git`](https://github.com/semantic-release/git#options)
-  - assets (default: ['CHANGELOG.md', 'package.json', 'package-lock.json', 'npm-shrinkwrap.json'])
+	- assets (default: ['CHANGELOG.md', 'package.json', 'package-lock.json', 'npm-shrinkwrap.json'])
 - `@semantic-release/exec`
-  - prepareCmd
+	- prepareCmd
 - [`@semantic-release/github`](https://github.com/semantic-release/github#options)
-  - assets
-  - draftRelease (default: false)
+	- assets
+	- draftRelease (default: false)
 
 ### 3. Set Up CommitLint
 
 ```json
 // package.json
 {
-  "commitlint": {
-    "extends": [
-        "./node_modules/@halospv3/hce.shared-config/commitlint.config.ts"
-    ]
-  }
+	"commitlint": {
+		"extends": ["@halospv3/hce.shared-config/commitLintConfig"]
+	}
 }
 ```
+or
+
+```ts
+/* eslint-disable import/no-default-export */
+import commitlintConfig from '@halospv3/hce.shared-config/commitLintConfig';
+
+export default commitlintConfig;
+```
 
 ```sh
 npx husky
@@ -73,39 +82,39 @@ npx husky add .husky/commit-msg  'npx --no -- commitlint --edit ${1}'
 
 ### 4. (dotnet) Add/Edit Directory.Build.props
 
-
 > Example Directory.Build.props from [BinToss/GroupBox.Avalonia](https://github.com/BinToss/GroupBox.Avalonia)
 
 ```xml
 <Project>
-  <PropertyGroup>
-    <RepoRoot Condition="'$(RepoRoot)' == ''">$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory), '.git/index'))</RepoRoot>
-    <HCESharedDir Condition="'$(HCESharedDir)' == ''">$(RepoRoot)node_modules/@halospv3/hce.shared-config/</HCESharedDir>
-    <GitVersion_Path Condition="'$(GitVersion_Path)' == ''">$(HCESharedDir)GitVersion.yml</GitVersion_Path>
-    <AvaloniaVersion>11.0.10</AvaloniaVersion>
-  </PropertyGroup>
-
-  <PropertyGroup Condition="'$(CI)' == 'true'">
-    <Configuration>Release</Configuration>
-    <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
-    <Deterministic>true</Deterministic>
-  </PropertyGroup>
-
-  <Import Project="$(HCESharedDir)/dotnet/ZipPublishDir.targets" />
+	<PropertyGroup>
+		<RepoRoot Condition="'$(RepoRoot)' == ''">$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory), '.git/index'))</RepoRoot>
+		<HCESharedDir Condition="'$(HCESharedDir)' == ''">$(RepoRoot)node_modules/@halospv3/hce.shared-config/</HCESharedDir>
+		<GitVersion_Path Condition="'$(GitVersion_Path)' == ''">$(HCESharedDir)GitVersion.yml</GitVersion_Path>
+		<AvaloniaVersion>11.0.10</AvaloniaVersion>
+	</PropertyGroup>
+
+	<PropertyGroup Condition="'$(CI)' == 'true'">
+		<Configuration>Release</Configuration>
+		<ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
+		<Deterministic>true</Deterministic>
+	</PropertyGroup>
+
+	<Import Project="$(HCESharedDir)/dotnet/ZipPublishDir.targets" />
 </Project>
 ```
 
-----
+---
+
+Add the file `Directory.Build.props` to your repository's root directory or solution directory if
+you haven't already. Then, add the following properties:
 
-Add the file `Directory.Build.props` to your repository's root directory or solution directory if you haven't already.
-Then, add the following properties:
 ```xml
 <Project> <!-- Minimal requirements for dotnet/msbuild integration -->
-    <Import Project="./node_modules/@halospv3/hce.shared-config/dotnet/ZipPublishDir.targets" />
-    <PropertyGroup>
-        <ProjectRootDir>$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory), '.git/index'))</ProjectRootDir>
-        <HCESharedDir>$(ProjectRootDir)/node_modules/@halospv3/hce.shared-config/</HCESharedDir>
-    </PropertyGroup>
+	<Import Project="./node_modules/@halospv3/hce.shared-config/dotnet/ZipPublishDir.targets" />
+	<PropertyGroup>
+		<ProjectRootDir>$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory), '.git/index'))</ProjectRootDir>
+		<HCESharedDir>$(ProjectRootDir)/node_modules/@halospv3/hce.shared-config/</HCESharedDir>
+	</PropertyGroup>
 </Project>
 ```
 
@@ -119,30 +128,40 @@ These may evaluate to the following:
 
 #### CI/CD-Only Properties
 
-If you want properties set only in a CI/CD environment (e.g. a GitHub workflow), add the following conditional property group to the props file:
+If you want properties set only in a CI/CD environment (e.g. a GitHub workflow), add the following
+conditional property group to the props file:
+
 ```xml, diff
 <Project>
-    <PropertyGroup>
-        ...
-    </PropertyGroup>
-
-    <PropertyGroup Condition=" '$(CI)' == 'true' ">
-        <Configuration>Release</Configuration>
-        <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
-        <Deterministic>true</Deterministic>
-   </PropertyGroup>
+	<PropertyGroup>
+		...
+	</PropertyGroup>
+
+	<PropertyGroup Condition=" '$(CI)' == 'true' ">
+		<Configuration>Release</Configuration>
+		<ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
+		<Deterministic>true</Deterministic>
+	</PropertyGroup>
 </Project>
 ```
-> Any properties added to this conditional property group will only be evaluated when `$(CI)` is defined either as a property or as an environment variable. This is most useful for properties such as `ContinuousIntegrationBuild`.
+
+> Any properties added to this conditional property group will only be evaluated when `$(CI)` is
+> defined either as a property or as an environment variable. This is most useful for properties
+> such as `ContinuousIntegrationBuild`.
 
 #### GitVersion
 
-By default, GitVersion will search only the "current directory" for `GitVersion.yml`. GitVersion has a lesser-known CLI argument, "Path" which allows users to specify the path to `GitVersion.yml`. The NuGet package `GitVersion.MSBuild` exposes this as the read-write property `$(GitVersion_Path)`.
+By default, GitVersion will search only the "current directory" for `GitVersion.yml`. GitVersion has
+a lesser-known CLI argument, "Path" which allows users to specify the path to `GitVersion.yml`. The
+NuGet package `GitVersion.MSBuild` exposes this as the read-write property `$(GitVersion_Path)`.
+
+If you're satisfied by [dotnet/GitVersion.yml](dotnet/GitVersion.yml), you can configure GitVersion
+to use this config file. GitVersion does not have 'extend' functionality typical of Node.js
+packages.
 
-If you're satisfied by [dotnet/GitVersion.yml](dotnet/GitVersion.yml), you can configure GitVersion to use this config file. GitVersion does not have 'extend' functionality typical of Node.js packages.
 ```xml
 <PropertyGroup>
-    <GitVersion_Path>$(ProjectRootDir)/node_modules/@halospv3/hce.shared-config/dotnet/GitVersion.yml</GitVersion_Path>
+	<GitVersion_Path>$(ProjectRootDir)/node_modules/@halospv3/hce.shared-config/dotnet/GitVersion.yml</GitVersion_Path>
 </PropertyGroup>
 ```
 
@@ -150,24 +169,31 @@ If you're satisfied by [dotnet/GitVersion.yml](dotnet/GitVersion.yml), you can c
 
 ### Need your VersionInfo before the actual release?
 
-If you want to use this information in other Semantic Release steps, you'll need `semantic-release-export-data`.
+If you want to use this information in other Semantic Release steps, you'll need
+`semantic-release-export-data`.
+
 ```sh
 npm i -D semantic-release-export-data
 ```
 
 Run the following to preview the version:
+
 ```sh
 npx semantic-release --dry-run --plugins "@semantic-release/commit-analyzer,semantic-release-export-data"
 ```
-If the first plugin doesn't run into any issues and infers a version bump from unreleased commits, it will print the next version to the console.
-The [second plugin](https://github.com/felipecrs/semantic-release-export-data#readme) will export the next version and other information as GitHub Action Step exports.
 
-### Don't intend to publish a Node package? 
+If the first plugin doesn't run into any issues and infers a version bump from unreleased commits,
+it will print the next version to the console. The
+[second plugin](https://github.com/felipecrs/semantic-release-export-data#readme) will export the
+next version and other information as GitHub Action Step exports.
+
+### Don't intend to publish a Node package?
 
 Add the following to `package.json`:
+
 ```json
 {
-    "private": true,
+	"private": true,
 }
 ```
 
@@ -177,33 +203,35 @@ Add the following to `package.json`:
 
 ```yml
 jobs:
-  release:
-    steps:
-    - uses: actions/checkout@v3
-    - name: dotnet build/publish; copy release artifacts to './publish/'
-      uses: ./node_modules/@halospv3/hce.shared/dotnet/.github/workflows/dotnet-release.yml
-        with:
-          projects:
-            - src/lib/lib.csproj
-            - src/lib-sample/sample.csproj
+	release:
+		steps:
+		- uses: actions/checkout@v3
+		- name: dotnet build/publish; copy release artifacts to './publish/'
+			uses: ./node_modules/@halospv3/hce.shared/dotnet/.github/workflows/dotnet-release.yml
+				with:
+					projects:
+					- src/lib/lib.csproj
+					- src/lib-sample/sample.csproj
 ```
 
 ### Ease Semantic Release Configuration
 
-JSON/YAML configs *could* have merge-edit capabilities driven by data from custom, top-level properties. Each property would contain the command moniker and the config data (parameters) similar to RPC implementations.
-This will require quite a bit of datatype validation behind the scenes.
+JSON/YAML configs _could_ have merge-edit capabilities driven by data from custom, top-level
+properties. Each property would contain the command moniker and the config data (parameters) similar
+to RPC implementations. This will require quite a bit of datatype validation behind the scenes.
+
 ```json
 {
-  "modify_plugins": {
-    "op": "Append",
-    "data": [
-      [
-        "newplugin",
-        {
-          "newpluginoption": true
-        }
-      ]
-    ]
-  }
+	"modify_plugins": {
+		"op": "Append",
+		"data": [
+			[
+				"newplugin",
+				{
+					"newpluginoption": true
+				}
+			]
+		]
+	}
 }
-```
+```

package/cjs/commitlintConfig-wrapper.mjs

@@ -0,0 +1,6 @@
+// Bundled with Packemon: https://packemon.dev
+// This is an MJS wrapper for a sibling CJS file
+
+import data from './commitlintConfig.cjs';
+
+export default data;

package/cjs/commitlintConfig.cjs

@@ -0,0 +1,14 @@
+'use strict';
+
+// CJS compatibility; This enum cannot be required.
+const disabled = 0;
+const commitlintConfig = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'body-max-line-length': [disabled],
+    'footer-max-line-length': [disabled],
+    'header-max-length': [disabled]
+  }
+};
+module.exports = commitlintConfig;
+//# sourceMappingURL=commitlintConfig.cjs.map

package/cjs/commitlintConfig.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"commitlintConfig.cjs","sources":["../src/commitlintConfig.ts"],"sourcesContent":null,"names":[],"mappings":";;AAAA;AACA,MAAM,QAAQ,GAAG,CAAC,CAAC;AACd,MAAC,gBAAgB,GAAG;AACzB,EAAE,OAAO,EAAE,CAAC,iCAAiC,CAAC;AAC9C,EAAE,KAAK,EAAE;AACT,IAAI,sBAAsB,EAAE,CAAC,QAAQ,CAAC;AACtC,IAAI,wBAAwB,EAAE,CAAC,QAAQ,CAAC;AACxC,IAAI,mBAAmB,EAAE,CAAC,QAAQ,CAAC;AACnC,GAAG;AACH;;;;"}

package/cjs/commitlintConfig.d.ts

@@ -0,0 +1,4 @@
+import { type UserConfig } from '@commitlint/types';
+declare const commitlintConfig: UserConfig;
+export default commitlintConfig;
+//# sourceMappingURL=commitlintConfig.d.ts.map

package/cjs/commitlintConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commitlintConfig.d.ts","sourceRoot":"","sources":["../src/commitlintConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,KAAK,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAI7E,QAAA,MAAM,gBAAgB,EAAE,UAOvB,CAAC;AAGF,eAAe,gBAAgB,CAAC"}

package/cjs/dotnet/MSBuildProject.cjs

@@ -0,0 +1,85 @@
+'use strict';
+
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+const node_child_process = require('node:child_process');
+const MSBuildProjectProperties = require('./MSBuildProjectProperties.cjs');
+
+/**
+ * All pre-defined properties of {@link MSBuildProjectProperties} except FullPath
+ */
+const MSBuildProjectPreDefinedProperties = Object.keys(new MSBuildProjectProperties.MSBuildProjectProperties('', false)).filter(p => p !== 'FullPath');
+/** @todo Experimental and may be removed in a later release.
+ * A cache for your evaluated MSBuild Projects.
+ */
+const MSBuildEvaluatedProjects = [];
+class MSBuildProject {
+  Properties;
+
+  /**
+   *
+   * @param fullPath The full path of the .NET MSBuild project file.
+   * @param customProperties MSBuild properties to evaluate in addition to those pre-defined in {@link MSBuildProjectProperties}
+   */
+  constructor(fullPath, customProperties) {
+    // super();
+    this.Properties = MSBuildProject.evaluateProperties(fullPath, customProperties ?? []);
+  }
+
+  /**
+   *
+   * `dotnet msbuild src -getProperty:TargetFramework -getProperty:TargetFrameworks -getProperty:RuntimeIdentifiers -getProperty:IsTrimmable`
+   *
+   * ...produces...
+   *
+   * ```json
+   * {
+   *   "Properties": {
+   *     "TargetFramework": "net6.0",
+   *     "TargetFrameworks": "",
+   *     "RuntimeIdentifiers": "win7-x64;win7-x86;win-arm64;linux-x64;linux-arm64",
+   *     "IsTrimmable": "true",
+   *   }
+   * }
+   * ```
+   *
+   * ...which can can be parsed like...
+   * ```js
+   * var ridArray = JSON.parse(out).Properties.RuntimeIdentifiers.split(';');
+   * ```
+   */
+  static evaluateProperties(fullPath, properties) {
+    const evaluatedProps = new MSBuildProjectProperties.MSBuildProjectProperties(fullPath);
+
+    // if a default prop isn't in properties, add it
+    const defaultProps = MSBuildProjectPreDefinedProperties;
+    for (const defaultProp of defaultProps) {
+      if (!properties.includes(defaultProp)) properties.push(defaultProp);
+    }
+    const getPropArgs = properties.map(propName => `-getProperty:${propName}`);
+    // should return a single value OR string-encoded JSON object with 'Properties' object-type property.
+    const out = node_child_process.execFileSync('dotnet', ['msbuild', evaluatedProps.FullPath, ...getPropArgs], {
+      encoding: 'utf8',
+      stdio: 'pipe'
+    }).trim();
+    if (out.startsWith('MSBUILD : error')) throw new Error(out);
+    let props;
+    if (out.startsWith('{')) {
+      const obj = JSON.parse(out);
+      if ("Properties" in obj && typeof obj.Properties === 'object' && obj.Properties !== null) props = obj.Properties;
+      throw new Error('When evaluating properties with MSBuild, "Properties" could not be found in the deserialized JSON object.');
+    } else {
+      props = {
+        [properties[0]]: out.trim()
+      };
+    }
+    return _objectSpread(_objectSpread({}, evaluatedProps), props);
+  }
+}
+exports.MSBuildEvaluatedProjects = MSBuildEvaluatedProjects;
+exports.MSBuildProject = MSBuildProject;
+exports.MSBuildProjectPreDefinedProperties = MSBuildProjectPreDefinedProperties;
+//# sourceMappingURL=MSBuildProject.cjs.map

package/cjs/dotnet/MSBuildProject.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"MSBuildProject.cjs","sources":["../../src/dotnet/MSBuildProject.ts"],"sourcesContent":null,"names":["MSBuildProjectProperties","execFileSync"],"mappings":";;;;;AAGA;AACA;AACA;AACY,MAAC,kCAAkC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAIA,iDAAwB,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,UAAU,EAAE;AACrI;AACA;AACA;AACY,MAAC,wBAAwB,GAAG,GAAG;AACpC,MAAM,cAAc,CAAC;AAC5B,EAAE,UAAU,CAAC;AACb;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,WAAW,CAAC,QAAQ,EAAE,gBAAgB,EAAE;AAC1C;AACA,IAAI,IAAI,CAAC,UAAU,GAAG,cAAc,CAAC,kBAAkB,CAAC,QAAQ,EAAE,gBAAgB,IAAI,EAAE,CAAC,CAAC;AAC1F,GAAG;AACH;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,OAAO,kBAAkB,CAAC,QAAQ,EAAE,UAAU,EAAE;AAClD,IAAI,MAAM,cAAc,GAAG,IAAIA,iDAAwB,CAAC,QAAQ,CAAC,CAAC;AAClE;AACA;AACA,IAAI,MAAM,YAAY,GAAG,kCAAkC,CAAC;AAC5D,IAAI,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;AAC5C,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC1E,KAAK;AACL,IAAI,MAAM,WAAW,GAAG,UAAU,CAAC,GAAG,CAAC,QAAQ,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;AAC/E;AACA,IAAI,MAAM,GAAG,GAAGC,+BAAY,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC,QAAQ,EAAE,GAAG,WAAW,CAAC,EAAE;AAC7F,MAAM,QAAQ,EAAE,MAAM;AACtB,MAAM,KAAK,EAAE,MAAM;AACnB,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;AACd,IAAI,IAAI,GAAG,CAAC,UAAU,CAAC,iBAAiB,CAAC,EAAE,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;AAChE,IAAI,IAAI,KAAK,CAAC;AACd,IAAI,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;AAC7B,MAAM,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAClC,MAAM,IAAI,YAAY,IAAI,GAAG,IAAI,OAAO,GAAG,CAAC,UAAU,KAAK,QAAQ,IAAI,GAAG,CAAC,UAAU,KAAK,IAAI,EAAE,KAAK,GAAG,GAAG,CAAC,UAAU,CAAC;AACvH,MAAM,MAAM,IAAI,KAAK,CAAC,2GAA2G,CAAC,CAAC;AACnI,KAAK,MAAM;AACX,MAAM,KAAK,GAAG;AACd,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE;AACnC,OAAO,CAAC;AACR,KAAK;AACL,IAAI,OAAO;AACX,MAAM,GAAG,cAAc;AACvB,MAAM,GAAG,KAAK;AACd,KAAK,CAAC;AACN,GAAG;AACH;;;;;;"}

package/cjs/dotnet/MSBuildProject.d.ts

@@ -0,0 +1,42 @@
+import { MSBuildProjectProperties } from './MSBuildProjectProperties.js';
+/**
+ * All pre-defined properties of {@link MSBuildProjectProperties} except FullPath
+ */
+export declare const MSBuildProjectPreDefinedProperties: string[];
+/** @todo Experimental and may be removed in a later release.
+ * A cache for your evaluated MSBuild Projects.
+ */
+export declare const MSBuildEvaluatedProjects: MSBuildProject[];
+export declare class MSBuildProject {
+    Properties: MSBuildProjectProperties;
+    /**
+     *
+     * @param fullPath The full path of the .NET MSBuild project file.
+     * @param customProperties MSBuild properties to evaluate in addition to those pre-defined in {@link MSBuildProjectProperties}
+     */
+    constructor(fullPath: string, customProperties?: string[]);
+    /**
+     *
+     * `dotnet msbuild src -getProperty:TargetFramework -getProperty:TargetFrameworks -getProperty:RuntimeIdentifiers -getProperty:IsTrimmable`
+     *
+     * ...produces...
+     *
+     * ```json
+     * {
+     *   "Properties": {
+     *     "TargetFramework": "net6.0",
+     *     "TargetFrameworks": "",
+     *     "RuntimeIdentifiers": "win7-x64;win7-x86;win-arm64;linux-x64;linux-arm64",
+     *     "IsTrimmable": "true",
+     *   }
+     * }
+     * ```
+     *
+     * ...which can can be parsed like...
+     * ```js
+     * var ridArray = JSON.parse(out).Properties.RuntimeIdentifiers.split(';');
+     * ```
+     */
+    static evaluateProperties(fullPath: string, properties: string[]): MSBuildProjectProperties;
+}
+//# sourceMappingURL=MSBuildProject.d.ts.map

package/cjs/dotnet/MSBuildProject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MSBuildProject.d.ts","sourceRoot":"","sources":["../../src/dotnet/MSBuildProject.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,kCAAkC,UAEd,CAAC;AAClC;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,cAAc,EAAO,CAAC;AAE7D,qBAAa,cAAc;IAC1B,UAAU,EAAE,wBAAwB,CAAC;IAErC;;;;OAIG;gBACS,QAAQ,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,EAAE;IAKzD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,wBAAwB;CAiC3F"}

package/cjs/dotnet/MSBuildProjectProperties.cjs

@@ -0,0 +1,22 @@
+'use strict';
+
+const node_fs = require('node:fs');
+const path = require('node:path');
+
+/**
+ * Known properties. Additional properties may be added upon request.
+ */
+class MSBuildProjectProperties {
+  FullPath = '';
+  TargetFramework = '';
+  TargetFrameworks = '';
+  RuntimeIdentifier = '';
+  RuntimeIdentifiers = '';
+  constructor(fullPath, exists = true) {
+    this.FullPath = fullPath;
+    if (!path.isAbsolute(this.FullPath)) this.FullPath = path.resolve(this.FullPath);
+    if (!node_fs.existsSync(this.FullPath) && exists) throw new Error(`Project ${path.basename(this.FullPath)} could not be found at "${this.FullPath}"`);
+  }
+}
+exports.MSBuildProjectProperties = MSBuildProjectProperties;
+//# sourceMappingURL=MSBuildProjectProperties.cjs.map

package/cjs/dotnet/MSBuildProjectProperties.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"MSBuildProjectProperties.cjs","sources":["../../src/dotnet/MSBuildProjectProperties.ts"],"sourcesContent":null,"names":["isAbsolute","resolve","existsSync","basename"],"mappings":";;;;;AAGA;AACA;AACA;AACO,MAAM,wBAAwB,CAAC;AACtC,EAAE,QAAQ,GAAG,EAAE,CAAC;AAChB,EAAE,eAAe,GAAG,EAAE,CAAC;AACvB,EAAE,gBAAgB,GAAG,EAAE,CAAC;AACxB,EAAE,iBAAiB,GAAG,EAAE,CAAC;AACzB,EAAE,kBAAkB,GAAG,EAAE,CAAC;AAC1B,EAAE,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,EAAE;AACvC,IAAI,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC7B,IAAI,IAAI,CAACA,eAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,GAAGC,YAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAC3E,IAAI,IAAI,CAACC,kBAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,MAAM,EAAE,MAAM,IAAI,KAAK,CAAC,CAAC,QAAQ,EAAEC,aAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,wBAAwB,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7I,GAAG;AACH;;;;"}

package/cjs/dotnet/MSBuildProjectProperties.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Known properties. Additional properties may be added upon request.
+ */
+export declare class MSBuildProjectProperties {
+    [Property: string]: string;
+    FullPath: string;
+    TargetFramework: string;
+    TargetFrameworks: string;
+    RuntimeIdentifier: string;
+    RuntimeIdentifiers: string;
+    constructor(fullPath: string, exists?: boolean);
+}
+//# sourceMappingURL=MSBuildProjectProperties.d.ts.map

package/cjs/dotnet/MSBuildProjectProperties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MSBuildProjectProperties.d.ts","sourceRoot":"","sources":["../../src/dotnet/MSBuildProjectProperties.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,qBAAa,wBAAwB;IACpC,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3B,QAAQ,SAAM;IAEd,eAAe,SAAM;IAErB,gBAAgB,SAAM;IAEtB,iBAAiB,SAAM;IAEvB,kBAAkB,SAAM;gBAEZ,QAAQ,EAAE,MAAM,EAAE,MAAM,UAAO;CAQ3C"}

package/cjs/dotnet/dotnetGHPR.cjs

@@ -0,0 +1,60 @@
+'use strict';
+
+// todo: support custom base URL for private GitHub instances
+async function tokenCanWritePackages(tokenEnvVar) {
+  const tokenValue = process.env[tokenEnvVar];
+  if (tokenValue === undefined) throw new TypeError(`The environment variable ${tokenEnvVar} is undefined!`);
+  const reqH = {
+    authorization: `token ${tokenValue}`
+  };
+  // CJS compatibility - import { request } from '@octokit/request
+  const request = (await import('@octokit/request')).request;
+  const response = await request('GET /', {
+    headers: reqH
+  });
+  const scopes = response.headers['x-oauth-scopes'];
+  if (scopes) {
+    return scopes.includes('write:packages') || scopes.includes('write:packages');
+  }
+  return false;
+}
+const GITHUB_REPOSITORY_OWNER = process.env.GITHUB_REPOSITORY_OWNER;
+const nugetGitHubUrlBase = 'https://nuget.pkg.github.com';
+const nugetGitHubUrl = GITHUB_REPOSITORY_OWNER ? `${nugetGitHubUrlBase}/${GITHUB_REPOSITORY_OWNER}/index.json` : undefined;
+
+/**
+ * Get a {@link NuGetRegistryInfo} for pushing to your GitHub Packages NuGet registry.
+ * todo: add support for private, custom GitHub instances. Token is only validated against github.com.
+ * @export
+ * @param {string} [tokenEnvVar="GITHUB_TOKEN"] The name of environment variable storing the GitHub Packages NuGet registry API key. Defaults to `"GITHUB_TOKEN"`;
+ * @param {string} [url=tokenEnvVar] The url of the GitHub Packages NuGet registry. Defaults to {@link nugetGitHubUrl}.
+ * @returns {(NuGetRegistryInfo | undefined)} a {@link NuGetRegistryInfo} object if {@link tokenEnvVar} and {@link url} are defined. Else, `undefined`.
+ * note: `url` defaults to job's repository owner's GitHub registry in GitHub Actions workflow. If GITHUB_REPOSITORY_OWNER is not defined, then an error will be logged and `undefined` will be returned.
+ */
+async function getGithubNugetRegistryPair(tokenEnvVar = 'GITHUB_TOKEN', url = nugetGitHubUrl) {
+  // yes, this is stupid. No, I won't change it.
+  const isTokenDefined = process.env[tokenEnvVar] !== undefined;
+  const isUrlDefined = url !== undefined;
+  const canTokenWritePackages = isTokenDefined ? await tokenCanWritePackages(tokenEnvVar) : false;
+  const errors = [];
+  if (!isTokenDefined) errors.push(new Error(`The environment variable ${tokenEnvVar} was specified as the source of the token to push a NuGet package to GitHub, but the environment variable does not exist.`));
+  if (!isUrlDefined) {
+    errors.push(new Error('The url for the GitHub Packages NuGet registry was undefined.\n' + 'If running in a GitHub Actions workflow, something is seriously wrong.\n' + 'If running in a different CI/CD pipeline and you wish to cross-push to GHPR, ensure GITHUB_REPOSITORY_OWNER is set correctly.\n'));
+  }
+  if (!canTokenWritePackages) {
+    // yes, this is a critical error that should be fixed before Semantic Release can succeed.
+    // yes, this is incredibly irritating to deal with in local runs.
+    errors.push(new Error('The provided GitHub token has insufficient permissions or is a fine-grained permissions token. Only class Personal Access Tokens (classic) or workflow tokens with `repo` or `write:packages` permission can push a package.'));
+  }
+
+  // conditions checked so `url` is certainly defined
+  if (isTokenDefined && isUrlDefined && canTokenWritePackages) return {
+    tokenEnvVar,
+    url
+  };
+  throw new Error(`One more more errors occurred when getting GHPR url-token pair. Errors:\n${errors.map(v => v.message).join('\n')}`);
+}
+exports.getGithubNugetRegistryPair = getGithubNugetRegistryPair;
+exports.nugetGitHubUrl = nugetGitHubUrl;
+exports.nugetGitHubUrlBase = nugetGitHubUrlBase;
+//# sourceMappingURL=dotnetGHPR.cjs.map

package/cjs/dotnet/dotnetGHPR.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"dotnetGHPR.cjs","sources":["../../src/dotnet/dotnetGHPR.ts"],"sourcesContent":null,"names":[],"mappings":";;AAAA;AACA,eAAe,qBAAqB,CAAC,WAAW,EAAE;AAClD,EAAE,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;AAC9C,EAAE,IAAI,UAAU,KAAK,SAAS,EAAE,MAAM,IAAI,SAAS,CAAC,CAAC,yBAAyB,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC;AAC7G,EAAE,MAAM,IAAI,GAAG;AACf,IAAI,aAAa,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AACxC,GAAG,CAAC;AACJ;AACA,EAAE,MAAM,OAAO,GAAG,CAAC,MAAM,OAAO,kBAAkB,CAAC,EAAE,OAAO,CAAC;AAC7D,EAAE,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE;AAC1C,IAAI,OAAO,EAAE,IAAI;AACjB,GAAG,CAAC,CAAC;AACL,EAAE,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;AACpD,EAAE,IAAI,MAAM,EAAE;AACd,IAAI,OAAO,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;AAClF,GAAG;AACH,EAAE,OAAO,KAAK,CAAC;AACf,CAAC;AACD,MAAM;AACN,EAAE,uBAAuB;AACzB,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;AACJ,MAAC,kBAAkB,GAAG,+BAA+B;AACrD,MAAC,cAAc,GAAG,uBAAuB,GAAG,CAAC,EAAE,kBAAkB,CAAC,CAAC,EAAE,uBAAuB,CAAC,WAAW,CAAC,GAAG,UAAU;AAClI;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,eAAe,0BAA0B,CAAC,WAAW,GAAG,cAAc,EAAE,GAAG,GAAG,cAAc,EAAE;AACrG;AACA,EAAE,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,SAAS,CAAC;AAChE,EAAE,MAAM,YAAY,GAAG,GAAG,KAAK,SAAS,CAAC;AACzC,EAAE,MAAM,qBAAqB,GAAG,cAAc,GAAG,MAAM,qBAAqB,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;AAClG,EAAE,MAAM,MAAM,GAAG,EAAE,CAAC;AACpB,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC,yBAAyB,EAAE,WAAW,CAAC,yHAAyH,CAAC,CAAC,CAAC,CAAC;AAClN,EAAE,IAAI,CAAC,YAAY,EAAE;AACrB,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,iEAAiE,GAAG,0EAA0E,GAAG,iIAAiI,CAAC,CAAC,CAAC;AAC/S,GAAG;AACH,EAAE,IAAI,CAAC,qBAAqB,EAAE;AAC9B;AACA;AACA,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,8NAA8N,CAAC,CAAC,CAAC;AAC3P,GAAG;AACH;AACA;AACA,EAAE,IAAI,cAAc,IAAI,YAAY,IAAI,qBAAqB,EAAE,OAAO;AACtE,IAAI,WAAW;AACf,IAAI,GAAG;AACP,GAAG,CAAC;AACJ,EAAE,MAAM,IAAI,KAAK,CAAC,CAAC,yEAAyE,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACvI;;;;;;"}

package/cjs/dotnet/dotnetGHPR.d.ts

@@ -0,0 +1,14 @@
+import type { NuGetRegistryInfo } from './dotnetHelpers.js';
+export declare const nugetGitHubUrlBase = "https://nuget.pkg.github.com";
+export declare const nugetGitHubUrl: string | undefined;
+/**
+ * Get a {@link NuGetRegistryInfo} for pushing to your GitHub Packages NuGet registry.
+ * todo: add support for private, custom GitHub instances. Token is only validated against github.com.
+ * @export
+ * @param {string} [tokenEnvVar="GITHUB_TOKEN"] The name of environment variable storing the GitHub Packages NuGet registry API key. Defaults to `"GITHUB_TOKEN"`;
+ * @param {string} [url=tokenEnvVar] The url of the GitHub Packages NuGet registry. Defaults to {@link nugetGitHubUrl}.
+ * @returns {(NuGetRegistryInfo | undefined)} a {@link NuGetRegistryInfo} object if {@link tokenEnvVar} and {@link url} are defined. Else, `undefined`.
+ * note: `url` defaults to job's repository owner's GitHub registry in GitHub Actions workflow. If GITHUB_REPOSITORY_OWNER is not defined, then an error will be logged and `undefined` will be returned.
+ */
+export declare function getGithubNugetRegistryPair(tokenEnvVar?: string, url?: string | undefined): Promise<NuGetRegistryInfo | undefined>;
+//# sourceMappingURL=dotnetGHPR.d.ts.map

package/cjs/dotnet/dotnetGHPR.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dotnetGHPR.d.ts","sourceRoot":"","sources":["../../src/dotnet/dotnetGHPR.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAoB5D,eAAO,MAAM,kBAAkB,iCAAiC,CAAC;AACjE,eAAO,MAAM,cAAc,oBAEf,CAAC;AAEb;;;;;;;;GAQG;AACH,wBAAsB,0BAA0B,CAC/C,WAAW,SAAiB,EAC5B,GAAG,GAAE,MAAM,GAAG,SAA0B,GACtC,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAsCxC"}