tools.ts

import child_process = require('child_process');
import esbuild = require('esbuild');
import fs = require('fs');
import path = require('path');

import { buildSrc } from './build-src';
import type { IInputMetadata, InputFolderNames, InputFolders, RunOptionNames, RunOptions } from './src/types/root';

if (!global._outputFilepaths) global._outputFilepaths = [];

const folderNames: InputFolderNames[] = ['private', 'src', 'web', 'Lanette-private'];
const optionNames: RunOptionNames[] = ['offline', 'incrementalBuild', 'modules', 'categories', 'games', 'gameSeed', 'mochaRuns', 'script',
	'grep', 'noBuild', 'noRemote', 'noSha', 'regression'];
const optionAliases: Dict<RunOptionNames> = {
	'local': 'offline',
	'incremental': 'incrementalBuild',
	'module': 'modules',
	'game': 'games',
	'category': 'categories',
};

export function getInputFolders(): InputFolders {
	if (global._inputFolders) return global._inputFolders;

	// __dirname from build script is root/build
	const rootFolder: IInputMetadata = {
		buildPath: __dirname,
		inputPath: path.join(__dirname, ".."),
	};

	const inputFolders: PartialKeyedDict<InputFolderNames, IInputMetadata> = {};
	for (const folderName of folderNames) {
		inputFolders[folderName] = {
			buildPath: path.join(rootFolder.buildPath, folderName),
			inputPath: path.join(rootFolder.inputPath, folderName),
		};

		if (folderName === 'web') {
			inputFolders[folderName].tsConfig = path.join(inputFolders[folderName].inputPath, "tsconfig.json");
		}
	}

	global._inputFolders = {
		root: rootFolder,
		private: inputFolders.private!,
		src: inputFolders.src!,
		web: inputFolders.web!,
		'Lanette-private': inputFolders['Lanette-private']!,
	};

	return global._inputFolders;
}

export function getRunOptions(filename?: string): RunOptions {
	if (!global._runOptions) {
		global._runOptions = {};
        const startIndex = filename ? process.argv.indexOf(filename) + 1 : 0;
		for (let i = startIndex; i < process.argv.length; i++) {
			if (!process.argv[i].startsWith('--')) continue;
			const arg = process.argv[i].substr(2);
			if (!arg) continue;

			const equalsIndex = arg.indexOf('=');
			let optionName = arg;
			let value;
			if (equalsIndex === -1) {
				value = 'true';
			} else {
				optionName = arg.substr(0, equalsIndex);
				value = arg.substr(equalsIndex + 1).trim();
			}

			if (optionName in optionAliases) optionName = optionAliases[optionName];

			if (!optionNames.includes(optionName as RunOptionNames)) throw new Error("Unknown test option '" + optionName + "'");
			global._runOptions[optionName as RunOptionNames] = value;
		}
	}

	return global._runOptions;
}

export async function initializeSrc(options?: RunOptions): Promise<void> {
    await buildSrc(options).catch(e => {
		console.log(e);
		process.exit(1);
	});

	// tools.ts is required by build-src so src files cannot be imported directly

	const appPath = path.join(getInputFolders().src.buildPath, 'app');

	// eslint-disable-next-line @typescript-eslint/no-var-requires
	(require(appPath) as typeof import("./src/app")).instantiate();
}

export function setExceptionHandler(): void {
	process.on('uncaughtException', error => {
		console.log(error);
		Tools.logException(error, "process.on('uncaughtException')");
	});
}

// Modified from https://stackoverflow.com/a/32197381
export function deleteFolderRecursive(folder: string): void {
	folder = folder.trim();
	if (!folder || folder === '/' || folder === '.') return;

	let exists = false;
	try {
		fs.accessSync(folder);
		exists = true;
	} catch (e) {} // eslint-disable-line no-empty

	if (exists) {
		const files = fs.readdirSync(folder);
		for (const file of files) {
			const curPath = path.join(folder, file);
			if (fs.lstatSync(curPath).isDirectory()) {
				deleteFolderRecursive(curPath);
			} else {
				fs.unlinkSync(curPath);
			}
		}

		if (folder !== getInputFolders().root.buildPath) fs.rmdirSync(folder);
	}
}

export function listFilesRecursive(folder: string): string[] {
	folder = folder.trim();
	if (!folder || folder === '/' || folder === '.') return [];

	let fileList: string[] = [];
	let exists = false;
	try {
		fs.accessSync(folder);
		exists = true;
	} catch (e) {} // eslint-disable-line no-empty

	if (exists) {
		const files = fs.readdirSync(folder);
		for (const file of files) {
			const curPath = path.join(folder, file);
			if (fs.lstatSync(curPath).isDirectory()) {
				fileList = fileList.concat(listFilesRecursive(curPath));
			}
			fileList.push(curPath);
		}
	}
	return fileList;
}

