@halospv3/hce.shared-config 3.0.0-develop.4 → 3.0.0-develop.6

package/src/insertPlugins.ts

@@ -0,0 +1,116 @@
+import type {
+  PluginSpec,
+  Options as SemanticReleaseOptions,
+} from 'semantic-release';
+
+/**
+ * @since 3.0.0
+ * @deprecated EXPERIMENTAL
+ */
+interface PluginInsertRuleSet {
+  Id: string;
+  BeforeIds: string[];
+  AfterIds: string[];
+}
+
+/**
+ * [W.I.P. STUB]
+ *
+ * Given an array of {@link PluginInsertRuleSet}s, insert plugins into a
+ * {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/structuredClone structured clone}
+ * (i.e. deep-copy) of the {@link plugins} array, sort the plugin entries, and
+ * return the modified array copy.
+ * @todo implement
+ * @param plugins Your {@link SemanticReleaseOptions.plugins} array.
+ * @param inserts An array of {@link PluginInsertRuleSet}s.
+ *
+ * If a plugin is already in the plugins array, inserting is skipped. The
+ * existing entry is sorted according to its ruleset.
+ *
+ * If any rulesets conflict, an error will be thrown.
+ * - error: A must precede B; B must precede A.
+ * - pass: C must precede D and E; D must precede E and follow B. Add ruleset
+ *   interface: {Id:string, BeforeIds:string[], AfterIds:string[] }
+ * @returns A deep-cloned, modified copy of {@link plugins} with plugins
+ * inserted and sorted where needed.
+ * @since 3.0.0
+ * @deprecated EXPERIMENTAL
+ */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+declare function insertAndSortPlugins(
+  plugins: Exclude<SemanticReleaseOptions['plugins'], undefined>,
+  // eslint-disable-next-line @typescript-eslint/no-deprecated
+  inserts: PluginInsertRuleSet[]
+): PluginSpec[];
+
+/**
+ * @param plugins {@link SemanticReleaseOptions.plugins}
+ * @param afterPluginsIDs The `string` IDs of plugins that the {@link insertPluginIDs} must follow.
+ * @param insertPluginIDs The `string` IDs of plugins to insert into a copy of the {@link plugins} array.
+ * @param beforePluginsIDs The `string` IDs of plugins that the {@link insertPluginIDs} must precede.
+ * @returns
+ * A modified copy of {@link plugins} with the given plugins inserted
+ * before {@link beforePluginsIDs} and after {@link afterPluginsIDs}.
+ *
+ * Inserted plugins will be a `[string, {}]` tuple.
+ * @throws {ReferenceError} This should never occur. One or more of the
+ * {@link afterPluginsIDs} had been found in {@link plugins}, but a `.find` call
+ * to get the highest index of the found plugins had returned `undefined`
+ * @throws {AggregateError} One or more error occurred when inserting plugins: `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])}!`
+ */
+export function insertPlugin(
+  plugins: Exclude<SemanticReleaseOptions['plugins'], undefined>,
+  afterPluginsIDs: string[],
+  insertPluginIDs: string[],
+  beforePluginsIDs: string[],
+): PluginSpec[] {
+  const pluginIDs = 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 (undefined === 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)
+
+  const beforeInsert = plugins.slice(0, indexOfLastAfter + 1);
+  const afterInsert = plugins.slice(indexOfLastAfter + 1, plugins.length + 1);
+
+  return [
+    ...beforeInsert,
+    ...insertPluginIDs.map(id =>
+      [id, {}] as [string, unknown],
+    ),
+    ...afterInsert,
+  ];
+}

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'> {
@@ -121,90 +121,85 @@ export class SemanticReleaseConfigDotnet {
     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],
-      ),
-    );
+    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`.