isaacscript 2.0.6 → 2.0.9

package/src/commands/publish/publish.ts

@@ -1,392 +0,0 @@
-import chalk from "chalk";
-import path from "path";
-import {
-  CONFIG_FILE_NAME,
-  CONSTANTS_TS_PATH,
-  METADATA_XML_PATH,
-  MOD_SOURCE_PATH,
-  MOD_UPLOADER_PATH,
-  PACKAGE_JSON_PATH,
-  PROJECT_NAME,
-  PUBLISH_POST_COPY_PY_PATH,
-  PUBLISH_PRE_COPY_PY_PATH,
-  VERSION_TXT_PATH,
-} from "../../constants";
-import { execExe, execPowershell, execShell } from "../../exec";
-import * as file from "../../file";
-import { Config } from "../../types/Config";
-import { error, getModTargetDirectoryName, parseIntSafe } from "../../utils";
-import { compileAndCopy } from "../copy/copy";
-import { gitCommitIfChanges, isGitDirty } from "../init/git";
-
-const UPDATE_SCRIPT_NAME = "update.sh";
-
-export function publish(argv: Record<string, unknown>, config: Config): void {
-  const skipVersionIncrement = argv["skip"] === true;
-  const setVersion = argv["setVersion"] as string | undefined;
-  const dryRun = argv["dryRun"] === true;
-  const onlyUpload = argv["onlyUpload"] === true;
-  const verbose = argv["verbose"] === true;
-
-  const modTargetDirectoryName = getModTargetDirectoryName(config);
-  const modTargetPath = path.join(config.modsDirectory, modTargetDirectoryName);
-
-  validateVersion(setVersion);
-  validateGitNotDirty(verbose);
-  validateIsaacScriptOtherCopiesNotRunning(verbose);
-
-  if (onlyUpload) {
-    uploadMod(modTargetPath, config.steamCmdPath, verbose);
-    return;
-  }
-
-  startPublish(
-    MOD_SOURCE_PATH,
-    modTargetPath,
-    skipVersionIncrement,
-    setVersion,
-    config.steamCmdPath,
-    dryRun,
-    verbose,
-  );
-}
-
-function validateVersion(setVersion: string | undefined) {
-  if (setVersion !== undefined && /^\d+\.\d+\.\d+$/.exec(setVersion) === null) {
-    error(
-      chalk.red(
-        `The version of "${setVersion}" does not match the semantic versioning format.`,
-      ),
-    );
-  }
-}
-
-function validateGitNotDirty(verbose: boolean) {
-  if (isGitDirty(verbose)) {
-    error(
-      chalk.red(
-        "Before publishing, you must push your current changes to git. (Version commits should be not contain any code changes.)",
-      ),
-    );
-  }
-}
-
-function validateIsaacScriptOtherCopiesNotRunning(verbose: boolean) {
-  if (process.platform !== "win32") {
-    return;
-  }
-
-  // From: https://securityboulevard.com/2020/01/get-process-list-with-command-line-arguments/
-  const stdout = execPowershell(
-    "Get-WmiObject Win32_Process -Filter \"name = 'node.exe'\" | Select-Object -ExpandProperty CommandLine",
-    verbose,
-  );
-  const lines = stdout.split("\r\n");
-  const otherCopiesOfRunningIsaacScript = lines.filter(
-    (line) =>
-      line.includes("node.exe") &&
-      line.includes("isaacscript") &&
-      !line.includes("isaacscript publish"),
-  );
-  if (otherCopiesOfRunningIsaacScript.length > 0) {
-    error(
-      chalk.red(
-        `Other copies of ${PROJECT_NAME} appear to be running. You must close those copies before publishing.`,
-      ),
-    );
-  }
-}
-
-function startPublish(
-  modSourcePath: string,
-  modTargetPath: string,
-  skipVersionIncrement: boolean,
-  setVersion: string | undefined,
-  steamCmdPath: string | undefined,
-  dryRun: boolean,
-  verbose: boolean,
-) {
-  updateDeps(verbose);
-
-  let version =
-    setVersion === undefined ? getVersionFromPackageJSON(verbose) : setVersion;
-  if (!skipVersionIncrement && setVersion === undefined) {
-    version = bumpVersionInPackageJSON(version, verbose);
-  } else if (setVersion !== undefined) {
-    writeVersionInPackageJSON(version, verbose);
-  }
-
-  writeVersionToConstantsTS(version, verbose);
-  writeVersionToMetadataXML(version, verbose);
-  writeVersionToVersionTXT(version, verbose);
-  runReleaseScriptPreCopy(verbose);
-  compileAndCopy(modSourcePath, modTargetPath, verbose);
-  purgeRoomXMLs(modTargetPath, verbose);
-  runReleaseScriptPostCopy(verbose);
-
-  if (!dryRun) {
-    gitCommitIfChanges(version, verbose);
-    uploadMod(modTargetPath, steamCmdPath, verbose);
-  }
-
-  const dryRunSuffix = dryRun ? " (dry run)" : "";
-  console.log(`\nPublished version ${version} successfully${dryRunSuffix}.`);
-}
-
-function updateDeps(verbose: boolean) {
-  if (!file.exists(UPDATE_SCRIPT_NAME, verbose)) {
-    error(
-      `The "${UPDATE_SCRIPT_NAME}" script does not exist in the current working directory.`,
-    );
-  }
-
-  execShell("bash", [UPDATE_SCRIPT_NAME], verbose);
-}
-
-function getVersionFromPackageJSON(verbose: boolean) {
-  if (!file.exists(PACKAGE_JSON_PATH, verbose)) {
-    error(
-      chalk.red(
-        `A "${PACKAGE_JSON_PATH}" was not found in the current directory.`,
-      ),
-    );
-  }
-
-  const packageJSONRaw = file.read(PACKAGE_JSON_PATH, verbose);
-  let packageJSON: Record<string, unknown>;
-  try {
-    packageJSON = JSON.parse(packageJSONRaw) as Record<string, unknown>;
-  } catch (err) {
-    error(`Failed to parse "${chalk.green(PACKAGE_JSON_PATH)}":`, err);
-  }
-
-  if (!Object.prototype.hasOwnProperty.call(packageJSON, "version")) {
-    error(
-      `The "${chalk.green(
-        PACKAGE_JSON_PATH,
-      )}" file does not have a "version" field.`,
-    );
-  }
-
-  if (typeof packageJSON["version"] !== "string") {
-    error(
-      `The "${chalk.green(
-        PACKAGE_JSON_PATH,
-      )}" file has a "version" field that is not a string.`,
-    );
-  }
-
-  return packageJSON["version"];
-}
-
-function bumpVersionInPackageJSON(version: string, verbose: boolean): string {
-  // Get the patch version (i.e. the third number)
-  const matches = /(\d+\.\d+\.)(\d+)/.exec(version);
-  if (matches === null) {
-    error(`Failed to parse the version of: ${version}`);
-  }
-
-  const versionPrefix = matches[1];
-  if (versionPrefix === undefined) {
-    error(`Failed to parse the first part of the version: ${version}`);
-  }
-
-  const patchVersionString = matches[2];
-  if (patchVersionString === undefined) {
-    error(`Failed to parse the second part of the version: ${version}`);
-  }
-
-  const patchVersion = parseIntSafe(patchVersionString);
-  if (Number.isNaN(patchVersion)) {
-    error(`Failed to convert "${patchVersionString}" to a number.`);
-  }
-
-  const incrementedPatchVersion = patchVersion + 1;
-  const incrementedVersion = `${versionPrefix}${incrementedPatchVersion}`;
-
-  const packageJSON = file.read(PACKAGE_JSON_PATH, verbose);
-  const newPackageJSON = packageJSON.replace(
-    /"version": ".+",/,
-    `"version": "${incrementedVersion}",`,
-  );
-  file.write(PACKAGE_JSON_PATH, newPackageJSON, verbose);
-
-  console.log(
-    `The version of ${incrementedVersion} was written to: ${PACKAGE_JSON_PATH}`,
-  );
-
-  return incrementedVersion;
-}
-
-function writeVersionInPackageJSON(version: string, verbose: boolean) {
-  const packageJSON = file.read(PACKAGE_JSON_PATH, verbose);
-  const newPackageJSON = packageJSON.replace(
-    /"version": ".+",/,
-    `"version": "${version}",`,
-  );
-  file.write(PACKAGE_JSON_PATH, newPackageJSON, verbose);
-
-  console.log(`The version of ${version} was written to: ${PACKAGE_JSON_PATH}`);
-}
-
-function writeVersionToConstantsTS(version: string, verbose: boolean) {
-  if (!file.exists(CONSTANTS_TS_PATH, verbose)) {
-    console.log(
-      'Skipping writing the version to "constants.ts" since it was not found.',
-    );
-    return;
-  }
-
-  const constantsTS = file.read(CONSTANTS_TS_PATH, verbose);
-  const newConstantsTS = constantsTS.replace(
-    /const VERSION = ".+"/,
-    `const VERSION = "${version}"`,
-  );
-  file.write(CONSTANTS_TS_PATH, newConstantsTS, verbose);
-
-  console.log(`The version of ${version} was written to: ${CONSTANTS_TS_PATH}`);
-}
-
-function writeVersionToMetadataXML(version: string, verbose: boolean) {
-  const metadataXML = file.read(METADATA_XML_PATH, verbose);
-  const newMetadataXML = metadataXML.replace(
-    /<version>.+<\/version>/,
-    `<version>${version}</version>`,
-  );
-  file.write(METADATA_XML_PATH, newMetadataXML, verbose);
-
-  console.log(`The version of ${version} was written to: ${METADATA_XML_PATH}`);
-}
-
-function writeVersionToVersionTXT(version: string, verbose: boolean) {
-  file.write(VERSION_TXT_PATH, version, verbose);
-
-  console.log(`The version of ${version} was written to: ${VERSION_TXT_PATH}`);
-}
-
-function runReleaseScriptPreCopy(verbose: boolean) {
-  if (!file.exists(PUBLISH_PRE_COPY_PY_PATH, verbose)) {
-    return;
-  }
-
-  console.log(`Running the "${PUBLISH_PRE_COPY_PY_PATH}" script.`);
-  let [, stdout] = execShell("python", [PUBLISH_PRE_COPY_PY_PATH], verbose);
-  stdout = stdout.trim();
-  if (stdout.length > 0) {
-    console.log(stdout);
-  }
-}
-
-function runReleaseScriptPostCopy(verbose: boolean) {
-  if (!file.exists(PUBLISH_POST_COPY_PY_PATH, verbose)) {
-    return;
-  }
-
-  console.log(`Running the "${PUBLISH_POST_COPY_PY_PATH}" script.`);
-  let [, stdout] = execShell("python", [PUBLISH_POST_COPY_PY_PATH], verbose);
-  stdout = stdout.trim();
-  if (stdout.length > 0) {
-    console.log(stdout);
-  }
-}
-
-function purgeRoomXMLs(modTargetPath: string, verbose: boolean) {
-  const roomsPath = path.join(modTargetPath, "resources", "rooms");
-  if (!file.exists(roomsPath, verbose) || !file.isDir(roomsPath, verbose)) {
-    return;
-  }
-
-  const roomFileList = file.getDirList(roomsPath, verbose);
-  roomFileList.forEach((fileName: string) => {
-    if (path.extname(fileName) === ".xml") {
-      const roomFilePath = path.join(roomsPath, fileName);
-      file.deleteFileOrDirectory(roomFilePath, verbose);
-    }
-  });
-}
-
-function uploadMod(
-  modTargetPath: string,
-  steamCmdPath: string | undefined,
-  verbose: boolean,
-) {
-  if (steamCmdPath === undefined) {
-    console.log(
-      `The "steamCmdPath" property was not found in the "${chalk.green(
-        CONFIG_FILE_NAME,
-      )}" file; assuming that we want to use the ModUploader tool.`,
-    );
-    execExe(MOD_UPLOADER_PATH, verbose, modTargetPath);
-  } else {
-    runSteamCmd(modTargetPath, steamCmdPath, verbose);
-  }
-}
-
-function runSteamCmd(
-  modTargetPath: string,
-  steamCmdPath: string,
-  verbose: boolean,
-) {
-  if (!file.exists(steamCmdPath, verbose)) {
-    error(
-      chalk.red(
-        `The path provided for "steamCmdPath" is "${steamCmdPath}", but that does not exist.`,
-      ),
-    );
-  }
-
-  const metadataVDFPath = path.join(modTargetPath, "metadata.vdf");
-  if (!file.exists(metadataVDFPath, verbose)) {
-    console.error(
-      chalk.red(
-        `A "metadata.vdf" file was not found in your mod directory. You must create this file in order for "steamcmd.exe" to work. Please see the ${PROJECT_NAME} docs:`,
-      ),
-    );
-    error(getIsaacScriptDocs());
-  }
-
-  const usernameVar = "STEAM_USERNAME";
-  const username = process.env[usernameVar];
-  if (username === undefined || username === "") {
-    console.error(
-      chalk.red(
-        `Failed to read the "${usernameVar}" environment variable from the ".env" file. Please see the ${PROJECT_NAME} docs:`,
-      ),
-    );
-    error(getIsaacScriptDocs());
-  }
-
-  const passwordVar = "STEAM_PASSWORD";
-  const password = process.env[passwordVar];
-  if (password === undefined || password === "") {
-    console.error(
-      chalk.red(
-        `Failed to read the "${passwordVar}" environment variable from the ".env" file. Please see the ${PROJECT_NAME} docs:`,
-      ),
-    );
-    error(getIsaacScriptDocs());
-  }
-
-  console.log("Uploading the mod to the Steam Workshop...");
-
-  execShell(
-    steamCmdPath,
-    [
-      "+login",
-      username,
-      password,
-      "+workshop_build_item",
-      metadataVDFPath,
-      "+quit",
-    ],
-    verbose,
-  );
-
-  console.log("Mod uploaded successfully.");
-}
-
-function getIsaacScriptDocs() {
-  return chalk.red(
-    "https://isaacscript.github.io/docs/publishing-to-the-workshop/#metadatavdf",
-  );
-}

