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

package/src/semanticReleaseConfigDotnet.ts

@@ -20,7 +20,7 @@ import { getEnvVarValue } from './utils/env.js';
 import { baseConfig } from './semanticReleaseConfig.js';
 import { NugetRegistryInfo } from './dotnet/NugetRegistryInfo.js';
 import { MSBuildProject } from './dotnet/MSBuildProject.js';
-import { NPPGetterNames } from './dotnet/NugetProjectProperties.js';
+import { insertPlugin } from './insertPlugins.js';
 
 type UnArray<T> = T extends (infer U)[] ? U : T;
 interface SRConfigDotnetOptions extends Omit<typeof baseConfig, 'plugins'> {
@@ -80,7 +80,7 @@ export class SemanticReleaseConfigDotnet {
         this._projectsToPublish = p;
       }
       else if (debug.enabled) {
-        debug.log(new Error('At least one project must be published. `projectsToPackAndPush` is empty and environment variable `PROJECTS_TO_PUBLISH` is undefined or empty.'));
+        debug(new Error('At least one project must be published. `projectsToPackAndPush` is empty and environment variable `PROJECTS_TO_PUBLISH` is undefined or empty.'));
       }
     }
 
@@ -91,7 +91,7 @@ export class SemanticReleaseConfigDotnet {
         this._projectsToPackAndPush = p;
       }
       else if (debug.enabled) {
-        debug.log(new Error('projectsToPackAndPush.length must be > 0 or PROJECTS_TO_PACK_AND_PUSH must be defined and contain at least one path.'));
+        debug(new Error('projectsToPackAndPush.length must be > 0 or PROJECTS_TO_PACK_AND_PUSH must be defined and contain at least one path.'));
       }
     }
 
