isaacscript 2.0.4 → 2.0.7

package/src/prompt.ts

@@ -1,109 +0,0 @@
-// Both the Inquirer.js library and the Prompts library have a bug where text is duplicated in a Git
-// Bash terminal. Thus, we revert to using the simpler Prompt library.
-
-import chalk from "chalk";
-import prompt from "prompt";
-import { error, parseIntSafe } from "./utils";
-
-const VALID_YES_RESPONSES = new Set(["yes", "ye", "y"]);
-const VALID_NO_RESPONSES = new Set(["no", "n"]);
-
-export function promptInit(): void {
-  // Override some of the prompt library's default values:
-  // https://github.com/flatiron/prompt#customizing-your-prompt
-  prompt.message = chalk.green("?");
-  prompt.delimiter = " ";
-  prompt.colors = false;
-}
-
-export async function getInputYesNo(
-  msg: string,
-  defaultValue = true,
-): Promise<boolean> {
-  prompt.start();
-
-  // Capitalize the letter that represents the default option.
-  const y = defaultValue ? "Y" : "y";
-  const n = defaultValue ? "n" : "N";
-
-  const questionSuffix = `(${y}\\${n})`;
-  const description = `${chalk.bold(msg)} ${chalk.gray(questionSuffix)}`;
-
-  const { response } = await prompt.get({
-    properties: {
-      response: {
-        type: "string",
-        description,
-      },
-    },
-  });
-
-  if (typeof response !== "string") {
-    console.log(typeof response);
-    error("Failed to get a proper response from the prompt library.");
-  }
-
-  const cleanedResponse = response.toLowerCase().trim();
-
-  // Default to true.
-  if (cleanedResponse === "") {
-    return defaultValue;
-  }
-
-  if (VALID_YES_RESPONSES.has(cleanedResponse)) {
-    return true;
-  }
-
-  if (VALID_NO_RESPONSES.has(cleanedResponse)) {
-    return false;
-  }
-
-  return error('Invalid response; must answer "yes" or "no".');
-}
-
-/** Returns trimmed input. */
-export async function getInputString(
-  msg: string,
-  defaultValue?: string,
-): Promise<string> {
-  prompt.start();
-
-  let description = `${chalk.bold(msg)}`;
-  if (defaultValue !== undefined) {
-    description += ` ${chalk.gray(`(${defaultValue})`)}`;
-  }
-
-  const { response } = await prompt.get({
-    properties: {
-      response: {
-        type: "string",
-        description,
-      },
-    },
-  });
-
-  if (typeof response !== "string") {
-    error("Failed to get a proper response from the prompt library.");
-  }
-
-  if (response === "" && defaultValue !== undefined) {
-    return defaultValue;
-  }
-
-  return response.trim();
-}
-
-export async function getInputInt(
-  msg: string,
-  defaultValue = 1,
-): Promise<number> {
-  const defaultValueString = defaultValue.toString();
-  const string = await getInputString(msg, defaultValueString);
-  const int = parseIntSafe(string);
-
-  if (Number.isNaN(int)) {
-    error("Error: You must enter an integer.");
-  }
-
-  return int;
-}

package/src/types/Command.ts

@@ -1,3 +0,0 @@
-export type Command = "monitor" | "init" | "copy" | "publish";
-
-export const DEFAULT_COMMAND = "monitor";

package/src/types/Config.ts

@@ -1,23 +0,0 @@
-export class Config {
-  /** The "mods" directory that lives next to the "isaac-ng.exe" program. */
-  modsDirectory =
-    "C:\\Program Files (x86)\\Steam\\steamapps\\common\\The Binding of Isaac Rebirth\\mods";
-
-  /** The save slot that you test your mod on. */
-  saveSlot = 1;
-
-  /**
-   * By default, the target mod directory name will be the same as the project directory name. This
-   * setting allows you to customize it.
-   */
-  customTargetModDirectoryName?: string;
-
-  /** The path to "steamcmd.exe". This is optional and only needed for automating publishing. */
-  steamCmdPath?: string;
-
-  /**
-   * When your code is recompiled, IsaacScript watcher can restart the game to ensure that any
-   * run-related variables are properly reset. This is set to true by default.
-   */
-  enableIsaacScriptWatcherAutoRestart?: boolean;
-}

