@halospv3/hce.shared-config 2.2.3 → 2.3.0

package/src/setupGitPluginSpec.ts

@@ -0,0 +1,75 @@
+import type { PluginSpec } from 'semantic-release';
+import type { AssetEntry, Options as GitOptions } from '@semantic-release/git';
+
+export const GitPluginId = '@semantic-release/git';
+export const DefaultOptions = {
+	assets: ['CHANGELOG.md', 'package.json', 'package-lock.json', 'npm-shrinkwrap.json'],
+	// eslint-disable-next-line no-template-curly-in-string
+	message: 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}',
+} satisfies GitOptions;
+
+function gitAssetsToArray(assets: AssetEntry | AssetEntry[] | false | undefined) {
+	if (assets === undefined || assets === false) return [];
+	if (Array.isArray(assets)) return assets;
+	if (typeof assets === 'string') return [assets];
+	return assets.path === 'string' ? [assets.path] : [];
+}
+
+/**
+ * https://github.com/semantic-release/git#options
+ *
+ * This plugin may be deprecated at a later date.
+ * Why do you need to commit during release?
+ * If you don't need to update a changelog or version in a file, then you don't need this.
+ *
+ * @returns A {@link PluginSpec} array with {@link PluginSpec<GitOptions>}. If Git plugin not in original array, returns the original array.
+ * todo: deprecate for generic or parameterized function
+ */
+export function setupGitPluginSpec(plugins: PluginSpec[]): PluginSpec[] {
+	let newPlugins = plugins;
+	let gitPluginIndex = -1;
+
+	function pluginSpecIsGit(pluginSpec: PluginSpec, pluginSpecIndex: number) {
+		if (pluginSpec === GitPluginId || pluginSpec[0] === GitPluginId) {
+			gitPluginIndex = pluginSpecIndex;
+			return true;
+		}
+		return false;
+	}
+
+	// if Git plugin not in load order, return as-is.
+	if (!newPlugins.some(pluginSpecIsGit)) return plugins;
+
+	// if string, replace with tuple with default options.
+	newPlugins = newPlugins.map((plugin) =>
+		plugin === GitPluginId ? [GitPluginId, DefaultOptions] : plugin,
+	);
+
+	// ensure assets is an array
+	(newPlugins[gitPluginIndex][1] as GitOptions).assets = gitAssetsToArray(
+		(newPlugins[gitPluginIndex][1] as GitOptions).assets,
+	);
+
+	const discardPile: number[] = [];
+
+	// de-duplicate Git plugin entries; assign single entry to newPlugins[gitPluginIndex]
+	newPlugins.forEach((current, i) => {
+		if (i > gitPluginIndex && pluginSpecIsGit(current, gitPluginIndex)) {
+			// convert its assets to an array
+			const { assets } = newPlugins[i][1] as GitOptions;
+			const { message } = newPlugins[i][1] as GitOptions;
+			// push unique assets to first entry's assets array
+			if (assets !== undefined)
+				((newPlugins[gitPluginIndex][1] as GitOptions).assets as AssetEntry[]).push(
+					...gitAssetsToArray(assets),
+				);
+			if (message !== undefined) (newPlugins[gitPluginIndex][1] as GitOptions).message = message;
+			discardPile.push(i);
+		}
+	});
+	for (const i of discardPile.sort().reverse()) {
+		newPlugins.splice(i, 1);
+	}
+
+	return newPlugins;
+}

package/src/tsconfig.json

@@ -0,0 +1,10 @@
+{
+    "extends": "../baseTsconfig.json",
+    "compilerOptions": {
+        "outDir": "../_tsout/src",
+        "target": "ES5"
+    },
+    "include": [
+        "./**/*"
+    ]
+}

package/static/.releaserc.yml

@@ -22,7 +22,7 @@ plugins: # https://semantic-release.gitbook.io/semantic-release/v/beta/usage/con
         - CHANGELOG.md
   # Arbitrary shell commands - https://github.com/semantic-release/exec
   # hint: set 'prepareCmd' to `dotnet publish`.
-  #   Because this is sorted after @semantic-release/git, the new Git tag will 
+  #   Because this is sorted after @semantic-release/git, the new Git tag will
   #   be visible to dotnet (and GitVersion). Dotnet artifacts will be
   #   versioned accordingly.
   # Plugins' Steps: https://github.com/semantic-release/semantic-release/blob/master/docs/extending/plugins-list.md