package/src/configFile.ts

@@ -1,80 +0,0 @@
-import chalk from "chalk";
-import * as JSONC from "jsonc-parser";
-import path from "path";
-import { getModsDir } from "./commands/init/getModsDir";
-import { promptSaveSlot } from "./commands/init/promptSaveSlot";
-import { CONFIG_FILE_NAME, CONFIG_FILE_PATH, CWD } from "./constants";
-import * as file from "./file";
-import { Config } from "./types/Config";
-import { error } from "./utils";
-
-export async function get(argv: Record<string, unknown>): Promise<Config> {
-  const verbose = argv["verbose"] === true;
-  const yes = argv["yes"] === true;
-
-  const existingConfig = readExistingConfig(verbose);
-  if (existingConfig !== undefined) {
-    return existingConfig;
-  }
-
-  // No config file exists, so prompt the user for some information and create one
-  const modsDirectory = await getModsDir(argv, verbose);
-  const saveSlot = await promptSaveSlot(argv, yes);
-  const config = createObject(modsDirectory, saveSlot);
-  createFile(CWD, config, verbose);
-
-  return config;
-}
-
-function readExistingConfig(verbose: boolean): Config | undefined {
-  if (!file.exists(CONFIG_FILE_PATH, verbose)) {
-    return undefined;
-  }
-
-  const configRaw = file.read(CONFIG_FILE_PATH, verbose);
-  let config: Config;
-  try {
-    config = JSONC.parse(configRaw) as Config;
-  } catch (err) {
-    error(`Failed to parse the "${chalk.green(CONFIG_FILE_PATH)}" file:`, err);
-  }
-
-  if (config.modsDirectory === undefined) {
-    errorMissing(
-      "modsDirectory",
-      "This should be equal to the directory where Isaac mods live on your system.",
-    );
-  }
-
-  if (config.saveSlot === undefined) {
-    errorMissing(
-      "saveSlot",
-      "This should be equal to the save slot that you test your mods on.",
-    );
-  }
-
-  return config;
-}
-
-function errorMissing(field: string, description: string) {
-  error(
-    `The "${CONFIG_FILE_NAME}" file is missing a "${field}" value. ${description} Please add it.`,
-  );
-}
-
-export function createObject(modsDirectory: string, saveSlot: number): Config {
-  return {
-    modsDirectory,
-    saveSlot,
-  };
-}
-
-export function createFile(
-  projectPath: string,
-  config: Config,
-  verbose: boolean,
-): void {
-  const configFilePath = path.join(projectPath, CONFIG_FILE_NAME);
-  const configContents = JSON.stringify(config, null, 2);
-  file.write(configFilePath, configContents, verbose);
-}

