isaacscript
Version:
A command line tool for managing Isaac mods written in TypeScript.
122 lines • 7.47 kB
JavaScript
import { Command } from "@commander-js/extra-typings";
import chalk from "chalk";
import { PackageManager, deleteFileOrDirectory, fatalError, getPackageManagerInstallCommand, isDirectory, isLink, } from "complete-node";
import path from "node:path";
import { printBanner } from "../../banner.js";
import { getConfigFromFile } from "../../configFile.js";
import { CWD, MOD_SOURCE_PATH } from "../../constants.js";
import { prepareCustomStages } from "../../customStage.js";
import { getAndValidateIsaacScriptMonorepoDirectory } from "../../dev.js";
import { execShell, execShellString } from "../../exec.js";
import { PACKAGE_MANAGER_USED_FOR_ISAACSCRIPT, getPackageManagerUsedForExistingProject, } from "../../packageManager.js";
import { getModTargetDirectoryName } from "../../utils.js";
import { validateDepsInstalled, validateInIsaacScriptProject, validatePackageJSONDependencies, } from "../../validateMod.js";
import { copyWatcherMod } from "./copyWatcherMod.js";
import { notifyGamePing } from "./notifyGame.js";
import { spawnModDirectorySyncer } from "./spawnModDirectorySyncer.js";
import { spawnSaveDatWriter } from "./spawnSaveDatWriter.js";
import { spawnTSTLWatcher } from "./spawnTSTLWatcher.js";
import { touchWatcherSaveDatFiles } from "./touchWatcherSaveDatFiles.js";
export const monitorCommand = new Command()
.command("monitor")
.description("Monitor an IsaacScript mod project for changes.")
.allowExcessArguments(false) // By default, Commander.js will allow extra positional arguments.
.helpOption("-h, --help", "Display the list of options for this command.")
.option("--skip-project-checks", 'Skip checking for "package.json" and "node_modules".', false)
.option("-v, --verbose", "Enable verbose output.", false)
.action(async (options) => {
await monitor(options);
});
// eslint-disable-next-line @typescript-eslint/no-unused-vars
const monitorOptions = monitorCommand.opts();
async function monitor(options) {
const { skipProjectChecks, verbose } = options;
await printBanner();
const packageManager = await getPackageManagerUsedForExistingProject();
if (!skipProjectChecks) {
await validateInIsaacScriptProject();
await validatePackageJSONDependencies();
}
const config = await getConfigFromFile();
if (!skipProjectChecks) {
await validateDepsInstalled(config.isaacScriptCommonDev, verbose);
}
// Read the "tsconfig.json" file.
const modTargetDirectoryName = getModTargetDirectoryName(config);
const modTargetPath = path.join(config.modsDirectory, modTargetDirectoryName);
// Prepare the IsaacScript watcher mod.
await copyWatcherMod(config);
await touchWatcherSaveDatFiles(config);
// Perform the steps to link to a development version of "isaacscript-common", if necessary. (This
// has to be before preparing custom stages.)
await (config.isaacScriptCommonDev === true
? linkDevelopmentIsaacScriptCommon(CWD, packageManager, verbose)
: errorIfIsaacScriptCommonLinkExists(CWD, packageManager));
// Prepare the custom stages feature, if necessary.
await prepareCustomStages(packageManager, config.isaacScriptCommonDev, verbose);
// Delete and re-copy the mod every time IsaacScript starts. This ensures that it is always the
// latest version.
await deleteFileOrDirectory(modTargetPath);
// Subprocess #1 - The "save#.dat" file writer.
spawnSaveDatWriter(config);
// Subprocess #2 - The mod directory syncer.
spawnModDirectorySyncer(config);
// Subprocess #3 - `tstl --watch` (to automatically convert TypeScript to Lua).
spawnTSTLWatcher(config, CWD, packageManager);
// Subprocess #4 - `tstl --watch` (for the development version of `isaacscript-common`).
if (config.isaacScriptCommonDev === true) {
const isaacScriptMonorepoDirectory = await getAndValidateIsaacScriptMonorepoDirectory(CWD);
const isaacScriptCommonDirectory = path.join(isaacScriptMonorepoDirectory, "packages", "isaacscript-common");
const directory = await isDirectory(isaacScriptCommonDirectory);
if (!directory) {
console.error(`The "isaacscript-common" directory does not exist at: ${isaacScriptCommonDirectory}`);
fatalError('Please make sure that the IsaacScript repository is placed next to this one. If you do not want to test a local version of "isaacscript-common", then set the "isaacScriptCommonDev" field to false in your "isaacscript.json" file.');
}
spawnTSTLWatcher(config, isaacScriptCommonDirectory, packageManager, CWD);
}
// Also, start constantly pinging the watcher mod.
setInterval(() => {
notifyGamePing();
}, 1000); // Every second
const srcDir = path.join(CWD, "src");
console.log("Automatically monitoring the following for changes:");
console.log(`1) your TypeScript code: ${chalk.green(srcDir)}`);
console.log(`2) the source mod directory: ${chalk.green(MOD_SOURCE_PATH)}`);
console.log("");
console.log(`Copying files to: ${chalk.green(modTargetPath)}`);
console.log("");
// (The process will now continue indefinitely for as long as the subprocesses exist.)
}
async function linkDevelopmentIsaacScriptCommon(projectPath, packageManager, verbose) {
if (packageManager !== PACKAGE_MANAGER_USED_FOR_ISAACSCRIPT) {
fatalError(`If you want to use this mod to develop/test "isaacscript-common", then the mod must be set up using the ${PACKAGE_MANAGER_USED_FOR_ISAACSCRIPT} package manager instead of: ${packageManager}`);
}
const isaacScriptMonorepoDirectory = await getAndValidateIsaacScriptMonorepoDirectory(projectPath);
console.log('Building "isaacscript-common"...');
// Ensure that dependencies are installed in the isaacscript monorepo.
const installCommand = getPackageManagerInstallCommand(packageManager);
execShellString(installCommand, verbose, false, isaacScriptMonorepoDirectory);
// Build "isaacscript-common".
const iscPackagePath = path.join(isaacScriptMonorepoDirectory, "packages", "isaacscript-common");
const buildCommand = "npm run build";
execShellString(buildCommand, verbose, false, iscPackagePath);
const localIsaacScriptCommonPath = path.join(projectPath, "node_modules", "isaacscript-common");
const link = await isLink(localIsaacScriptCommonPath);
if (link) {
console.log('The "isaacscript-common" package is already linked.');
}
else {
console.log('Linking this repository to the development version of "isaacscript-common"...');
execShell(PACKAGE_MANAGER_USED_FOR_ISAACSCRIPT, ["link", iscPackagePath], verbose, false, projectPath);
}
}
async function errorIfIsaacScriptCommonLinkExists(projectPath, packageManager) {
const localIsaacScriptCommonPath = path.join(projectPath, "node_modules", "isaacscript-common");
const link = await isLink(localIsaacScriptCommonPath);
if (link
&& packageManager !== PackageManager.pnpm // pnpm uses links, so it will cause a false positive.
) {
fatalError(`Your "node_modules/isaacscript-common" directory is linked, but you do not have "isaacScriptCommonDev" set to true in your "isaacscript.json" file. You must either set it to true or remove the link via the following command: ${chalk.green(`${PACKAGE_MANAGER_USED_FOR_ISAACSCRIPT} unlink isaacscript-common`)}`);
}
}
//# sourceMappingURL=monitor.js.map