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

package/src/eslintConfig.ts

@@ -1,80 +1,183 @@
-import eslint from "@eslint/js";
-import jsonc from "eslint-plugin-jsonc";
-import { createRequire } from "module";
-import tseslint, { type ConfigWithExtends } from "typescript-eslint";
+import eslint from '@eslint/js';
+import stylistic, { type RuleOptions } from '@stylistic/eslint-plugin';
+import type { TSESLint } from '@typescript-eslint/utils';
+import jsonc from 'eslint-plugin-jsonc';
+import globals from 'globals/globals.json' with { type: 'json' };
+import tseslint from 'typescript-eslint';
 
-// CJS compatibility; it started transpiling to a top-level await after upgrading from packemon 4.0.1 to 4.1.0
-const require = createRequire(import.meta.url);
-const globals = require("globals") as typeof import("globals", {with: {type: "json"}});
 // https://eslint.org/docs/latest/use/configure/migration-guide#using-eslintrc-configs-in-flat-config
 // https://www.google.com/search?q=javascript+recurse+through+object+and+remove+undefined+properties
-const globalIgnores: ConfigWithExtends = {
-    name: "global ignores",
-    ignores: [
-        "_tsout/**/*",
-        "_tsout/*",
-        "_tsout/",
-        "cjs/**/*",
-        "cjs/*/*",
-        "cjs/*",
-        "mjs/**/*",
-        "mjs/*",
-        "mjs/",
-        "node_modules/**/*",
-        "**/node_modules/**/*"
-    ]
+
+const globalIgnores: TSESLint.FlatConfig.Config = {
+  name: 'global ignores',
+  ignores: [
+    '_tsout/**/*',
+    '_tsout/*',
+    '_tsout/',
+    'cjs/**/*',
+    'cjs/*/*',
+    'cjs/*',
+    'mjs/**/*',
+    'mjs/*',
+    'mjs/',
+    'node_modules/**/*',
+    '**/node_modules/**/*',
+    '**/*.tsbuildinfo',
+    '**/bin/**/*',
+    '**/obj/**/*',
+  ],
+};
+
+const json_json = {
+  /** jsonc config union types are a pain to work with. Each union member is mutually exclusive to the others */
+  ...jsonc.configs['flat/recommended-with-json']
+    .map(v => v as JsoncCfgReducerIn)
+    .flatMap(a => jsonCfgReducer(a, {}))
+    // eslint-disable-next-line unicorn/no-array-reduce
+    .reduce((accumulator, element) => jsonCfgReducer(accumulator, element), {} as JsoncCfgReducerOut),
+  name: 'flat/recommended-with-json - https://github.com/ota-meshi/eslint-plugin-jsonc' as const,
+  files: ['*.json', '**/*.json'] as ['*.json', '**/*.json'],
+  ignores: globalIgnores.ignores,
 };
+const json_json5 = {
+  /** jsonc config union types are a pain to work with. Each union member is mutually exclusive to the others */
+  ...jsonc.configs['flat/recommended-with-json5']
+    .map(v => v as JsoncCfgReducerIn)
+    .flatMap(a => jsonCfgReducer(a, {}))
+    // eslint-disable-next-line unicorn/no-array-reduce
+    .reduce((accumulator, element) => jsonCfgReducer(accumulator, element), {} as JsoncCfgReducerOut),
+  name: 'flat/recommended-with-json5 - https://github.com/ota-meshi/eslint-plugin-jsonc' as const,
+  files: ['*.json5', '**/*.json5'] as ['*.json5', '**/*.json5'],
+  ignores: globalIgnores.ignores,
+};
+const json_jsonc = {
+  /** jsonc config union types are a pain to work with. Each union member is mutually exclusive to the others */
+  ...jsonc.configs['flat/recommended-with-jsonc']
+    .map(v => v as JsoncCfgReducerIn)
+    .flatMap(a => jsonCfgReducer(a, {}))
+    // eslint-disable-next-line unicorn/no-array-reduce
+    .reduce((accumulator, element) => jsonCfgReducer(accumulator, element), {} as JsoncCfgReducerOut),
+  name: 'flat/recommended-with-jsonc - https://github.com/ota-meshi/eslint-plugin-jsonc' as const,
+  files: ['*.jsonc', '**/*.jsonc'] as ['*.jsonc', '**/*.jsonc'],
+  ignores: globalIgnores.ignores,
+};
+
+const stylisticWarn = stylistic.configs.customize({
+  quoteProps: 'as-needed',
+  semi: true,
+  indent: 2,
+}) as TSESLint.FlatConfig.Config & { rules: { [K in keyof RuleOptions]: TSESLint.SharedConfig.RuleLevel | [TSESLint.SharedConfig.RuleLevel, ...RuleOptions[K]] } };
+// change all stylistic error-severity to warn-severity. Style violations should not denote code errors.
+for (const key in stylisticWarn.rules) {
+  const element = stylisticWarn.rules[key];
+  if (Array.isArray(element) && (element[0] === 2 || element[0] === 'error'))
+    element[0] = 'warn';
+  else if (element === 2 || element === 'error') {
+    stylisticWarn.rules[key] = 'warn' satisfies TSESLint.SharedConfig.RuleLevel;
+  }
+}
 
-export default tseslint.config(
-    {
-        name: "flat/recommended-with-json - https://github.com/ota-meshi/eslint-plugin-jsonc",
-        extends: jsonc.configs["flat/recommended-with-json"],
-        files: [
-            "*.json",
-            "**/*.json"
-        ],
-        ignores: globalIgnores.ignores
+stylisticWarn.rules['@stylistic/no-extra-parens'] = [
+  'warn',
+  'all',
+  {
+    allowParensAfterCommentPattern: '@type|@satisfies',
+    nestedBinaryExpressions: false,
+  },
+];
+
+stylisticWarn.rules['@stylistic/semi'] = [
+  'warn',
+  'always',
+  {
+    omitLastInOneLineBlock: false,
+    omitLastInOneLineClassBody: false,
+  },
+] satisfies TSESLint.SharedConfig.RuleEntry | [TSESLint.SharedConfig.RuleLevelAndOptions, RuleOptions['@stylistic/semi'][0], RuleOptions['@stylistic/semi'][1]];
+
+const config: TSESLint.FlatConfig.ConfigArray = tseslint.config(
+  json_json,
+  json_json5,
+  json_jsonc,
+  {
+    name: 'TSJS',
+    extends: [
+      eslint.configs.recommended,
+      ...tseslint.configs.strictTypeChecked,
+      ...tseslint.configs.stylisticTypeChecked,
+      stylisticWarn,
+    ],
+    files: [
+      '**/*.ts',
+      '**/*.cts',
+      '**/*.mts',
+      '**/*.js',
+      '**/*.cjs',
+      '**/*.mjs',
+      '**/*.jsx',
+      '**/*.tsx',
+    ],
+    ignores: globalIgnores.ignores,
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+      },
+      globals: globals.node,
     },
-    {
-        name: "flat/recommended-with-json5 - https://github.com/ota-meshi/eslint-plugin-jsonc",
-        extends: jsonc.configs["flat/recommended-with-json5"],
-        files: [
-            "*.json5",
-            "**/*.json5"
-        ],
-        ignores: globalIgnores.ignores
+  },
+  globalIgnores,
+);
+export default config;
+
+type JsoncCfgReducerIn = Partial<typeof jsonc.configs['flat/recommended-with-jsonc'][number]>
+  | Partial<typeof jsonc.configs['flat/recommended-with-json5'][number]>;
+
+interface JsoncCfgReducerOut {
+  files: NonNullable<(typeof jsonc.configs)['flat/base'][number]['files']> | ['*.json', '**/*.json', '*.json5', '**/*.json5', '*.jsonc', '**/*.jsonc'];
+  plugins: typeof jsonc.configs['flat/base'][number]['plugins'];
+  languageOptions: {
+    parser: typeof import('jsonc-eslint-parser');
+  };
+  rules: NonNullable<
+    typeof jsonc['configs']['flat/recommended-with-json5'][number]['rules']
+    | typeof jsonc.configs['flat/recommended-with-jsonc'][number]['rules']
+  >;
+}
+
+/**
+ * Merge erroneously mutually-exclusive configs from `eslint-plugin-jsonc`.
+ * @param a A config exported by `eslint-plugin-jsonc` -OR- the output of this function.
+ * @param b A config exported by `eslint-plugin-jsonc` -OR- the output of this function.
+ * @returns A merged combination of {@link a} and {@link b}.
+ */
+function jsonCfgReducer(
+  a: JsoncCfgReducerIn | JsoncCfgReducerOut,
+  b: JsoncCfgReducerIn | JsoncCfgReducerOut,
+): JsoncCfgReducerOut {
+  const baseRules = jsonc.configs['flat/base']
+    .find(
+      v => v.rules !== undefined,
+    )?.rules ?? (() => { throw new Error('Unable to find jsonc base rules'); })();
+
+  return {
+    files: jsonc.configs['flat/base']
+      .filter(v => v.files !== undefined)
+      .flatMap(v => v.files),
+    plugins: {
+      jsonc: jsonc.configs['flat/base']
+        .find(v =>
+          v.plugins?.jsonc !== undefined,
+        )?.plugins?.jsonc ?? (() => { throw new Error('Unable to find jsonc plugin'); })(),
     },
-    {
-        name: "flat/recommended-with-jsonc - https://github.com/ota-meshi/eslint-plugin-jsonc",
-        extends: jsonc.configs["flat/recommended-with-jsonc"],
-        files: [
-            "*.jsonc",
-            "**/*.jsonc"
-        ],
-        ignores: globalIgnores.ignores
+    languageOptions: {
+      parser: jsonc.configs['flat/base']
+        .find(v => v.languageOptions?.parser)
+        ?.languageOptions?.parser ?? (() => { throw new Error('Unable to find jsonc parser'); })(),
     },
-    {
-        name: "TSJS",
-        extends: [
-            eslint.configs.recommended as ConfigWithExtends,
-            ...tseslint.configs.strict,
-            ...tseslint.configs.stylistic
-        ],
-        files: [
-            "**/*.ts",
-            "**/*.cts",
-            "**/*.mts",
-            "**/*.js",
-            "**/*.cjs",
-            "**/*.mjs"
-        ],
-        ignores: globalIgnores.ignores,
-        languageOptions: {
-            parserOptions: {
-                useProjectService: true
-            },
-            globals: globals.node
-        }
+    rules: {
+      ...a.rules,
+      ...b.rules,
+      ...baseRules,
     },
-    globalIgnores
-);
+  };
+}

package/src/index.ts

@@ -1,4 +1,2 @@
-/**
- * Runs HCE.Shared and returns a semantic-release "shareable configuration" object.
-*/
+/** Runs HCE.Shared and returns a semantic-release "shareable configuration" object. */
 export { baseConfig as default } from './semanticReleaseConfig.js';

package/src/semantic-release__commit-analyzer.d.ts

@@ -1,44 +1,50 @@
 declare module '@semantic-release/commit-analyzer' {
 
-    interface RuleObject {
-        type?: string,
-        scope?: string,
-        release: string
-    }
+  interface RuleObject {
+    type?: string;
+    scope?: string;
+    release: string;
+  }
 
-    type AnyRecord = Record<keyof unknown, unknown>;
-
-    export interface CommitAnalyzerConfig {
-        preset?: string,
-        config?: string,
-        parserOpts?: AnyRecord,
-        releaseRules?: string | RuleObject[],
-        presetConfig?: AnyRecord
-    }
+  type AnyRecord = Record<keyof unknown, unknown>;
 
+  export interface CommitAnalyzerConfig {
+    preset?: string;
+    config?: string;
+    parserOpts?: AnyRecord;
     /**
-     * Determine the type of release to create based on a list of commits.
-     *
-     * @param {Object} pluginConfig The plugin configuration.
-     * @param {String} pluginConfig.preset conventional-changelog preset ('angular', 'atom', 'codemirror', 'ember', 'eslint', 'express', 'jquery', 'jscs', 'jshint')
-     * @param {String} pluginConfig.config Requireable npm package with a custom conventional-changelog preset
-     * @param {String|Array} pluginConfig.releaseRules A `String` to load an external module or an `Array` of rules.
-     * @param {Object} pluginConfig.parserOpts Additional `conventional-changelog-parser` options that will overwrite ones loaded by `preset` or `config`.
-     * @param {Object} context The semantic-release context.
-     * @param {Array<Object>} context.commits The commits to analyze.
-     * @param {String} context.cwd The current working directory.
-     *
-     * @returns {Promise<String|null>} the type of release to create based on the list of commits or `null` if no release has to be done.
-     * 
-     * @see 'file://./../node_modules/@semantic-release/commit-analyzer/index.js'
+     * Can be a string only if the string is a path to a modules whose default export provides {@link RuleObject}[].
+     * See https://github.com/semantic-release/commit-analyzer?tab=readme-ov-file#external-package--file
      */
-    export function analyzeCommits(pluginConfig: {
-        preset: string;
-        config: string;
-        releaseRules: string | AnyRecord[];
-        parserOpts: unknown;
-    }, context: {
-        commits: unknown[];
-        cwd: string;
-    }): Promise<string | null>;
-}
+    releaseRules?: string | RuleObject[];
+    presetConfig?: AnyRecord;
+  }
+
+  export type Options = CommitAnalyzerConfig;
+
+  /**
+   * Determine the type of release to create based on a list of commits.
+   * @param pluginConfig The plugin configuration.
+   * @param pluginConfig.preset conventional-changelog preset ('angular', 'atom', 'codemirror', 'ember', 'eslint', 'express', 'jquery', 'jscs', 'jshint')
+   * @param pluginConfig.config Require-able npm package with a custom conventional-changelog preset
+   * @param pluginConfig.releaseRules A `String` to load an external module or an `Array` of rules.
+   * @param pluginConfig.parserOpts Additional `conventional-changelog-parser` options that will overwrite ones loaded by `preset` or `config`.
+   * @param context The semantic-release context.
+   * @param context.commits The commits to analyze.
+   * @param context.cwd The current working directory.
+   * @returns the type of release to create based on the list of commits or `null` if no release has to be done.
+   * @see 'file://./../node_modules/@semantic-release/commit-analyzer/index.js'
+   */
+  export function analyzeCommits(
+    pluginConfig: {
+      preset: string;
+      config: string;
+      releaseRules: string | AnyRecord[];
+      parserOpts: unknown;
+    },
+    context: {
+      commits: object[];
+      cwd: string;
+    },
+  ): Promise<string | null>;
+}

package/src/semantic-release__exec.d.ts

@@ -0,0 +1,15 @@
+declare module '@semantic-release/exec' {
+  interface Options {
+    verifyConditionsCmd?: string;
+    analyzeCommitsCmd?: string;
+    verifyReleaseCmd?: string;
+    generateNotesCmd?: string;
+    prepareCmd?: string;
+    addChannelCmd?: string;
+    publishCmd?: string;
+    successCmd?: string;
+    failCmd?: string;
+    shell?: string;
+    execCwd?: string;
+  }
+}

package/src/semantic-release__git.d.ts

@@ -1,91 +1,88 @@
-/** @see 'file://./../node_modules/@semantic-release/git/index.js' */
+/* eslint-disable jsdoc/tag-lines, jsdoc/require-param, jsdoc/require-returns */
+/**
+ * @see {@link ../node_modules/@semantic-release/git/index.js}
+ */
 declare module '@semantic-release/git' {
-	import type { Options as SemanticReleaseOptions } from "semantic-release";
-	export type MicromatchGlob = string;
-	export interface AssetObject {
-		path: MicromatchGlob;
-	}
-	export type AssetEntry = AssetObject | MicromatchGlob;
-	export interface Options {
-		/**
-		 * Files to include in the release commit. Set to `false` to disable adding files to the release commit.
-		 * @default ['CHANGELOG.md', 'package.json', 'package-lock.json', 'npm-shrinkwrap.json']
-		 * @description
-		 * Can be an Array or a single entry. Each entry can be either:
-		 * - a glob
-		 * - or an Object with a path property containing a glob.
-		 *
-		 * Each entry in the assets Array is globbed individually. A glob can be a String ("dist/\*\*\/\*.js" or "dist/mylib.js") or an Array of Strings that will be globbed together (["dist/\*\*", "!\*\*\/\*.css"]).
-		 *
-		 * If a directory is configured, all the files under this directory and its children will be included.
-		 *
-		 * Note: If a file has a match in assets it will be included even if it also has a match in .gitignore.
-		 *
-		 * @example
-		 * // include all js files in the dist directory, but not in its sub-directories.
-		 * 'dist/*.js'
-		 * // include all js files in the dist directory and its sub-directories.
-		 * 'dist/**\/*.js'
-		 * // include all files in the dist directory and its sub-directories excluding the css files.
-		 * [['dist', '!**\/*.css']]
-		 * // include package.json and all files in the dist directory and its sub-directories excluding the css files.
-		 * [['dist', '!**\/*.css'], 'package.json']
-		 * // include all js and css files in the dist directory and its sub-directories excluding the minified version.
-		 * [['dist/**\/*.{js,css}', '!**\/*.min.*']]
-		 */
-		assets?: AssetEntry | AssetEntry[] | false;
-		/**
-		 * The message for the release commit.
-		 * @default `chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}`
-		 * @description
-		 * The message for the release commit is generated with Lodash template. The following variables are available:
-		 * | Parameter         | Description |
-		 * | ----------------- | ----------- |
-		 * | branch            | The branch from which the release is done. |
-		 * | branch.name       | The branch name. |
-		 * | branch.type       | The type of branch. |
-		 * | branch.channel    | The distribution channel on which to publish releases from this branch. |
-		 * | branch.range      | The range of semantic versions to support on this branch. |
-		 * | branch.prerelease | The pre-release detonation to append to semantic versions released from this branch. |
-		 * | lastRelease       | Object with version, gitTag and gitHead of the last release. |
-		 * | nextRelease       | Object with version, gitTag, gitHead and notes of the release being done. |
-		 *
-		 * Note: It is recommended to include `[skip ci]` in the commit message to not trigger a new build. Some CI service support the `[skip ci]` keyword only in the subject of the message.
-		 *
-		 * #### `message` examples
-		 * The `message` `Release <%= nextRelease.version %> - <%= new Date().toLocaleDateString('en-US', {year: 'numeric', month: 'short', day: 'numeric', hour: 'numeric', minute: 'numeric' }) %> [skip ci]\n\n<%= nextRelease.notes %>` will generate the commit message:
-		 * > Release v1.0.0 - Oct. 21, 2015 1:24 AM [skip ci]
-		 * >
-		 * > ## 1.0.0
-		 * >
-		 * > ### Features
-		 * > * Generate 1.21 gigawatts of electricity
-		 * >
-		 * > ...
-		 *
-		 */
-		message?: string;
-	}
+  import type { GlobalConfig, PrepareContext, VerifyConditionsContext } from 'semantic-release';
+  export type MicromatchGlob = string;
+  export interface AssetObject {
+    path: MicromatchGlob;
+  }
+  export type AssetEntry = AssetObject | MicromatchGlob;
+  export interface Options {
+    /**
+     * Files to include in the release commit. Set to `false` to disable adding files to the release commit.
+     * @default ['CHANGELOG.md','package.json','package-lock.json','npm-shrinkwrap.json']
+     * @description
+     * Can be an Array or a single entry. Each entry can be either:
+     * - a glob
+     * - or an Object with a path property containing a glob.
+     *
+     * Each entry in the assets Array is globbed individually. A glob can be a String ("dist/\*\*\/\*.js" or "dist/mylib.js") or an Array of Strings that will be globbed together (["dist/\*\*", "!\*\*\/\*.css"]).
+     *
+     * If a directory is configured, all the files under this directory and its children will be included.
+     *
+     * Note: If a file has a match in assets it will be included even if it also has a match in .gitignore.
+     *
+     * @example
+     * // include all js files in the dist directory, but not in its sub-directories.
+     * 'dist/*.js'
+     * // include all js files in the dist directory and its sub-directories.
+     * 'dist/**\/*.js'
+     * // include all files in the dist directory and its sub-directories excluding the css files.
+     * [['dist', '!**\/*.css']]
+     * // include package.json and all files in the dist directory and its sub-directories excluding the css files.
+     * [['dist', '!**\/*.css'], 'package.json']
+     * // include all js and css files in the dist directory and its sub-directories excluding the minified version.
+     * [['dist/**\/*.{js,css}', '!**\/*.min.*']]
+     */
+    assets?: AssetEntry | AssetEntry[] | false;
+    /**
+     * The message for the release commit.
+     * @default `chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}`
+     * @description
+     * The message for the release commit is generated with Lodash template. The following variables are available:
+     * | Parameter         | Description |
+     * | ----------------- | ----------- |
+     * | branch            | The branch from which the release is done. |
+     * | branch.name       | The branch name. |
+     * | branch.type       | The type of branch. |
+     * | branch.channel    | The distribution channel on which to publish releases from this branch. |
+     * | branch.range      | The range of semantic versions to support on this branch. |
+     * | branch.prerelease | The pre-release detonation to append to semantic versions released from this branch. |
+     * | lastRelease       | Object with version, gitTag and gitHead of the last release. |
+     * | nextRelease       | Object with version, gitTag, gitHead and notes of the release being done. |
+     *
+     * Note: It is recommended to include `[skip ci]` in the commit message to not trigger a new build. Some CI service support the `[skip ci]` keyword only in the subject of the message.
+     *
+     * #### `message` examples
+     * The `message` `Release <%= nextRelease.version %> - <%= new Date().toLocaleDateString('en-US', {year: 'numeric', month: 'short', day: 'numeric', hour: 'numeric', minute: 'numeric' }) %> [skip ci]\n\n<%= nextRelease.notes %>` will generate the commit message:
+     * > Release v1.0.0 - Oct. 21, 2015 1:24 AM [skip ci]
+     * >
+     * > ## 1.0.0
+     * >
+     * > ### Features
+     * > * Generate 1.21 gigawatts of electricity
+     * >
+     * > ...
+     *
+     */
+    message?: string;
+  }
 
-	function verifyConditions(
-		pluginConfig: Options,
-		context: {
-			options: {
-				prepare: unknown
-			}
-		}
-	): void;
-	async function prepare(
-		pluginConfig: Options,
-		context: {
-			env,
-			cwd: string,
-			branch: { name: string },
-			options: SemanticReleaseOptions,
-			lastRelease,
-			nextRelease: { version, notes, gitTag },
-			logger: { log(_0: string, _1: unknown | number): void },
-		}
-	): Promise<void>;
-	export { prepare, verifyConditions };
+  function verifyConditions(
+    pluginConfig: Options,
+    context: VerifyConditionsContext & {
+      options: {
+        prepare: unknown;
+      };
+    },
+  ): void;
+  function prepare(
+    pluginConfig: Options,
+    context: PrepareContext & {
+      options: GlobalConfig;
+    },
+  ): Promise<void>;
+  export { prepare, verifyConditions };
 }