package/src/constants.ts

@@ -1,85 +0,0 @@
-import os from "os";
-import path from "path";
-
-const cwd = process.cwd();
-
-// https://stackoverflow.com/questions/9080085/node-js-find-home-directory-in-platform-agnostic-way
-const homeDir = os.homedir();
-
-// Miscellaneous
-export const CURRENT_DIRECTORY_NAME = path.basename(cwd);
-export const CWD = cwd;
-export const HOME_DIR = homeDir;
-export const FILE_SYNCED_MESSAGE = "File synced:";
-export const MOD_UPLOADER_PATH =
-  "C:\\Program Files (x86)\\Steam\\steamapps\\common\\The Binding of Isaac Rebirth\\tools\\ModUploader\\ModUploader.exe";
-export const PROJECT_NAME = "IsaacScript";
-
-// isaacscript
-const REPO_ROOT = path.join(__dirname, "..", "..");
-
-// isaacscript/isaacscript-watcher
-export const DISABLE_IT_FILE = "disable.it";
-export const WATCHER_MOD_NAME = "isaacscript-watcher";
-export const WATCHER_MOD_SOURCE_PATH = path.join(REPO_ROOT, WATCHER_MOD_NAME);
-
-// isaacscript/file-templates
-const TEMPLATES_DIR = path.join(REPO_ROOT, "file-templates");
-
-// isaacscript/file-templates/static
-export const TEMPLATES_STATIC_DIR = path.join(TEMPLATES_DIR, "static");
-
-// isaacscript/file-templates/dynamic
-const TEMPLATES_DYNAMIC_DIR = path.join(TEMPLATES_DIR, "dynamic");
-export const GITIGNORE = "gitignore"; // Not named ".gitignore" to prevent NPM from deleting it
-export const GITIGNORE_TEMPLATE_PATH = path.join(
-  TEMPLATES_DYNAMIC_DIR,
-  GITIGNORE,
-);
-export const MAIN_TS = "main.ts";
-export const MAIN_TS_TEMPLATE_PATH = path.join(TEMPLATES_DYNAMIC_DIR, MAIN_TS);
-export const METADATA_XML = "metadata.xml";
-export const METADATA_XML_TEMPLATE_PATH = path.join(
-  TEMPLATES_DYNAMIC_DIR,
-  METADATA_XML,
-);
-export const METADATA_VDF = "metadata.vdf";
-export const METADATA_VDF_TEMPLATE_PATH = path.join(
-  TEMPLATES_DYNAMIC_DIR,
-  METADATA_VDF,
-);
-export const PACKAGE_JSON = "package.json";
-export const PACKAGE_JSON_TEMPLATE_PATH = path.join(
-  TEMPLATES_DYNAMIC_DIR,
-  PACKAGE_JSON,
-);
-export const README_MD = "README.md";
-export const README_MD_TEMPLATES_PATH = path.join(
-  TEMPLATES_DYNAMIC_DIR,
-  README_MD,
-);
-
-// project
-export const CONFIG_FILE_NAME = "isaacscript.json";
-export const CONFIG_FILE_PATH = path.join(CWD, CONFIG_FILE_NAME);
-export const TSCONFIG_PATH = path.join(CWD, "tsconfig.json");
-export const PACKAGE_JSON_PATH = path.join(CWD, "package.json");
-export const CONSTANTS_TS_PATH = path.join(CWD, "src", "constants.ts");
-export const YARN_LOCK_PATH = path.join(CWD, "yarn.lock");
-
-// project/mod
-export const MOD_SOURCE_PATH = path.join(CWD, "mod");
-export const MAIN_LUA = "main.lua";
-export const METADATA_XML_PATH = path.join(MOD_SOURCE_PATH, "metadata.xml");
-export const VERSION_TXT_PATH = path.join(MOD_SOURCE_PATH, "version.txt");
-
-// project/scripts
-const SCRIPTS_PATH = path.join(CWD, "scripts");
-export const PUBLISH_PRE_COPY_PY_PATH = path.join(
-  SCRIPTS_PATH,
-  "publish_pre_copy.py",
-);
-export const PUBLISH_POST_COPY_PY_PATH = path.join(
-  SCRIPTS_PATH,
-  "publish_post_copy.py",
-);