export function deletePreviousBuild(): void {
	const inputFolders = getInputFolders();
	for (const folderName of folderNames) {
		if (folderName === 'root') continue;

		deleteFolderRecursive(inputFolders[folderName].buildPath);
	}
}

export function exec(command: string): string | false {
    try {
        const result = child_process.execSync(command);
        if (typeof result === 'string') return result;
        return result.toString();
    } catch (e: unknown) {
        console.log("Failed to run command " + command + ": " + (e as Error).message);
        return false;
    }
}

export function setToSha(sha: string): string | false {
	return exec('git reset --hard ' + sha);
}

export function copyPokemonShowdownShaBase(): void {
	const inputFolders = getInputFolders();
	fs.writeFileSync(path.join(inputFolders.root.inputPath, 'pokemon-showdown-sha.txt'),
		fs.readFileSync(path.join(inputFolders.root.inputPath, 'pokemon-showdown-sha-base.txt')));
}

export function createUntrackedFiles(): void {
	const inputFolders = getInputFolders();
	const pokemonShowdownShaFile = path.join(inputFolders.root.inputPath, 'pokemon-showdown-sha.txt');
	if (!fs.existsSync(pokemonShowdownShaFile)) {
		copyPokemonShowdownShaBase();
    }

	const configFile = path.join(inputFolders.src.inputPath, 'config.ts');
	if (!fs.existsSync(configFile)) {
		console.log("Creating a default config.ts in the src folder (you need to edit this)...");
		fs.writeFileSync(configFile, fs.readFileSync(path.join(inputFolders.src.inputPath, 'config-example.ts')));
    }

	const clientDataDirectory = path.join(inputFolders.root.inputPath, 'client-data');

	const pokedexMiniFile = path.join(clientDataDirectory, 'pokedex-mini.js');
	if (!fs.existsSync(pokedexMiniFile)) {
		fs.writeFileSync(pokedexMiniFile, fs.readFileSync(path.join(clientDataDirectory, 'pokedex-mini-base.js')));
	}

	const pokedexMiniBWFile = path.join(clientDataDirectory, 'pokedex-mini-bw.js');
	if (!fs.existsSync(pokedexMiniBWFile)) {
		fs.writeFileSync(pokedexMiniBWFile, fs.readFileSync(path.join(clientDataDirectory, 'pokedex-mini-bw-base.js')));
	}
}

export function transpile(): void {
	const inputFolders = getInputFolders();
	const tsConfig = path.join(inputFolders.root.inputPath, "tsconfig.json");

	const currentOutputFilepaths: string[] = [];
	for (const folderName of folderNames) {
		if (folderName === 'root') continue;

		const inputFolder = inputFolders[folderName];
		const inputFiles = listFilesRecursive(inputFolder.inputPath);

		const folderEntryPoints: string[] = [];
		for (const filepath of inputFiles) {
			if (!filepath.endsWith('.ts') || filepath.endsWith('.d.ts')) continue;

			folderEntryPoints.push(filepath);

			let outputDirectory = inputFolder.buildPath;
			const relativeFilepath = filepath.substr(inputFolder.inputPath.length + 1);
			let filename = relativeFilepath;
			const index = relativeFilepath.lastIndexOf(path.sep);
			if (index !== -1) {
				outputDirectory = path.join(outputDirectory, relativeFilepath.substr(0, index));
				filename = relativeFilepath.substr(index + 1);
			}

			const outputFilepath = path.join(outputDirectory, filename.substr(0, filename.length - 3) + ".js");
			if (!global._outputFilepaths!.includes(outputFilepath)) global._outputFilepaths!.push(outputFilepath);
			currentOutputFilepaths.push(outputFilepath);
		}

		const result = esbuild.buildSync({
			entryPoints: folderEntryPoints,
			format: 'cjs',
			platform: 'node',
			sourcemap: true,
			tsconfig: inputFolder.tsConfig || tsConfig,
			outdir: inputFolder.buildPath,
		});

		if (result.errors.length) {
			console.log("Error building folder " + folderName + ": " + result.errors.map(x => x.text).join("\n"));
			process.exit(1);
		}

		if (folderName === 'Lanette-private') {
			try {
				const postBuildPath = path.join(inputFolder.buildPath, 'post-build.js');
				require(postBuildPath);
			} catch (e) {} // eslint-disable-line no-empty
		}
	}

	for (const filepath of global._outputFilepaths!) {
		if (!currentOutputFilepaths.includes(filepath)) {
			try {
				fs.unlinkSync(filepath);
			} catch (e) {} // eslint-disable-line no-empty

			try {
				fs.unlinkSync(filepath + ".map");
			} catch (e) {} // eslint-disable-line no-empty

			global._outputFilepaths!.splice(global._outputFilepaths!.indexOf(filepath), 1);
		}
	}
}