@halospv3/hce.shared-config 3.0.0-develop.9 → 3.1.0-develop.1

package/src/eslintConfig.ts

@@ -1,81 +1,41 @@
 import eslint from '@eslint/js';
+import { defineConfig, globalIgnores as setGlobalIgnores } from 'eslint/config';
+import { type Linter } from 'eslint';
 import stylistic, { type RuleOptions } from '@stylistic/eslint-plugin';
-import type { TSESLint } from '@typescript-eslint/utils';
-import jsonc from 'eslint-plugin-jsonc';
+import json from '@eslint/json';
 import globals from 'globals/globals.json' with { type: 'json' };
 import tseslint from 'typescript-eslint';
 
 // 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: TSESLint.FlatConfig.Config = {
-  name: 'global ignores',
-  ignores: [
-    '_tsout/**/*',
-    '_tsout/*',
-    '_tsout/',
-    'cjs/**/*',
-    'cjs/*/*',
-    'cjs/*',
-    'mjs/**/*',
-    'mjs/*',
-    'mjs/',
-    'node_modules/**/*',
-    '**/node_modules/**/*',
-    '**/*.tsbuildinfo',
-    '**/bin/**/*',
-    '**/obj/**/*',
-  ],
-};
+const globalIgnores: ReturnType<typeof setGlobalIgnores> = setGlobalIgnores([
+  '_tsout/**/*',
+  '_tsout/*',
+  '_tsout/',
+  'cjs/**/*',
+  'cjs/*/*',
+  'cjs/*',
+  'mjs/**/*',
+  'mjs/*',
+  'mjs/',
+  'node_modules/**/*',
+  '**/node_modules/**/*',
+  '**/*.tsbuildinfo',
+  '**/bin/**/*',
+  '**/obj/**/*',
+  '.pnp.cjs',
+  '.pnp.loader.mjs',
+  '.yarn/sdks/**',
+]);
 
-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({
+const stylisticWarn: Linter.Config = 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;
-  }
-}
+  severity: 'warn',
+});
+stylisticWarn.rules ??= {};
 
 stylisticWarn.rules['@stylistic/no-extra-parens'] = [
   'warn',
@@ -84,7 +44,7 @@ stylisticWarn.rules['@stylistic/no-extra-parens'] = [
     allowParensAfterCommentPattern: '@type|@satisfies',
     nestedBinaryExpressions: false,
   },
-];
+] satisfies Linter.RuleEntry<RuleOptions['@stylistic/no-extra-parens']>;
 
 stylisticWarn.rules['@stylistic/semi'] = [
   'warn',
@@ -93,12 +53,13 @@ stylisticWarn.rules['@stylistic/semi'] = [
     omitLastInOneLineBlock: false,
     omitLastInOneLineClassBody: false,
   },
-] satisfies TSESLint.SharedConfig.RuleEntry | [TSESLint.SharedConfig.RuleLevelAndOptions, RuleOptions['@stylistic/semi'][0], RuleOptions['@stylistic/semi'][1]];
+] satisfies Linter.RuleEntry<RuleOptions['@stylistic/semi']>;
 
-const config: TSESLint.FlatConfig.ConfigArray = tseslint.config(
-  json_json,
-  json_json5,
-  json_jsonc,
+const config: ReturnType<typeof defineConfig> = defineConfig(
+  { ...json.configs.recommended, name: 'JSON Recommended', files: ['**/*.json'], language: 'json/json' },
+  { name: 'JSON - Allow empty keys in package-lock.json', files: ['**/package-lock.json'], rules: { 'json/no-empty-keys': 'off' } },
+  { ...json.configs.recommended, name: 'JSONC Recommended', files: ['**/*.jsonc'], language: 'json/jsonc' },
+  { ...json.configs.recommended, name: 'JSON5 Recommended', files: ['**/*.json5'], language: 'json/json5' },
   {
     name: 'TSJS',
     extends: [
@@ -128,56 +89,3 @@ const config: TSESLint.FlatConfig.ConfigArray = tseslint.config(
   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'); })(),
-    },
-    languageOptions: {
-      parser: jsonc.configs['flat/base']
-        .find(v => v.languageOptions?.parser)
-        ?.languageOptions?.parser ?? (() => { throw new Error('Unable to find jsonc parser'); })(),
-    },
-    rules: {
-      ...a.rules,
-      ...b.rules,
-      ...baseRules,
-    },
-  };
-}

package/src/semanticReleaseConfigDotnet.ts

@@ -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.'));
       }
     }
 
@@ -185,16 +185,13 @@ Appending it to the end of the array...This may cause an unexpected order of ope
         ? `${execOptions.verifyConditionsCmd} && ${verifyConditionsCmdAppendix}`
         : verifyConditionsCmdAppendix;
 
