isaacscript 1.2.28 → 1.2.31

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/parseArgs.ts

@@ -32,6 +32,12 @@ export function parseArgs(): Record<string, unknown> {
       `Initialize a new ${PROJECT_NAME} mod.`,
       (builder) =>
         builder
+          .option("yes", {
+            alias: "y",
+            type: "boolean",
+            description:
+              'Answer yes to every dialog option, similar to how "npm init --yes" works.',
+          })
           .option("use-current-dir", {
             alias: "u",
             type: "boolean",

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);
     }
   }