package/src/types/GitHubCLIHostsYAML.ts

@@ -1,7 +0,0 @@
-export interface GitHubCLIHostsYAML {
-  "github.com": {
-    user: string;
-    oauth_token: string;
-    git_protocol: string;
-  };
-}

package/src/utils.ts

@@ -1,92 +0,0 @@
-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 {
-  console.error(...args);
-  process.exit(1);
-}
-
-export function getModTargetDirectoryName(config: Config): string {
-  return config.customTargetModDirectoryName === undefined
-    ? CURRENT_DIRECTORY_NAME
-    : config.customTargetModDirectoryName;
-}
-
-export function getTime(): string {
-  return moment().format("h:mm:ss A"); // e.g. "1:23:45 AM"
-}
-
-// From: https://stackoverflow.com/questions/1731190/check-if-a-string-has-white-space
-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.
- */
-export function parseIntSafe(input: unknown): number {
-  if (typeof input !== "string") {
-    return NaN;
-  }
-
-  // Remove all leading and trailing whitespace
-  let trimmedInput = input.trim();
-
-  const isNegativeNumber = trimmedInput.startsWith("-");
-  if (isNegativeNumber) {
-    // Remove the leading minus sign before we match the regular expression
-    trimmedInput = trimmedInput.substring(1);
-  }
-
-  if (/^\d+$/.exec(trimmedInput) === null) {
-    // "\d" matches any digit (same as "[0-9]")
-    return NaN;
-  }
-
-  if (isNegativeNumber) {
-    // Add the leading minus sign back
-    trimmedInput = `-${trimmedInput}`;
-  }
-
-  return parseInt(trimmedInput, 10);
-}
-
-export function parseSemVer(
-  versionString: string,
-): [majorVersion: number, minorVersion: number, patchVersion: number] {
-  const match = /^v*(\d+)\.(\d+)\.(\d+)/g.exec(versionString);
-  if (match === null) {
-    error(`Failed to parse the version string of: ${versionString}`);
-  }
-
-  const [, majorVersionString, minorVersionString, patchVersionString] = match;
-
-  const majorVersion = parseIntSafe(majorVersionString);
-  if (Number.isNaN(majorVersion)) {
-    error(`Failed to parse the major version number from: ${versionString}`);
-  }
-
-  const minorVersion = parseIntSafe(minorVersionString);
-  if (Number.isNaN(minorVersion)) {
-    error(`Failed to parse the minor version number from: ${versionString}`);
-  }
-
-  const patchVersion = parseIntSafe(patchVersionString);
-  if (Number.isNaN(patchVersion)) {
-    error(`Failed to parse the patch version number from: ${versionString}`);
-  }
-
-  return [majorVersion, minorVersion, patchVersion];
-}

package/src/validateInIsaacScriptProject.ts

@@ -1,35 +0,0 @@
-import chalk from "chalk";
-import path from "path";
-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(verbose: boolean): void {
-  const subdirectoriesToCheck = ["src", "mod", "node_modules"];
-  for (const subdirectoryName of subdirectoriesToCheck) {
-    const subdirectoryPath = path.join(CWD, subdirectoryName);
-    if (
-      !file.exists(subdirectoryPath, verbose) ||
-      !file.isDir(subdirectoryPath, verbose)
-    ) {
-      errorNotExists(subdirectoryPath);
-    }
-  }
-}
-
-function errorNotExists(dirName: string) {
-  console.error(
-    chalk.red(
-      `It looks like the current working directory is not an ${PROJECT_NAME} project. (There is no "${dirName}" subdirectory here.)`,
-    ),
-  );
-  console.error(
-    `Did you mean to create a new ${PROJECT_NAME} project with "${chalk.green(
-      "npx isaacscript init",
-    )}"?`,
-  );
-  console.error(
-    `If not, then change the current working directory to an ${PROJECT_NAME} project.`,
-  );
-  process.exit(1);
-}

