isaacscript 1.2.29 → 1.2.32

package/src/commands/publish/publish.ts

@@ -109,7 +109,7 @@ function startPublish(
   updateDeps(verbose);
 
   let version =
-    setVersion === undefined ? getVersionFromPackageJSON() : setVersion;
+    setVersion === undefined ? getVersionFromPackageJSON(verbose) : setVersion;
   if (!skipVersionIncrement && setVersion === undefined) {
     version = bumpVersionInPackageJSON(version, verbose);
   } else if (setVersion !== undefined) {
@@ -134,7 +134,7 @@ function startPublish(
 }
 
 function updateDeps(verbose: boolean) {
-  if (!file.exists(UPDATE_SCRIPT_NAME)) {
+  if (!file.exists(UPDATE_SCRIPT_NAME, verbose)) {
     error(
       `The "${UPDATE_SCRIPT_NAME}" script does not exist in the current working directory.`,
     );
@@ -143,8 +143,8 @@ function updateDeps(verbose: boolean) {
   execShell("bash", [UPDATE_SCRIPT_NAME], verbose);
 }
 
-function getVersionFromPackageJSON() {
-  if (!file.exists(PACKAGE_JSON_PATH)) {
+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.`,
@@ -152,7 +152,7 @@ function getVersionFromPackageJSON() {
     );
   }
 
-  const packageJSONRaw = file.read(PACKAGE_JSON_PATH);
+  const packageJSONRaw = file.read(PACKAGE_JSON_PATH, verbose);
   let packageJSON: Record<string, unknown>;
   try {
     packageJSON = JSON.parse(packageJSONRaw) as Record<string, unknown>;
@@ -204,7 +204,7 @@ function bumpVersionInPackageJSON(version: string, verbose: boolean): string {
   const incrementedPatchVersion = patchVersion + 1;
   const incrementedVersion = `${versionPrefix}${incrementedPatchVersion}`;
 
-  const packageJSON = file.read(PACKAGE_JSON_PATH);
+  const packageJSON = file.read(PACKAGE_JSON_PATH, verbose);
   const newPackageJSON = packageJSON.replace(
     /"version": ".+",/,
     `"version": "${incrementedVersion}",`,
@@ -219,7 +219,7 @@ function bumpVersionInPackageJSON(version: string, verbose: boolean): string {
 }
 
 function writeVersionInPackageJSON(version: string, verbose: boolean) {
-  const packageJSON = file.read(PACKAGE_JSON_PATH);
+  const packageJSON = file.read(PACKAGE_JSON_PATH, verbose);
   const newPackageJSON = packageJSON.replace(
     /"version": ".+",/,
     `"version": "${version}",`,
@@ -230,14 +230,14 @@ function writeVersionInPackageJSON(version: string, verbose: boolean) {
 }
 
 function writeVersionToConstantsTS(version: string, verbose: boolean) {
-  if (!file.exists(CONSTANTS_TS_PATH)) {
+  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);
+  const constantsTS = file.read(CONSTANTS_TS_PATH, verbose);
   const newConstantsTS = constantsTS.replace(
     /const VERSION = ".+"/,
     `const VERSION = "${version}"`,
@@ -248,7 +248,7 @@ function writeVersionToConstantsTS(version: string, verbose: boolean) {
 }
 
 function writeVersionToMetadataXML(version: string, verbose: boolean) {
-  const metadataXML = file.read(METADATA_XML_PATH);
+  const metadataXML = file.read(METADATA_XML_PATH, verbose);
   const newMetadataXML = metadataXML.replace(
     /<version>.+<\/version>/,
     `<version>${version}</version>`,
@@ -265,7 +265,7 @@ function writeVersionToVersionTXT(version: string, verbose: boolean) {
 }
 
 function runReleaseScriptPreCopy(verbose: boolean) {
-  if (!file.exists(PUBLISH_PRE_COPY_PY_PATH)) {
+  if (!file.exists(PUBLISH_PRE_COPY_PY_PATH, verbose)) {
     return;
   }
 
@@ -278,7 +278,7 @@ function runReleaseScriptPreCopy(verbose: boolean) {
 }
 
 function runReleaseScriptPostCopy(verbose: boolean) {
-  if (!file.exists(PUBLISH_POST_COPY_PY_PATH)) {
+  if (!file.exists(PUBLISH_POST_COPY_PY_PATH, verbose)) {
     return;
   }
 
@@ -292,11 +292,11 @@ function runReleaseScriptPostCopy(verbose: boolean) {
 
 function purgeRoomXMLs(modTargetPath: string, verbose: boolean) {
   const roomsPath = path.join(modTargetPath, "resources", "rooms");
-  if (!file.exists(roomsPath) || !file.isDir(roomsPath)) {
+  if (!file.exists(roomsPath, verbose) || !file.isDir(roomsPath, verbose)) {
     return;
   }
 
-  const roomFileList = file.getDirList(roomsPath);
+  const roomFileList = file.getDirList(roomsPath, verbose);
   roomFileList.forEach((fileName: string) => {
     if (path.extname(fileName) === ".xml") {
       const roomFilePath = path.join(roomsPath, fileName);
@@ -327,7 +327,7 @@ function runSteamCmd(
   steamCmdPath: string,
   verbose: boolean,
 ) {
-  if (!file.exists(steamCmdPath)) {
+  if (!file.exists(steamCmdPath, verbose)) {
     error(
       chalk.red(
         `The path provided for "steamCmdPath" is "${steamCmdPath}", but that does not exist.`,
@@ -336,7 +336,7 @@ function runSteamCmd(
   }
 
   const metadataVDFPath = path.join(modTargetPath, "metadata.vdf");
-  if (!file.exists(metadataVDFPath)) {
+  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:`,

package/src/configFile.ts

@@ -12,13 +12,13 @@ export async function get(argv: Record<string, unknown>): Promise<Config> {
   const verbose = argv.verbose === true;
   const yes = argv.yes === true;
 
-  const existingConfig = readExistingConfig();
+  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);
+  const modsDirectory = await getModsDir(argv, verbose);
   const saveSlot = await promptSaveSlot(argv, yes);
   const config = createObject(modsDirectory, saveSlot);
   createFile(CWD, config, verbose);
@@ -26,12 +26,12 @@ export async function get(argv: Record<string, unknown>): Promise<Config> {
   return config;
 }
 
-function readExistingConfig(): Config | undefined {
-  if (!file.exists(CONFIG_FILE_PATH)) {
+function readExistingConfig(verbose: boolean): Config | undefined {
+  if (!file.exists(CONFIG_FILE_PATH, verbose)) {
     return undefined;
   }
 
-  const configRaw = file.read(CONFIG_FILE_PATH);
+  const configRaw = file.read(CONFIG_FILE_PATH, verbose);
   let config: Config;
   try {
     config = JSONC.parse(configRaw) as Config;

package/src/exec.ts

@@ -3,7 +3,7 @@ import { execSync, spawnSync, SpawnSyncReturns } from "child_process";
 import { CWD } from "./constants";
 import { error } from "./utils";
 
-export function execExe(path: string, verbose = false, cwd = CWD): string {
+export function execExe(path: string, verbose: boolean, cwd = CWD): string {
   if (verbose) {
     console.log(`Executing binary: ${path}`);
   }
@@ -103,9 +103,7 @@ export function execShell(
 
   const exitStatus = spawnSyncReturns.status;
   if (exitStatus === null) {
-    error(
-      `Failed to get the return status of th command: ${commandDescription}`,
-    );
+    error(`Failed to get the return status of command: ${commandDescription}`);
   }
 
   const stdout = spawnSyncReturns.output.join("\n").trim();

package/src/file.ts

@@ -51,7 +51,11 @@ export function deleteFileOrDirectory(
   }
 }
 
-export function exists(filePath: string): boolean {
+export function exists(filePath: string, verbose: boolean): boolean {
+  if (verbose) {
+    console.log(`Checking to see if the following path exists: ${filePath}`);
+  }
+
   let pathExists: boolean;
   try {
     pathExists = fs.existsSync(filePath);
@@ -59,10 +63,18 @@ export function exists(filePath: string): boolean {
     error(`Failed to check to see if "${chalk.green(filePath)}" exists:`, err);
   }
 
+  if (verbose) {
+    console.log(`Path exists: ${pathExists}`);
+  }
+
   return pathExists;
 }
 
-export function getDirList(dirPath: string): string[] {
+export function getDirList(dirPath: string, verbose: boolean): string[] {
+  if (verbose) {
+    console.log(`Getting a directory list from: ${dirPath}`);
+  }
+
   let fileList: string[];
   try {
     fileList = fs.readdirSync(dirPath);
@@ -73,10 +85,18 @@ export function getDirList(dirPath: string): string[] {
     );
   }
 
+  if (verbose) {
+    console.log(`Got a directory list from: ${dirPath}`);
+  }
+
   return fileList;
 }
 
-function getFileStats(filePath: string): fs.Stats {
+function getFileStats(filePath: string, verbose: boolean): fs.Stats {
+  if (verbose) {
+    console.log(`Getting file stats from: ${filePath}`);
+  }
+
   let fileStats: fs.Stats;
   try {
     fileStats = fs.statSync(filePath);
@@ -84,11 +104,15 @@ function getFileStats(filePath: string): fs.Stats {
     error(`Failed to get the file stats for "${chalk.green(filePath)}":`, err);
   }
 
+  if (verbose) {
+    console.log(`Got file stats from: ${filePath}`);
+  }
+
   return fileStats;
 }
 
-export function isDir(filePath: string): boolean {
-  const fileStats = getFileStats(filePath);
+export function isDir(filePath: string, verbose: boolean): boolean {
+  const fileStats = getFileStats(filePath, verbose);
   return fileStats.isDirectory();
 }
 
@@ -117,7 +141,11 @@ export function makeDir(dirPath: string, verbose: boolean): void {
   }
 }
 
-export function read(filePath: string): string {
+export function read(filePath: string, verbose: boolean): string {
+  if (verbose) {
+    console.log(`Reading a file: ${filePath}`);
+  }
+
   let fileContents: string;
   try {
     fileContents = fs.readFileSync(filePath, "utf8");
@@ -125,6 +153,10 @@ export function read(filePath: string): string {
     error(`Failed to read the "${chalk.green(filePath)}" file:`, err);
   }
 
+  if (verbose) {
+    console.log(`Read a file: ${filePath}`);
+  }
+
   return fileContents;
 }
 
@@ -161,6 +193,18 @@ export function write(filePath: string, data: string, verbose: boolean): void {
   }
 }
 
-export function writeTry(filePath: string, data: string): void {
+export function writeTry(
+  filePath: string,
+  data: string,
+  verbose: boolean,
+): void {
+  if (verbose) {
+    console.log(`Writing data to: ${filePath}`);
+  }
+
   fs.writeFileSync(filePath, data);
+
+  if (verbose) {
+    console.log(`Wrote data to: ${filePath}`);
+  }
 }

package/src/main.ts

@@ -36,6 +36,7 @@ async function main(): Promise<void> {
 
   // Get command line arguments
   const argv = parseArgs();
+  const verbose = argv.verbose === true;
 
   printBanner();
 
@@ -43,9 +44,9 @@ async function main(): Promise<void> {
   updateNotifier({ pkg }).notify();
 
   // Pre-flight checks
-  await checkForWindowsTerminalBugs();
+  await checkForWindowsTerminalBugs(verbose);
 
-  await handleCommands(argv);
+  await handleCommands(argv, verbose);
 }
 
 function loadEnvironmentVariables() {
@@ -62,7 +63,7 @@ function printBanner() {
   console.log();
 }
 
-async function handleCommands(argv: Record<string, unknown>) {
+async function handleCommands(argv: Record<string, unknown>, verbose: boolean) {
   const positionalArgs = argv._ as string[];
   let command: Command;
   if (positionalArgs.length > 0) {
@@ -73,7 +74,7 @@ async function handleCommands(argv: Record<string, unknown>) {
 
   let config = new Config();
   if (command !== "init") {
-    validateInIsaacScriptProject();
+    validateInIsaacScriptProject(verbose);
     config = await configFile.get(argv);
   }
 

package/src/utils.ts

@@ -2,6 +2,10 @@ import moment from "moment";
 import { CURRENT_DIRECTORY_NAME } from "./constants";
 import { Config } from "./types/Config";
 
+/** From: https://github.com/expandjs/expandjs/blob/master/lib/kebabCaseRegex.js */
+const KEBAB_CASE_REGEX =
+  /^([a-z](?![\d])|[\d](?![a-z]))+(-?([a-z](?![\d])|[\d](?![a-z])))*$|^$/;
+
 export const ensureAllCases = (obj: never): never => obj;
 
 export function error(...args: unknown[]): never {
@@ -24,6 +28,10 @@ export function hasWhiteSpace(s: string): boolean {
   return /\s/g.test(s);
 }
 
+export function isKebabCase(s: string): boolean {
+  return KEBAB_CASE_REGEX.test(s);
+}
+
 /**
  * parseIntSafe is a more reliable version of parseInt. By default, "parseInt('1a')" will return
  * "1", which is unexpected. This returns either an integer or NaN.

package/src/validateInIsaacScriptProject.ts

@@ -4,11 +4,14 @@ import { CWD, PROJECT_NAME } from "./constants";
 import * as file from "./file";
 
 // Validate that we are in a directory that looks like an IsaacScript project
-export function validateInIsaacScriptProject(): void {
+export function validateInIsaacScriptProject(verbose: boolean): void {
   const subdirectoriesToCheck = ["src", "mod", "node_modules"];
   for (const subdirectoryName of subdirectoriesToCheck) {
     const subdirectoryPath = path.join(CWD, subdirectoryName);
-    if (!file.exists(subdirectoryPath) || !file.isDir(subdirectoryPath)) {
+    if (
+      !file.exists(subdirectoryPath, verbose) ||
+      !file.isDir(subdirectoryPath, verbose)
+    ) {
       errorNotExists(subdirectoryPath);
     }
   }