-    const verifyReleaseCmdAppendix = await Promise.all(
-      this.ProjectsToPackAndPush
+    const verifyReleaseCmdAppendix
+      = this.ProjectsToPackAndPush
         .filter(project =>
           typeof project !== 'string',
         ).map(project =>
           project.GetIsNextVersionAlreadyPublishedCommand(),
-        ),
-    ).then(cmds =>
-      cmds.join(' && '),
-    );
+        ).join(' && ');
     execOptions.verifyReleaseCmd
       = execOptions.verifyReleaseCmd && execOptions.verifyReleaseCmd.trim().length > 0
         ? `${execOptions.verifyReleaseCmd} && ${verifyReleaseCmdAppendix}`
@@ -364,7 +361,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),
     );
   }
@@ -410,9 +407,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/utils/env.ts

@@ -5,6 +5,9 @@ import { get,
 } from '@dotenvx/dotenvx';
 import { env } from 'node:process';
 
+/** `get` can return `undefined`. It can also return a `Record`, but that's internal. */
+type Get = (key: string, options?: GetOptions) => string | undefined;
+
 /**
  * A thin wrapper for {@link loadDotenv}. Loads a .env file from {@link process.cwd()} with the given options (or defaults), returns the new value of {@link process.env} with optional overrides.
  * @param [dotenvOptions] An optional {@link DotenvConfigOptions} object to pass to {@link loadDotenv}.
@@ -36,7 +39,10 @@ export function getEnv(dotenvOptions?: DotenvConfigOptions, overrides?: NodeJS.P
  */
 export function getEnvVarValue(envVar: string, options?: GetOptions): string | undefined {
   options ??= { ignore: ['MISSING_KEY', 'MISSING_ENV_FILE'] };
-  const value = String(env[envVar] ?? get(envVar, options)).trim();
+  let value = env[envVar];
+  const x = (get as Get)(envVar, options);
+  if (typeof x === 'string')
+    value = x;
   // I hate this. Why is undefined converted to a string?
   return value === '' || value === 'undefined'
     ? undefined

package/src/utils/execAsync.ts

@@ -1,10 +1,9 @@
 /* eslint-disable jsdoc/no-defaults */
-import { type } from 'arktype';
-import type { ObjectType } from 'arktype/internal/methods/object.ts';
+import { type, type Type } from 'arktype';
 import { exec } from 'node:child_process';
 import { constants } from 'node:os';
 import { promisify } from 'node:util';
-import { isNativeError } from 'node:util/types';
+import { isError } from './isError.js';
 
 /**
  * A `promisify(exec)` wrapper to optionally assign the child process's STDERR as the {@link Error.prototype.cause}.
@@ -19,7 +18,7 @@ export async function execAsync(command: string, setStderrAsCause = false): Prom
   stderr: string;
 }> {
   return await promisify(exec)(command).catch((error: unknown): never => {
-    if (!isNativeError(error))
+    if (!isError(error))
       throw new Error(JSON.stringify(error));
 
     if (setStderrAsCause && 'stderr' in error && typeof error.stderr === 'string' && error.stderr !== '')
@@ -40,7 +39,7 @@ export async function execAsync(command: string, setStderrAsCause = false): Prom
   });
 }
 
-const T_ExecException: ObjectType<{
+const T_ExecException: Type<{
   name: string;
   message: string;
   stack?: string | undefined;

package/src/utils/isError.ts

@@ -0,0 +1,18 @@
+import { isNativeError } from 'node:util/types';
+
+/** @import 'typescript/lib/lib.esnext.error.d.ts' */
+
+/**
+ * Compatibility wrapper for ES2026 (Node.js 25)
+ * {@link Error.isError Error.isError}
+ * with failover to the deprecated {@link isNativeError utils.types.isNativeError}.
+ * @param error A parameter which may be an Error.
+ * @returns `true` if {@link error} is derived from or is sufficiently similar to {@link Error}. Else, `false`.
+ * Note: DOMExceptions will result in `false`
+ */
+export function isError(error: unknown): error is Error {
+  return 'isError' in Error && typeof Error.isError === 'function' && Error.isError.length > 0
+    ? (Error.isError as typeof isError)(error)
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    : isNativeError(error);
+}

package/src/utils/miscTypes.ts

@@ -1,7 +1,6 @@
 import { type, type Type } from 'arktype';
-import type { StringType } from 'arktype/internal/methods/string.ts';
 
-export const tBooleanString: StringType<'false' | 'true'> = type('"true" | "false"');
+export const tBooleanString: Type<'false' | 'true'> = type('"true" | "false"');
 export type BooleanString = typeof tBooleanString.infer;
 
 export const tEmptyOrBooleanString: Type<'' | 'false' | 'true'> = type(tBooleanString.or('""'));

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/"
+  }
+}