Refactor build configs and improve CI/CD checks

This commit makes the build process more robust, simplifies
configurations and reduce the risk of incomplete or erroneous
deployments.

- Centralize output directory definitions by introducing
  `dist-dirs.json`.
- Add `verify-build-artifacts` utility to ensure correct build outputs
  and `print-dist-dir` to determine distribution directory.
- Add steps in CI/CD pipeline to verify build artifacts.
- Migrate Electron Builder config from YAML to CJS for capability to
  read JSON.
- Fix `release-site.yaml` failing due to pointing to wrong distribution
  directory, change it to use `print-dist-dir`.
- Improve `check-desktop-runtime-errors` to verify build artifacts for
  more reliable builds. Ensure tests fail and succeed reliably.
- Update `.gitignore` and configure ESLint to use it to define and
  ignore build artifact directories from one place, remove
  `.eslintignore` that does not add anything after this change.
- Keep `"main"` field in `package.json` as `electron-vite` depends on it
  (alex8088/electron-vite#270).
- Improve documentation

scripts/print-dist-dir.js

@@ -0,0 +1,58 @@
+/**
+ * Description:
+ *   This script determines the absolute path of a distribution directory based on CLI arguments
+ *   and outputs its absolute path. It is designed to be run programmatically by other scripts.
+ *
+ * Usage:
+ *   node scripts/print-dist-dir.js [options]
+ *
+ * Options:
+ *   --electron-unbundled   Path for the unbundled Electron application
+ *   --electron-bundled     Path for the bundled Electron application
+ *   --web                  Path for the web application
+ */
+
+import { resolve } from 'path';
+import { readFile } from 'fs/promises';
+
+const DIST_DIRS_JSON_FILE_PATH = resolve(process.cwd(), 'dist-dirs.json'); // cannot statically import because ESLint does not support it https://github.com/eslint/eslint/discussions/15305
+const CLI_ARGUMENTS = process.argv.slice(2);
+
+async function main() {
+  const distDirs = await readDistDirsJsonFile(DIST_DIRS_JSON_FILE_PATH);
+  const relativeDistDir = determineRelativeDistDir(distDirs, CLI_ARGUMENTS);
+  const absoluteDistDir = resolve(process.cwd(), relativeDistDir);
+  console.log(absoluteDistDir);
+}
+
+function mapCliFlagsToDistDirs(distDirs) {
+  return {
+    '--electron-unbundled': distDirs.electronUnbundled,
+    '--electron-bundled': distDirs.electronBundled,
+    '--web': distDirs.web,
+  };
+}
+
+function determineRelativeDistDir(distDirsJsonObject, cliArguments) {
+  const cliFlagDistDirMap = mapCliFlagsToDistDirs(distDirsJsonObject);
+  const availableCliFlags = Object.keys(cliFlagDistDirMap);
+  const requestedCliFlags = cliArguments.filter((arg) => {
+    return availableCliFlags.includes(arg);
+  });
+  if (!requestedCliFlags.length) {
+    throw new Error(`No distribution directory was requested. Please use one of these flags: ${availableCliFlags.join(', ')}`);
+  }
+  if (requestedCliFlags.length > 1) {
+    throw new Error(`Multiple distribution directories were requested, but this script only supports one: ${requestedCliFlags.join(', ')}`);
+  }
+  const selectedCliFlag = requestedCliFlags[0];
+  return cliFlagDistDirMap[selectedCliFlag];
+}
+
+async function readDistDirsJsonFile(absoluteConfigJsonFilePath) {
+  const fileContentAsText = await readFile(absoluteConfigJsonFilePath, 'utf8');
+  const parsedJsonData = JSON.parse(fileContentAsText);
+  return parsedJsonData;
+}
+
+await main();

scripts/verify-build-artifacts.js

@@ -0,0 +1,133 @@
+/**
+ * Description:
+ *   This script verifies the existence and content of build artifacts based on the
+ *   provided CLI flags. It exists with exit code `0` if all verifications pass, otherwise
+ *   with exit code `1`.
+ *
+ * Usage:
+ *   node scripts/verify-build-artifacts.js [options]
+ *
+ * Options:
+ *   --electron-unbundled    Verify artifacts for the unbundled Electron application.
+ *   --electron-bundled      Verify artifacts for the bundled Electron application.
+ *   --web                   Verify artifacts for the web application.
+ */
+
+import { access, readdir } from 'fs/promises';
+import { exec } from 'child_process';
+import { resolve } from 'path';
+
+const PROCESS_ARGUMENTS = process.argv.slice(2);
+const PRINT_DIST_DIR_SCRIPT_BASE_COMMAND = 'node scripts/print-dist-dir';
+
+async function main() {
+  const buildConfigs = getBuildVerificationConfigs();
+  if (!anyCommandsFound(Object.keys(buildConfigs))) {
+    die(`No valid command found in process arguments. Expected one of: ${Object.keys(buildConfigs).join(', ')}`);
+  }
+  /* eslint-disable no-await-in-loop */
+  for (const [command, config] of Object.entries(buildConfigs)) {
+    if (PROCESS_ARGUMENTS.includes(command)) {
+      const distDir = await executePrintDistDirScript(config.printDistDirScriptArgument);
+      await verifyDirectoryExists(distDir);
+      await verifyNonEmptyDirectory(distDir);
+      await verifyFilesExist(distDir, config.filePatterns);
+    }
+  }
+  /* eslint-enable no-await-in-loop */
+  console.log('✅ Build completed successfully and all expected artifacts are in place.');
+  process.exit(0);
+}
+
+function getBuildVerificationConfigs() {
+  return {
+    '--electron-unbundled': {
+      printDistDirScriptArgument: '--electron-unbundled',
+      filePatterns: [
+        /main[/\\]index\.cjs/,
+        /preload[/\\]index\.cjs/,
+        /renderer[/\\]index\.htm(l)?/,
+      ],
+    },
+    '--electron-bundled': {
+      printDistDirScriptArgument: '--electron-bundled',
+      filePatterns: [
+        /latest.*\.yml/, // generates latest.yml for auto-updates
+        /.*-\d+\.\d+\.\d+\..*/, // a file with extension and semantic version (packaged application)
+      ],
+    },
+    '--web': {
+      printDistDirScriptArgument: '--web',
+      filePatterns: [
+        /index\.htm(l)?/,
+      ],
+    },
+  };
+}
+
+function anyCommandsFound(commands) {
+  return PROCESS_ARGUMENTS.some((arg) => commands.includes(arg));
+}
+
+async function verifyDirectoryExists(directoryPath) {
+  try {
+    await access(directoryPath);
+  } catch (error) {
+    die(`Directory does not exist at \`${directoryPath}\`:\n\t${error.message}`);
+  }
+}
+
+async function verifyNonEmptyDirectory(directoryPath) {
+  const files = await readdir(directoryPath);
+  if (files.length === 0) {
+    die(`Directory is empty at \`${directoryPath}\``);
+  }
+}
+
+async function verifyFilesExist(directoryPath, filePatterns) {
+  const files = await listAllFilesRecursively(directoryPath);
+  for (const pattern of filePatterns) {
+    const match = files.some((file) => pattern.test(file));
+    if (!match) {
+      die(
+        `No file matches the pattern ${pattern.source} in directory \`${directoryPath}\``,
+        `\nFiles in directory:\n${files.map((file) => `\t- ${file}`).join('\n')}`,
+      );
+    }
+  }
+}
+
+async function listAllFilesRecursively(directoryPath) {
+  const dir = await readdir(directoryPath, { withFileTypes: true });
+  const files = await Promise.all(dir.map(async (dirent) => {
+    const absolutePath = resolve(directoryPath, dirent.name);
+    if (dirent.isDirectory()) {
+      return listAllFilesRecursively(absolutePath);
+    }
+    return absolutePath;
+  }));
+  return files.flat();
+}
+
+async function executePrintDistDirScript(flag) {
+  return new Promise((resolve, reject) => {
+    const commandToRun = `${PRINT_DIST_DIR_SCRIPT_BASE_COMMAND} ${flag}`;
+
+    exec(commandToRun, (error, stdout, stderr) => {
+      if (error) {
+        reject(new Error(`Execution failed with error: ${error}`));
+      } else if (stderr) {
+        reject(new Error(`Execution failed with stderr: ${stderr}`));
+      } else {
+        resolve(stdout.trim());
+      }
+    });
+  });
+}
+
+function die(...message) {
+  console.error(...message);
+  process.exit(1);
+}
+
+await main();