0a2a1a026b
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
59 lines
2.2 KiB
JavaScript
59 lines
2.2 KiB
JavaScript
/**
|
|
* 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();
|