package/src/exec.ts

@@ -1,125 +0,0 @@
-import chalk from "chalk";
-import { execSync, spawnSync, SpawnSyncReturns } from "child_process";
-import { CWD } from "./constants";
-import { error } from "./utils";
-
-export function execExe(path: string, verbose: boolean, cwd = CWD): string {
-  if (verbose) {
-    console.log(`Executing binary: ${path}`);
-  }
-
-  let stdout: string;
-  try {
-    const buffer = execSync(`"${path}"`, {
-      cwd,
-    });
-    stdout = buffer.toString().trim();
-  } catch (err) {
-    error(`Failed to run "${chalk.green(path)}":`, err);
-  }
-
-  if (verbose) {
-    console.log(`Executed binary: ${path}`);
-  }
-
-  return stdout;
-}
-
-export function execPowershell(
-  command: string,
-  verbose = false,
-  cwd = CWD,
-): string {
-  if (verbose) {
-    console.log(`Executing PowerShell command: ${command}`);
-  }
-
-  let stdout: string;
-  try {
-    const buffer = execSync(command, {
-      shell: "powershell.exe",
-      cwd,
-    });
-    stdout = buffer.toString().trim();
-  } catch (err) {
-    error(`Failed to run PowerShell command "${chalk.green(command)}":`, err);
-  }
-
-  if (verbose) {
-    console.log(`Executed PowerShell command: ${command}`);
-  }
-
-  return stdout;
-}
-
-/** Returns a tuple of exit status and stdout. The stdout is trimmed for convenience. */
-export function execShell(
-  command: string,
-  args: string[] = [],
-  verbose = false,
-  allowFailure = false,
-  cwd = CWD,
-): [exitStatus: number, stdout: string] {
-  // On Windows, "spawnSync()" will not account for spaces in arguments. Thus, wrap everything in a
-  // double quote. This will cause arguments that naturally have double quotes to fail.
-  if (command.includes('"')) {
-    error(
-      "execShell cannot execute commands with double quotes in the command.",
-    );
-  }
-
-  const argsHasDoubleQuotes = args.some((arg) => arg.includes('"'));
-  if (argsHasDoubleQuotes) {
-    error(
-      "execShell cannot execute commands with double quotes in the arguments.",
-    );
-  }
-
-  const quotedArgs = args.map((arg) => `"${arg}"`);
-  const commandDescription = `${command} ${quotedArgs.join(" ")}`.trim();
-
-  if (verbose) {
-    console.log(`Executing command: ${commandDescription}`);
-  }
-
-  let spawnSyncReturns: SpawnSyncReturns<Buffer>;
-  try {
-    spawnSyncReturns = spawnSync(command, args, {
-      shell: true,
-      cwd,
-    });
-  } catch (err) {
-    error(
-      `Failed to run the "${chalk.green(commandDescription)}" command:`,
-      err,
-    );
-  }
-
-  if (verbose) {
-    console.log(`Executed command: ${commandDescription}`);
-  }
-
-  const exitStatus = spawnSyncReturns.status;
-  if (exitStatus === null) {
-    error(`Failed to get the return status of command: ${commandDescription}`);
-  }
-
-  const stdout = spawnSyncReturns.output.join("\n").trim();
-
-  if (exitStatus !== 0) {
-    if (allowFailure) {
-      return [exitStatus, stdout];
-    }
-
-    console.error(
-      `Failed to run the "${chalk.green(
-        commandDescription,
-      )}" command with an exit code of ${exitStatus}.`,
-    );
-    console.error("The output was as follows:");
-    console.error(stdout);
-    process.exit(1);
-  }
-
-  return [exitStatus, stdout];
-}