@@ -30,7 +30,6 @@ plugins: # https://semantic-release.gitbook.io/semantic-release/v/beta/usage/con
   - - "@semantic-release/github"
     - assets:
         - path: ./publish/*
-
-## (OPTIONAL) update static Version strings.
+## (OPTIONAL) update static Version strings before Git plugin
 # https://github.com/jpoehnelt/semantic-release-replace-plugin
 # https://github.com/droidsolutions/semantic-release-update-file

package/commitlint.config.ts

@@ -1,10 +0,0 @@
-import { RuleConfigSeverity, type UserConfig } from "@commitlint/types";
-const commitlint: UserConfig = {
-    extends: ["@commitlint/config-conventional"],
-    rules: {
-        "body-max-line-length": [RuleConfigSeverity.Disabled],
-        "footer-max-line-length": [RuleConfigSeverity.Disabled],
-        "header-max-length": [RuleConfigSeverity.Disabled]
-    }
-};
-export default commitlint

package/dotnet/.releaserc.cjs

@@ -1,77 +0,0 @@
-/** Semantic-Release configuration for GroupBox.Avalonia
- * @extends { hceSharedConfig }
- * 
- * <-- TABLE OF CONTENTS -->
- * - Insert-Edit Plugins
- * - Append Plugins
- */
-
-/**
-  * @typedef { object } PluginOptionsGit 
-  * @prop { string } message
-  * @prop {[ string | [string] | {path:string} ]} assets
-  */
-
-/**
- * @type {import("semantic-release").Options}
- */
-const hceSharedConfig = require('@halospv3/hce.shared-config')
-if (process.argv.includes("--debug") || process.argv.includes("--verbose")) {
-  console.info("hce.shared-config:\n" + JSON.stringify(hceSharedConfig, null, 2))
-}
-/** 
- * @type { typeof hceSharedConfig.plugins }
- */
-const newPlugins = hceSharedConfig.plugins;
-
-//#region Insert-Edit Plugins
-/* Insert and/or configure plugins. Can be used to load plugin A's Prepare step
-before plugin B's Prepare step. or edit a plugin's existing configuration */
-for (var i = 0; i < newPlugins.length; i++) {
-  /** e.g.
-  //#region Git Options | https://github.com/semantic-release/git#options
-  // if defined without plugin options, replace with tuple-like array with assets option defined.
-  if (plugins[i] === "@semantic-release/git") {
-    plugins[i] = [plugins[i], { assets: ["README.md", "CHANGELOG.md"] }]
-  }
-  if (plugins[i][0] === "@semantic-release/git") {
-    // if assets array undefined, define it
-    if (!plugins[i][1].assets) {
-      plugins[i][1].assets = [];
-    }
-    // ensure README.md is in assets array
-    if (!plugins[i][1].assets.some(a => a === "README.md" || a.path === "README.md")) {
-      plugins[i][1].assets.push("README.md");
-    }
-    // ensure CHANGELOG.md is in assets array
-    if (!plugins[i][1].assets.some(a => a === "CHANGELOG.md" || a.path === "CHANGELOG.md")) {
-      plugins[i][1].assets.push("CHANGELOG.md");
-    }
-  }
-  //#endregion Git Options
-  */
-}
-//#endregion Insert-Edit Plugins
-
-//#region Append Plugins
-newPlugins.push(
-  // APPEND this array of [pluginName, pluginConfig] to plugins
-  // https://github.com/semantic-release/exec#usage
-  ["@semantic-release/exec", {
-    // 'ZipPublishDir' zips each publish folder to ./publish/*.zip
-    prepareCmd: "dotnet publish ./GroupBox.Avalonia/GroupBox.Avalonia.csproj && dotnet publish ./GroupBox.Avalonia.Sample/GroupBox.Avalonia.Sample.csproj"
-  }]
-)
-//#endregion Append Plugins
-
-if (process.argv.includes("--debug") || process.argv.includes("--verbose")) {
-  console.info("modified plugins array:\n" + JSON.stringify(newPlugins, null, 2))
-}
-
-/**
- * @type {import("semantic-release").Options}
- */
-module.exports = {
-  extends: "@halospv3/hce.shared-config",
-  plugins: newPlugins
-};