@@ -120,91 +120,86 @@ export class SemanticReleaseConfigDotnet {
     afterPluginsIDs: string[],
     insertPluginIDs: string[],
     beforePluginsIDs: string[],
-  ) {
-    const pluginIDs = this.options.plugins.map(v =>
-      typeof v === 'string' ? v : v[0],
-    );
-
-    // if any beforePluginIDs are ordered before the last afterPlugin, throw. Impossible to sort.
-
-    const indexOfLastAfter = afterPluginsIDs
-      .filter(v => pluginIDs.includes(v))
-      .map(v => pluginIDs.indexOf(v))
-      .sort()
-      .find((_v, i, obj) => i === obj.length - 1);
-    if (!indexOfLastAfter)
-      throw new ReferenceError(
-        'An attempt to get the last element of an array returned undefined.',
-      );
-
-    const indicesOfBefore = beforePluginsIDs
-      .filter(v => pluginIDs.includes(v))
-      .map(v => pluginIDs.indexOf(v))
-      .sort();
-
-    // This for-of collects *all* sorting errors. The resulting AggregateError
-    // notifies the API user of *all* errors in the order rather than just the
-    // first error encountered.
-    const errors: Error[] = [];
-    for (const index of indicesOfBefore) {
-      if (index <= indexOfLastAfter) {
-        errors.push(
-          new Error(
-            `insertPlugin was instructed to insert one or more plugins after [${afterPluginsIDs.map(v => '"' + v + '"').join(', ')}] and before [${beforePluginsIDs.map(v => `"${v}"`).join(', ')}], but ${JSON.stringify(pluginIDs[indexOfLastAfter])} comes after ${JSON.stringify(pluginIDs[index])}!`,
-          ),
-        );
-      }
-    }
-    if (errors.length > 0)
-      throw new AggregateError(errors, 'One or more errors occurred while inserting plugin configs into the Semantic Release config!');
-
-    // insert plugin(s)
-    this.options.plugins.splice(
-      indexOfLastAfter + 1,
-      0,
-      ...insertPluginIDs.map(id =>
-        [id, {}] as [string, unknown],
-      ),
-    );
+  ): void {
+    this.options.plugins = insertPlugin(this.options.plugins, afterPluginsIDs, insertPluginIDs, beforePluginsIDs);
   }
 
   /**
    * generate dotnet commands for \@semantic-release/exec, appending commands with ' && ' when necessary.
-   * ?todo: change to builder method? e.g. static async SetupDotnetCommands(this: SemanticReleaseConfigDotnet): Promise<SemanticReleaseConfigDotnet>
-   * @async
+   *
+   * Note: All strings in {@link this.ProjectsToPackAndPush} will be converted to basic {@link NugetRegistryInfo} instances with default values.
+   * If you need specific NRI settings or you need to push to GitLab-like or GitHub-like registries, instantiate them instead of passing their paths.
+   * @todo change to builder method? e.g. static async SetupDotnetCommands(this: SemanticReleaseConfigDotnet): Promise<SemanticReleaseConfigDotnet>
+   * @todo Add options param to allow users to enable pushing to GitLab, GitHub, NuGet.org with default settings -OR- with entirely custom settings.
    * @see https://github.com/semantic-release/exec#usage
    */
   async setupDotnetCommands(): Promise<void> {
-    const srExecIndex = this.options.plugins.findIndex(
+    let srExecIndex = this.options.plugins.findIndex(
       v => v[0] === '@semantic-release/exec',
     );
+    if (srExecIndex === -1) {
+      const message = `\
+Unable to find\`['@semantic-release/exec', unknown]\` in plugins array!
+Appending it to the end of the array...This may cause an unexpected order of operations!`;
+      console.warn(message);
+      srExecIndex = this.options.plugins.push(['@semantic-release/exec', {}]) - 1;
+    }
+
     const execOptions = this.options.plugins[srExecIndex] as SRExecOptions;
 
-    // TODO: move configurePrepareCmd into SemanticReleaseConfigDotnet
     // ensure all packable projects are evaluated
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
     this._projectsToPackAndPush = await Promise.all(
-      this.ProjectsToPackAndPush.map(async (v) => {
-        if (typeof v === 'string') {
-          const msbp = await MSBuildProject.Evaluate({
-            FullName: v,
-            GetItem: [],
-            GetProperty: [
-              ...MSBuildProject.MatrixProperties,
-              ...NPPGetterNames.InstanceGettersRecursive,
-            ],
-            GetTargetResult: [],
-            Property: {},
-            Targets: ['Restore', 'Pack'],
-          });
-
-          this._evaluatedProjects.push(msbp);
-
-          return new NugetRegistryInfo({ project: msbp });
+      this._projectsToPackAndPush.map(async (project) => {
+        if (typeof project === 'string') {
+          const packableProjects = await Promise.all(
+            await MSBuildProject.PackableProjectsToMSBuildProjects(
+              [project],
+            ),
+          );
+          if (packableProjects.length === 0)
+            throw new Error('No MSBuildProject instances were returned!');
+          this._evaluatedProjects.push(...packableProjects);
+
+          // if the user doesn't want a defaulted NRI, they should pass their own NRI (or derived) instance.
+          return packableProjects.map(project => new NugetRegistryInfo({ project }));
         }
-        else return v;
+        else return [project];
       }),
-    );
+    ).then(p => p.flat()) as NugetRegistryInfo[];
+
     // todo: double-check token-testing commands. Are they formatted prepended correctly?
+    const verifyConditionsCmdAppendix = await Promise.all(
+      this._projectsToPackAndPush
+        .map(async project =>
+          await project.PackDummyPackage({})
+            .then(() =>
+              project.GetPushDummyCommand({}),
+            ),
+        ),
+    ).then(cmds =>
+      cmds.join(' && '),
+    );
+    execOptions.verifyConditionsCmd
+      = execOptions.verifyConditionsCmd && execOptions.verifyConditionsCmd.trim().length > 0
+        ? `${execOptions.verifyConditionsCmd} && ${verifyConditionsCmdAppendix}`
+        : verifyConditionsCmdAppendix;
+
+    const verifyReleaseCmdAppendix = await Promise.all(
+      this.ProjectsToPackAndPush
+        .filter(project =>
+          typeof project !== 'string',
+        ).map(project =>
+          project.GetIsNextVersionAlreadyPublishedCommand(),
+        ),
+    ).then(cmds =>
+      cmds.join(' && '),
+    );
+    execOptions.verifyReleaseCmd
+      = execOptions.verifyReleaseCmd && execOptions.verifyReleaseCmd.trim().length > 0
+        ? `${execOptions.verifyReleaseCmd} && ${verifyReleaseCmdAppendix}`
+        : verifyConditionsCmdAppendix;
+
     const prepareCmdAppendix = await configurePrepareCmd(
       this._projectsToPublish,
       this._projectsToPackAndPush,
@@ -212,7 +207,7 @@ export class SemanticReleaseConfigDotnet {
 
     // 'ZipPublishDir' zips each publish folder to ./publish/*.zip
     execOptions.prepareCmd
-      = execOptions.prepareCmd !== undefined && execOptions.prepareCmd.length > 0
+      = execOptions.prepareCmd && execOptions.prepareCmd.trim().length > 0
         ? `${execOptions.prepareCmd} && ${prepareCmdAppendix}`
         : prepareCmdAppendix;
 
@@ -223,7 +218,7 @@ export class SemanticReleaseConfigDotnet {
         this._projectsToPackAndPush,
       );
       execOptions.publishCmd
-        = execOptions.publishCmd && execOptions.publishCmd.length > 0
+        = execOptions.publishCmd && execOptions.publishCmd.trim().length > 0
           ? `${execOptions.publishCmd} && ${publishCmdAppendix}`
           : publishCmdAppendix;
     }
@@ -338,16 +333,24 @@ export class SemanticReleaseConfigDotnet {
 }
 
 /**
- * Configures {@link baseConfig} with `@semantic-release/exec` to `dotnet` publish, pack, and push.
- * @param projectsToPublish An array of dotnet projects' relative paths.
- * If empty, tries getting projects' semi-colon-separated relative
- * paths from the `PROJECTS_TO_PUBLISH` environment variable.
- * If configured as recommended, the projects' publish outputs will be zipped to
- * '$PWD/publish' for use in the `publish` semantic-release step (typically,
- * GitHub release).
- * @param projectsToPackAndPush An array of dotnet projects' relative paths.
- * If empty, `dotnet pack` and `dotnet nuget push` commands will not be configured.
- * If undefined, tries getting projects' semi-colon-separated relative paths
+ * Configures {@link baseConfig} with `@semantic-release/exec` to `dotnet`
+ * publish, pack, and nuget-push.
+ * @param projectsToPublish
+ * An array of dotnet projects' relative paths -OR- an array of
+ * {@link MSBuildProject} instances.
+ * - If `MSBuildProject[]`, the instances will be used as-is.
+ * - If `[]`, tries getting projects' semi-colon-separated relative paths from
+ *   the `PROJECTS_TO_PUBLISH` environment variable.
+ * - If configured as recommended, the projects' publish outputs will be zipped
+ *   to '$PWD/publish' for use in the `publish` semantic-release step e.g. for a
+ *   GitHub release.
+ * @param projectsToPackAndPush An array of dotnet projects' relative paths -OR-
+ * an array of instances of {@link NugetRegistryInfo} and/or derived classes.
+ * - If `NugetRegistryInfo[]`, no conversions or modifications will occur.
+ * - If `string[]`, the project paths will be converted to
+ * {@link NugetRegistryInfo} instances with default values. This may be undesired.
+ * - If `[]`, `dotnet pack` and `dotnet nuget push` commands will not be configured.
+ * - If `undefined`, tries getting projects' semi-colon-separated relative paths
  * from the `PROJECTS_TO_PACK_AND_PUSH` environment variable.
  * With the recommended configuration, `dotnet pack` will write the nupkg/snupkg
  * files to `$PWD/publish` where they will be globbed by `dotnet nuget push`.
@@ -361,7 +364,7 @@ export async function getConfig(
   projectsToPackAndPush?: string[] | NugetRegistryInfo[],
 ): Promise<Options> {
   if (debug.enabled) {
-    debug.log(
+    debug(
       'hce.shared-config:\n' + inspect(baseConfig, false, Infinity, true),
     );
   }
@@ -407,9 +410,8 @@ export async function getConfig(
 
   const options: Options = config.toOptions();
   if (debug.enabled) {
-    console.debug(
-      `modified plugins array:\n${inspect(options.plugins, false, Infinity)}`,
-    );
+    debug('modified plugins array:');
+    debug(inspect(options.plugins, false, Infinity));
   }
 
   return options;

package/src/setupGitPluginSpec.ts

@@ -8,7 +8,10 @@ export const GitPluginId = '@semantic-release/git';
  * To use, assign or create an object with the same (but mutable) properties and deeply-copy to the object
  * @satisfies { GitOptions }
  */
-export const DefaultOptions = {
+export const DefaultOptions: {
+  readonly assets: ['README.md', 'CHANGELOG.md', 'package.json', 'package-lock.json', 'npm-shrinkwrap.json'];
+  readonly message: 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}';
+} = {
   assets: [
     'README.md',
     'CHANGELOG.md',

package/src/tsconfig.json

@@ -2,7 +2,7 @@
   "extends": "../tsconfig.base.json",
   "compilerOptions": {
     "outDir": "../_tsout/src",
-    "isolatedDeclarations": false
+    "isolatedDeclarations": true
   },
   "include": [
     "./**/*"

package/src/utils/execAsync.ts

@@ -1,5 +1,6 @@
 /* eslint-disable jsdoc/no-defaults */
 import { type } from 'arktype';
+import type { ObjectType } from 'arktype/internal/methods/object.ts';
 import { exec } from 'node:child_process';
 import { constants } from 'node:os';
 import { promisify } from 'node:util';
@@ -39,7 +40,18 @@ export async function execAsync(command: string, setStderrAsCause = false): Prom
   });
 }
 
-const T_ExecException = type('Error').and({
+const T_ExecException: ObjectType<{
+  name: string;
+  message: string;
+  stack?: string | undefined;
+  cause?: unknown;
+  cmd?: string | null | undefined;
+  killed?: boolean | null | undefined;
+  code?: number | null | undefined;
+  signal?: 'SIGABRT' | 'SIGALRM' | 'SIGBUS' | 'SIGCHLD' | 'SIGCONT' | 'SIGFPE' | 'SIGHUP' | 'SIGILL' | 'SIGINT' | 'SIGIO' | 'SIGIOT' | 'SIGKILL' | 'SIGPIPE' | 'SIGPOLL' | 'SIGPROF' | 'SIGPWR' | 'SIGQUIT' | 'SIGSEGV' | 'SIGSTKFLT' | 'SIGSTOP' | 'SIGSYS' | 'SIGTERM' | 'SIGTRAP' | 'SIGTSTP' | 'SIGTTIN' | 'SIGTTOU' | 'SIGUNUSED' | 'SIGURG' | 'SIGUSR1' | 'SIGUSR2' | 'SIGVTALRM' | 'SIGWINCH' | 'SIGXCPU' | 'SIGXFSZ' | 'SIGBREAK' | 'SIGLOST' | 'SIGINFO' | null | undefined;
+  stdout?: string | undefined;
+  stderr?: string | undefined;
+}> = type('Error').and({
   'cmd?': 'string | null',
   'killed?': 'boolean | null',
   'code?': 'number | null',

package/src/utils/miscTypes.ts

@@ -1,9 +1,10 @@
-import { type } from 'arktype';
+import { type, type Type } from 'arktype';
+import type { StringType } from 'arktype/internal/methods/string.ts';
 
-export const tBooleanString = type('"true" | "false"');
+export const tBooleanString: StringType<'false' | 'true'> = type('"true" | "false"');
 export type BooleanString = typeof tBooleanString.infer;
 
-export const tEmptyOrBooleanString = type(tBooleanString.or('""'));
+export const tEmptyOrBooleanString: Type<'' | 'false' | 'true'> = type(tBooleanString.or('""'));
 export type EmptyOrBooleanString = typeof tEmptyOrBooleanString.infer;
 
 export type Integer<N extends number> = `${N}` extends `${number}.${number}` ? never : N;

package/src/utils/reflection/inheritance.ts

@@ -23,7 +23,7 @@ export type BaseClassProto = (() => object) & {
  * The `[[Prototype]]` of all base classes.
  * @since 3.0.0
  */
-export const baseClassProto = getPrototypeOf(Object as BaseClass<ObjectConstructor>);
+export const baseClassProto: BaseClassProto = getPrototypeOf(Object as BaseClass<ObjectConstructor>);
 
 /**
  * [INTERNAL]

package/tsconfig.base.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig#",
+  "//": {
+    "Typescript Node.js Target Mapping": "https://github.com/microsoft/TypeScript/wiki/Node-Target-Mapping",
+    "Node.js ECMAScript Mapping": "https://node.green/",
+    "vscode-versions": "https://github.com/ewanharris/vscode-versions",
+    "Recommended TSConfig Bases": "https://github.com/tsconfig/bases?tab=readme-ov-file#table-of-tsconfigs",
+    "Available/Latest GitHub Runner Images": "https://github.com/actions/runner-images/tree/main?tab=readme-ov-file#available-images",
+    "Node.js versions in GitHub Runner Images": {
+      "Ubuntu 2404 - Node.js version(s)": {
+        "installed": "https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2404-Readme.md#language-and-runtime",
+        "cached": "https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2404-Readme.md#nodejs"
+      },
+      "macOS 14": {
+        "installed": "https://github.com/actions/runner-images/blob/main/images/macos/macos-14-Readme.md#language-and-runtime",
+        "cached": "https://github.com/actions/runner-images/blob/main/images/macos/macos-14-Readme.md#nodejs"
+      },
+      "Windows Server 2022": {
+        "!note!": "[Windows 19 and 22] Node.js version 16 will be removed from Windows images on 2025-05-05. See https://github.com/actions/runner-images/issues/11710",
+        "installed": "https://github.com/actions/runner-images/blob/main/images/windows/Windows2022-Readme.md#language-and-runtime",
+        "cached": "https://github.com/actions/runner-images/blob/main/images/windows/Windows2022-Readme.md#nodejs"
+      }
+    }
+  },
+  "compileOnSave": true,
+  "extends": "./node_modules/@tsconfig/node20/tsconfig.json",
+  "compilerOptions": {
+    "composite": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
+    "forceConsistentCasingInFileNames": true,
+    "isolatedDeclarations": true,
+    "isolatedModules": true,
+    "module": "Node18",
+    "noEmitOnError": true,
+    "noErrorTruncation": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "**/node_modules/**",
+    "**/tsconfig.json",
+    "**/tsconfig.*.json"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "allowImportingTsExtensions": true,
+    "outDir": "_tsout",
+    "target": "es2020",
+    "erasableSyntaxOnly": true
+  },
+  "include": [
+    "./*.cts",
+    "./*.mts",
+    "./*.ts"
+  ],
+  "references": [
+    {
+      "path": "./tests/tsconfig.json"
+    },
+    {
+      "path": "./src/tsconfig.json"
+    }
+  ]
+}

package/tsconfig.mjs.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./src/tsconfig.json",
+  "compilerOptions": {
+    "declarationDir": "./mjs/",
+    "outDir": "./mjs/",
+    "rootDir": "./src/"
+  }
+}