package/src/validateNodeVersion.ts

@@ -1,29 +0,0 @@
-import chalk from "chalk";
-import { PROJECT_NAME } from "./constants";
-import { parseSemVer } from "./utils";
-
-const REQUIRED_NODE_JS_MAJOR_VERSION = 16;
-
-/**
- * This program requires Node to be at least v16.0.0, since that is the version that added the
- * "fs.rmSync" function. (Node v15.0.0 is confirmed to not work.)
- */
-export function validateNodeVersion(): void {
-  const { version } = process;
-
-  const [majorVersion] = parseSemVer(version);
-  if (majorVersion >= REQUIRED_NODE_JS_MAJOR_VERSION) {
-    return;
-  }
-
-  console.error(`Your Node.js version is: ${chalk.red(version)}`);
-  console.error(
-    `${PROJECT_NAME} requires a Node.js version of ${chalk.red(
-      `${REQUIRED_NODE_JS_MAJOR_VERSION}.0.0`,
-    )} or greater.`,
-  );
-  console.error(
-    `Please upgrade your version of Node.js before using ${PROJECT_NAME}.`,
-  );
-  process.exit(1);
-}

package/src/validateOS.ts

@@ -1,20 +0,0 @@
-import chalk from "chalk";
-import { PROJECT_NAME } from "./constants";
-
-const VALID_PLATFORMS = ["win32", "linux"];
-
-export function validateOS(): void {
-  if (VALID_PLATFORMS.includes(process.platform)) {
-    return;
-  }
-
-  console.error(
-    `${PROJECT_NAME} is only supported on ${chalk.green(
-      "Windows",
-    )} and ${chalk.green("Linux")}.`,
-  );
-  console.error(
-    `If you use another operating system and you want to use ${PROJECT_NAME}, make a request in the community Discord server.`,
-  );
-  process.exit(1);
-}

package/tsconfig.eslint.json

@@ -1,11 +0,0 @@
-// A special TypeScript configuration file, used by ESLint only.
-{
-  "extends": "./tsconfig.json",
-  "include": [
-    // This must match the "include" setting in the "tsconfig.json" file.
-    "./src/**/*.ts",
-
-    // These are ESLint-only inclusions.
-    "./.eslintrc.js",
-  ],
-}

package/tsconfig.json

@@ -1,21 +0,0 @@
-// The configuration file for TypeScript.
-{
-  // We extend the standard IsaacScript config:
-  // https://github.com/IsaacScript/isaacscript-tsconfig/blob/main/tsconfig.node.json
-  "extends": "isaacscript-tsconfig/tsconfig.node.json",
-
-  // https://www.typescriptlang.org/docs/handbook/compiler-options.html
-  "compilerOptions": {
-    // "outDir" specifies the output directory.
-    // By default, it will put the compiled ".js" next to the respective ".ts" file, which will
-    // clutter the "src" directory.
-    "outDir": "./dist",
-
-    // We need to import the "package.json" file to see what version we are running.
-    // By default, this is false.
-    "resolveJsonModule": true,
-  },
-
-  // A list of the TypeScript files to compile.
-  "include": ["./src/**/*.ts"],
-}

package/update.sh

@@ -1,21 +0,0 @@
-#!/bin/bash
-
-set -e # Exit on any errors
-
-# Get the directory of this script:
-# https://stackoverflow.com/questions/59895/getting-the-source-directory-of-a-bash-script-from-within
-DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
-
-cd "$DIR"
-
-PACKAGE_JSON="$DIR/package.json"
-OLD_HASH=$(md5sum "$PACKAGE_JSON")
-npx npm-check-updates --upgrade --packageFile "$PACKAGE_JSON" --reject chalk
-NEW_HASH=$(md5sum "$PACKAGE_JSON")
-if [[ $OLD_HASH != $NEW_HASH ]]; then
-  if test -f "$DIR/yarn.lock"; then
-    yarn
-  else
-    npm install
-  fi
-fi