isaacscript 1.2.45 → 2.0.2

package/file-templates/static-alt/.cspell-check-unused-base.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+  "version": "0.2",
+  "import": ["./.cspell-base.json"],
+  "files": ["**"],
+  "ignorePaths": [".cspell-temp.json", ".git/**", "dist/**", "node_modules/**"]
+}

package/file-templates/static-alt/.prettierignore-base

@@ -0,0 +1,5 @@
+# Ignore compiled output.
+dist
+
+# The VSCode CSpell plugin causes the file to become unformatted whenever a new word is added.
+.cspell.json

package/file-templates/static-alt/.prettierrc-base.js

@@ -0,0 +1,29 @@
+// This is the configuration file for Prettier, the auto-formatter:
+// https://prettier.io/docs/en/configuration.html
+module.exports = {
+  // https://prettier.io/docs/en/options.html#trailing-commas
+  // The default is "es5" - Trailing commas where valid in ES5 (objects, arrays, etc.)
+  // However, always having trailing commas is objectively better. The Airbnb style guide agrees:
+  // https://github.com/airbnb/javascript#commas--dangling
+  // Prettier itself also acknowledges Nik Graf's blog in their official blog:
+  // https://prettier.io/blog/2020/03/21/2.0.0.html
+  // https://medium.com/@nikgraf/why-you-should-enforce-dangling-commas-for-multiline-statements-d034c98e36f8
+  // Prettier will change the default in the future:
+  // https://github.com/prettier/prettier/issues/9369
+  trailingComma: "all",
+
+  // We want to always use "lf" to be consistent with all platforms.
+  endOfLine: "lf",
+
+  // Allow proper formatting of JSONC files:
+  // https://github.com/prettier/prettier/issues/5708
+  overrides: [
+    {
+      files: ["**/.vscode/*.json", "**/tsconfig.json", "**/tsconfig.*.json"],
+      options: {
+        parser: "json5",
+        quoteProps: "preserve",
+      },
+    },
+  ],
+};

package/file-templates/static-alt/.vscode/extensions-typescript.json

@@ -0,0 +1,9 @@
+// These are Visual Studio Code extensions that are intended to be used with this particular
+// repository: https://go.microsoft.com/fwlink/?LinkId=827846
+{
+  "recommendations": [
+    "esbenp.prettier-vscode", // The TypeScript formatter
+    "dbaeumer.vscode-eslint", // The TypeScript linter
+    "streetsidesoftware.code-spell-checker", // A spell-checker extension based on cspell
+  ],
+}

package/file-templates/static-alt/.vscode/settings-typescript.json

@@ -0,0 +1,63 @@
+// These are Visual Studio Code settings that should apply to this particular repository.
+{
+  // ----------------
+  // Vanilla settings
+  // ----------------
+
+  // This matches the Airbnb JavaScript style guide.
+  "editor.rulers": [100],
+  "editor.tabSize": 2,
+
+  // We want to always use "lf" to be consistent with all platforms.
+  "files.eol": "\n",
+
+  // Automatically removing all trailing whitespace when saving a file.
+  "files.trimTrailingWhitespace": true,
+
+  // Configure glob patterns for excluding files and folders in full text searches and quick open.
+  "search.exclude": {
+    "dist/**": true,
+  },
+
+  // -----------------
+  // Language settings
+  // -----------------
+
+  // By default, VSCode will not automatically fill-in function arguments.
+  "javascript.suggest.completeFunctionCalls": true,
+  "typescript.suggest.completeFunctionCalls": true,
+
+  // Automatically run the formatter when certain files are saved.
+  "[javascript]": {
+    "editor.codeActionsOnSave": ["source.fixAll.eslint"],
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+  "[typescript]": {
+    "editor.codeActionsOnSave": ["source.fixAll.eslint"],
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+  "[yaml]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+}

package/isaacscript-watcher/README.md

@@ -3,5 +3,6 @@
 `isaacscript-watcher` is a Lua mod that listens for messages from `IsaacScript`.
 
 It can:
-* print messages to the screen
-* execute console commands
+
+- print messages to the screen
+- execute console commands

package/isaacscript-watcher/main.lua

@@ -1,9 +1,6 @@
 -- Includes
 local json = require("json")
 
--- Register the mod
-local IsaacScriptWatcher = RegisterMod("IsaacScript Watcher", 1)
-
 -- Constants
 local MOD_NAME = "isaacscript-watcher"
 local RESTART_GAME_ON_RECOMPILATION = true
@@ -13,19 +10,21 @@ local SPRITE_BOTTOM_RIGHT_OFFSET = Vector(-35, -60)
 -- (enough so that it does not overlap with a pocket active + 2 pocket items)
 
 -- Mod variables
-local saveData = {} -- An array of message objects
+local saveData = {} -- An array of message objects.
 local restartFrame = 0
 local messageArray = {}
 local frameOfLastMsg = 0
 local frameOfLastSuccessfulLoad = 0
 local game = Game()
 local font = Font()
-font:Load("font/pftempestasevencondensed.fnt") -- A vanilla font good for this kind of text
+font:Load("font/pftempestasevencondensed.fnt") -- A vanilla font good for this kind of text.
 local connected = false
 local sprite = nil
 
+local IsaacScriptWatcher = RegisterMod("IsaacScript Watcher", 1)
+
 -- On mod initialization, nuke the "save#.dat" folder to get rid of old messages that might be left
--- there from IsaacScript
+-- there from IsaacScript.
 IsaacScriptWatcher:SaveData("")
 
 local function pushMessageArray(msg)
@@ -33,15 +32,21 @@ local function pushMessageArray(msg)
 
   messageArray[#messageArray + 1] = msg
   if #messageArray > 10 then
-    -- We only want to show 10 messages at a time
-    -- Remove the first elemenent
+    -- We only want to show 10 messages at a time.
     table.remove(messageArray, 1)
   end
 end
 
+local function getScreenBottomRightPos()
+  local screenWidth = Isaac.GetScreenWidth();
+  local screenHeight = Isaac.GetScreenHeight();
+
+  return Vector(screenWidth, screenHeight)
+end
+
 -- ModCallbacks.MC_POST_RENDER (2)
 function IsaacScriptWatcher:PostRender()
-  -- Don't do anything while the gade is fading in to prevent crashes
+  -- Don't do anything while fading in to a new run to prevent crashes.
   if game:GetFrameCount() < 1 then
     return
   end
@@ -54,7 +59,7 @@ function IsaacScriptWatcher:PostRender()
 end
 
 function IsaacScriptWatcher:RenderSprite()
-  -- Determine if IsaacScript is connected or not
+  -- Determine if IsaacScript is connected or not.
   local frameCount = Isaac.GetFrameCount()
   connected = frameCount - frameOfLastSuccessfulLoad <= FRAMES_BEFORE_DISCONNECTED
 
@@ -73,13 +78,14 @@ function IsaacScriptWatcher:RenderSprite()
 
   -- Render it
   if sprite ~= nil then
-    local position = IsaacScriptWatcher:GetBottomRightCorner() + SPRITE_BOTTOM_RIGHT_OFFSET
+    local bottomRightPos = getScreenBottomRightPos()
+    local position = bottomRightPos + SPRITE_BOTTOM_RIGHT_OFFSET
     sprite:RenderLayer(0, position)
   end
 end
 
 function IsaacScriptWatcher:RenderText()
-  -- Don't draw IsaacScript text when custom consoles are open
+  -- Don't draw IsaacScript text when custom consoles are open.
   if AwaitingTextInput then
     return
   end
@@ -104,7 +110,7 @@ function IsaacScriptWatcher:RenderText()
   local scale = 1
   local lineHeight = font:GetLineHeight() * scale
 
-  -- The text will slowly fade out
+  -- The text will slowly fade out.
   local elapsedFrames = Isaac.GetFrameCount() - frameOfLastMsg
   local alpha
   if elapsedFrames <= FRAMES_BEFORE_TEXT_FADE then
@@ -122,7 +128,7 @@ function IsaacScriptWatcher:RenderText()
   local red = KColor(1, 0, 0, alpha)
   local green = KColor(0, 1, 0, alpha)
 
-  -- Go through each message
+  -- Go through each message.
   for i, msg in ipairs(messageArray) do
     local color = white
 
@@ -153,21 +159,21 @@ function IsaacScriptWatcher:LoadSaveDat()
   -- Local variables
   local isaacFrameCount = Isaac.GetFrameCount()
 
-  -- Read the "save.dat" file every third second, since file reads are expensive
+  -- Read the "save.dat" file every third second, since file reads are expensive.
   if isaacFrameCount % 20 ~= 0 then
     return
   end
 
-  -- Check to see if there a "save.dat" file for this save slot
+  -- Check to see if there a "save.dat" file for this save slot.
   if not Isaac.HasModData(IsaacScriptWatcher) then
     IsaacScriptWatcher:ClearSaveDat()
     return
   end
 
-  -- The server will write JSON data for us to the "save#.dat" file in the mod subdirectory
+  -- The server will write JSON data for us to the "save#.dat" file in the mod subdirectory.
   if not pcall(IsaacScriptWatcher.Load) then
-    -- Sometimes loading can fail if the file is currently being being written to,
-    -- so give up for now and try again on the next interval
+    -- Sometimes loading can fail if the file is currently being being written to, so give up for
+    -- now and try again on the next interval.
     Isaac.DebugString(
       MOD_NAME
       .. " - Failed to load the TypeScript Watcher \"save.dat\" on frame: "
@@ -190,7 +196,7 @@ function IsaacScriptWatcher:LoadSuccessful(saveDatContents)
     -- Entry is e.g. { type: "command", data: "luamod revelations" }
     if entry.type == "command" then
       if entry.data == "restart" then
-        -- If we restart on the first frame that a run is loading, then the game can crash
+        -- If we restart on the first frame that a run is loading, then the game can crash.
         restartFrame = Isaac.GetFrameCount() + 1
       else
         Isaac.DebugString(MOD_NAME .. " - Executing command: " .. entry.data)
@@ -214,15 +220,15 @@ function IsaacScriptWatcher:Save()
 end
 
 function IsaacScriptWatcher:Load()
-  -- Read the "save#.dat" file into a string
+  -- Read the "save#.dat" file into a string.
   local saveDataJSON = Isaac.LoadModData(IsaacScriptWatcher)
 
-  -- Handle the case of a 0 byte file
+  -- Handle the case of a 0 byte file.
   if saveDataJSON == "" then
     saveDataJSON = "{}"
   end
 
-  -- Convert a JSON string to a Lua table
+  -- Convert a JSON string to a Lua table.
   saveData = json.decode(saveDataJSON)
 end
 
@@ -232,12 +238,12 @@ function IsaacScriptWatcher:CheckInput()
   end
 
   -- Ensure that this feature does not overlap with custom consoles by checking for the
-  -- "AwaitingTextInput" global variable
+  -- "AwaitingTextInput" global variable.
   if AwaitingTextInput then
     return
   end
 
-  -- Manually show the log when the user presses the "I" key on the keyboard
+  -- Manually show the log when the user presses the "I" key on the keyboard.
   if Input.IsButtonPressed(Keyboard.KEY_I, 0) then
     frameOfLastMsg = Isaac.GetFrameCount()
   end
@@ -257,22 +263,6 @@ function IsaacScriptWatcher:CheckRestart()
   Isaac.ExecuteCommand("restart")
 end
 
--- Kilburn's function (pinned in the Isaac Discord server)
--- (originally called "GetScreenSize()")
-function IsaacScriptWatcher:GetBottomRightCorner()
-  local room = game:GetRoom()
-  local pos = (
-    room:WorldToScreenPosition(Vector.Zero)
-    - room:GetRenderScrollOffset()
-    - Game().ScreenShakeOffset
-  )
-
-  local rx = pos.X + 60 * 26 / 40
-  local ry = pos.Y + 140 * (26 / 40)
-
-  return Vector(rx * 2 + 13 * 26, ry * 2 + 7 * 26)
-end
-
 IsaacScriptWatcher:AddCallback(ModCallbacks.MC_POST_RENDER, IsaacScriptWatcher.PostRender)
 
 local initMessage = "IsaacScript Watcher initialized."

package/lint.sh

@@ -2,7 +2,7 @@
 
 set -e # Exit on any errors
 
-# Get the directory of this script
+# 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 )"
 
@@ -10,26 +10,29 @@ SECONDS=0
 
 cd "$DIR"
 
-# Step 1 - Use Prettier to check formatting
-npx prettier --check "src/**/*.ts"
+# Step 1 - Use Prettier to check formatting.
+npx prettier --check .
 
-# Step 2 - Use ESLint to lint the TypeScript
-# Since all ESLint errors are set to warnings,
-# we set max warnings to 0 so that warnings will fail in CI
+# Step 2 - Use ESLint to lint the TypeScript.
+# Since all ESLint errors are set to warnings, we set max warnings to 0 so that warnings will fail
+# in CI.
 npx eslint --max-warnings 0 src
 
-# Step 3 - Spell check every file using cspell
-# We use no-progress and no-summary because we want to only output errors
-npx cspell --no-progress --no-summary "src/**/*.ts"
+# Step 3 - Spell check every file using cspell.
+# We use "--no-progress" and "--no-summary" because we want to only output errors.
+npx cspell --no-progress --no-summary
 
-# Step 4 - Check for unused imports
-# The "--error" flag makes it return an error code of 1 if unused exports are found
+# Step 4 - Check for unused imports.
+# The "--error" flag makes it return an error code of 1 if unused exports are found.
 npx ts-prune --error
 
-# Step 5 - Check for gitignore updates from GitHub
-tail -n +6 .gitignore > gitignore-template-local
-curl https://raw.githubusercontent.com/github/gitignore/master/Node.gitignore --output gitignore-template-github --silent
-diff gitignore-template-local gitignore-template-github
-rm -f gitignore-template-local gitignore-template-github
+# Step 5 - Check for base file updates.
+bash "$DIR/check-file-updates.sh"
+
+# Step 6 - Check for orphaned words.
+bash "$DIR/check-orphaned-words.sh"
+
+# Step 7 - Check for gitignore updates from GitHub.
+bash "$DIR/check-gitignore.sh"
 
 echo "Successfully linted in $SECONDS seconds."

package/nuke.sh

@@ -2,7 +2,7 @@
 
 set -e # Exit on any errors
 
-# Get the directory of this script
+# 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 )"
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript",
-  "version": "1.2.45",
+  "version": "2.0.2",
   "description": "A command line tool for managing Isaac mods written in TypeScript",
   "homepage": "https://isaacscript.github.io/",
   "bugs": {
@@ -16,13 +16,13 @@
     "isaacscript": "./dist/src/main.js"
   },
   "dependencies": {
-    "@types/node": "^17.0.32",
+    "@types/node": "^17.0.33",
     "chalk": "4.1.2",
     "command-exists": "^1.2.9",
     "dotenv": "^16.0.1",
     "figlet": "^1.5.2",
     "fs-extra": "^10.1.0",
-    "isaacscript-tsconfig": "^1.1.14",
+    "isaacscript-tsconfig": "^1.1.16",
     "jsonc-parser": "^3.0.0",
     "moment": "^2.29.3",
     "npm-check-updates": "^12.5.11",
@@ -34,8 +34,8 @@
     "typescript": "^4.6.4",
     "typescript-to-lua": "^1.4.4",
     "update-notifier": "^5.1.0",
-    "yaml": "^2.0.1",
-    "yargs": "^17.4.1"
+    "yaml": "^2.1.0",
+    "yargs": "^17.5.0"
   },
   "devDependencies": {
     "@types/command-exists": "^1.2.0",
@@ -45,6 +45,6 @@
     "@types/source-map-support": "^0.5.4",
     "@types/update-notifier": "^5.1.0",
     "@types/yargs": "^17.0.10",
-    "isaacscript-lint": "^1.0.120"
+    "isaacscript-lint": "^1.0.140"
   }
 }

package/publish.sh

@@ -2,7 +2,7 @@
 
 set -e # Exit on any errors
 
-# Get the directory of this script
+# 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 )"
 

package/src/checkForWindowsTerminalBugs.ts

@@ -8,9 +8,10 @@ import { error } from "./utils";
 
 const BASH_PROFILE_PATH = path.join(HOME_DIR, ".bash_profile");
 
-// By default, Git Bash for Windows uses MINGW64
-// This will not work correctly with the prompt library
-// Try to detect this and warn the end-user
+/**
+ * By default, Git Bash for Windows uses MINGW64. This will not work correctly with the prompt
+ * library. Try to detect this and warn the end-user.
+ */
 export async function checkForWindowsTerminalBugs(
   verbose: boolean,
 ): Promise<void> {
@@ -52,7 +53,7 @@ async function checkForWindowsBugColor(verbose: boolean) {
 }
 
 function applyFixesToBashProfile(verbose: boolean) {
-  // Check to see if the Bash profile has data
+  // Check to see if the Bash profile has data.
   let bashProfileContents: string;
   if (file.exists(BASH_PROFILE_PATH, verbose)) {
     bashProfileContents = file.read(BASH_PROFILE_PATH, verbose);
@@ -87,14 +88,14 @@ function getBashProfileAppendText(bashProfileContents: string) {
     bashProfileContents !== "" &&
     bashProfileContents[bashProfileContents.length - 1] !== "\n"
   ) {
-    // If the Bash profile exists and has data, it should end in a newline
-    // Add an extra newline if this is not the case
+    // If the Bash profile exists and has data, it should end in a newline. Add an extra newline if
+    // this is not the case.
     newText += "\n";
   }
 
   if (bashProfileContents !== "") {
     // If the Bash profile exists and has data, add an extra newline between the existing stuff and
-    // the new lines added by us
+    // the new lines added by us.
     newText += "\n";
   }
 

package/src/commands/init/createMod.ts

@@ -52,7 +52,7 @@ export function createMod(
 }
 
 function makeSubdirectories(projectPath: string, verbose: boolean) {
-  // The "src" directory is created during copying of static files
+  // The "src" directory is created during copying of static files.
   for (const subdirectory of ["mod"]) {
     const srcPath = path.join(projectPath, subdirectory);
     file.makeDir(srcPath, verbose);
@@ -69,6 +69,12 @@ function copyStaticFiles(projectPath: string, verbose: boolean) {
       file.copy(templateFilePath, destinationFilePath, verbose);
     }
   });
+
+  // Rename ".cspell.json.template" to ".cspell.json.template". (If it is kept as ".cspell.json",
+  // then local spell checking will fail.)
+  const cSpellConfigPath = path.join(projectPath, ".cspell.json.template");
+  const correctCSpellConfigPath = path.join(projectPath, ".cspell.json");
+  file.rename(cSpellConfigPath, correctCSpellConfigPath, verbose);
 }
 
 /** Copy files that need to have text replaced inside of them. */
@@ -103,7 +109,7 @@ function copyDynamicFiles(
     const fileName = PACKAGE_JSON;
     const templatePath = PACKAGE_JSON_TEMPLATE_PATH;
     const template = file.read(templatePath, verbose);
-    const packageJSON = template.replace(/MOD_NAME_TO_REPLACE/g, projectName);
+    const packageJSON = template.replace(/MOD-NAME-TO-REPLACE/g, projectName);
     const destinationPath = path.join(projectPath, fileName);
     file.write(destinationPath, packageJSON, verbose);
   }
@@ -113,7 +119,7 @@ function copyDynamicFiles(
     const fileName = README_MD;
     const templatePath = README_MD_TEMPLATES_PATH;
     const template = file.read(templatePath, verbose);
-    const readmeMD = template.replace(/MOD_NAME_TO_REPLACE/g, projectName);
+    const readmeMD = template.replace(/MOD-NAME-TO-REPLACE/g, projectName);
     const destinationPath = path.join(projectPath, fileName);
     file.write(destinationPath, readmeMD, verbose);
   }
@@ -123,7 +129,7 @@ function copyDynamicFiles(
     const fileName = METADATA_XML;
     const templatePath = METADATA_XML_TEMPLATE_PATH;
     const template = file.read(templatePath, verbose);
-    const metadataXML = template.replace(/MOD_NAME_TO_REPLACE/g, projectName);
+    const metadataXML = template.replace(/MOD-NAME-TO-REPLACE/g, projectName);
     const modPath = path.join(projectPath, "mod");
     const destinationPath = path.join(modPath, fileName);
     file.write(destinationPath, metadataXML, verbose);
@@ -134,7 +140,7 @@ function copyDynamicFiles(
     const fileName = METADATA_VDF;
     const templatePath = METADATA_VDF_TEMPLATE_PATH;
     const template = file.read(templatePath, verbose);
-    const metadataVDF = template.replace(/MOD_TARGET_DIR/g, targetModDirectory);
+    const metadataVDF = template.replace(/MOD-TARGET-DIR/g, targetModDirectory);
     const modPath = path.join(projectPath, "mod");
     const destinationPath = path.join(modPath, fileName);
     file.write(destinationPath, metadataVDF, verbose);
@@ -142,13 +148,13 @@ function copyDynamicFiles(
 
   // "src/main.ts"
   {
-    // Convert snake_case and kebab-case to camelCase
-    // (kebab-case in particular will make the example TypeScript file fail to compile)
+    // Convert snake_case and kebab-case to camelCase. (Kebab-case in particular will make the
+    // example TypeScript file fail to compile.)
     const srcPath = path.join(projectPath, "src");
     const fileName = MAIN_TS;
     const templatePath = MAIN_TS_TEMPLATE_PATH;
     const template = file.read(templatePath, verbose);
-    const mainTS = template.replace(/MOD_NAME_TO_REPLACE/g, projectName);
+    const mainTS = template.replace(/MOD-NAME-TO-REPLACE/g, projectName);
     const destinationPath = path.join(srcPath, fileName);
     file.write(destinationPath, mainTS, verbose);
   }

package/src/commands/init/getModsDir.ts

@@ -17,7 +17,7 @@ const DEFAULT_MODS_PATH_WINDOWS = path.join(
   MODS,
 );
 
-// This is a subdirectory of $HOME
+/** This is a subdirectory of `$HOME`. */
 const DEFAULT_MODS_PATH_LINUX = path.join(
   HOME_DIR,
   ".local",
@@ -34,8 +34,8 @@ export async function getModsDir(
   verbose: boolean,
 ): Promise<string> {
   if (argv["modsDirectory"] !== undefined) {
-    // They specified the "--mods-directory" command-line flag,
-    // so there is no need to prompt the user for it
+    // They specified the "--mods-directory" command-line flag, so there is no need to prompt the
+    // user for it.
     return argv["modsDirectory"] as string;
   }
 
@@ -97,12 +97,11 @@ function getDefaultModsPath(platform: string) {
     }
 
     default: {
-      error(
+      return error(
         `There does not exist a default mod path for the platform of: ${chalk.green(
           platform,
         )}`,
       );
-      return "";
     }
   }
 }

package/src/commands/init/getProjectPath.ts

@@ -27,23 +27,23 @@ export async function getProjectPath(
   let projectPath: string;
   let createNewDir: boolean;
   if (useCurrentDir) {
-    // The "--use-current-dir" command-line flag was specified,
-    // so there is no need to prompt the user
+    // The "--use-current-dir" command-line flag was specified, so there is no need to prompt the
+    // user.
     projectName = CURRENT_DIRECTORY_NAME;
     projectPath = CWD;
     createNewDir = false;
   } else if (projectName !== undefined) {
-    // The project name was specified on the command-line
+    // The project name was specified on the command-line.
     projectPath = path.join(CWD, projectName);
     createNewDir = true;
   } else if (yes) {
     // The "--yes" command-line flag was specified and the project name was not specified on the
-    // command-line, so default to using the current directory
+    // command-line, so default to using the current directory.
     projectName = CURRENT_DIRECTORY_NAME;
     projectPath = CWD;
     createNewDir = false;
   } else {
-    // The project name was not specified on the command-line, so prompt the user for it
+    // The project name was not specified on the command-line, so prompt the user for it.
     [projectName, projectPath, createNewDir] = await getNewProjectName();
   }
 

package/src/commands/init/git.ts

@@ -61,7 +61,7 @@ export async function promptGitHubRepoOrGitRemoteURL(
       }
 
       // Assume that since they do not want to connect this project to the existing GitHub
-      // repository, they do not want to initialize a remote Git URL at all
+      // repository, they do not want to initialize a remote Git URL at all.
       return undefined;
     }
 
@@ -83,7 +83,7 @@ export async function promptGitHubRepoOrGitRemoteURL(
     }
 
     // Assume that since they do not want to create a new GitHub repository, they do not want to
-    // initialize a remote Git URL at all
+    // initialize a remote Git URL at all.
     return undefined;
   }
 

package/src/commands/init/promptSaveSlot.ts

@@ -6,10 +6,9 @@ export async function promptSaveSlot(
   yes: boolean,
 ): Promise<number> {
   if (argv["saveSlot"] !== undefined) {
-    // They specified the "--save-slot" command-line flag,
-    // so there is no need to prompt the user for it
-    // (yargs converts this to a number)
-    return argv["saveSlot"] as number;
+    // They specified the "--save-slot" command-line flag, so there is no need to prompt the user
+    // for it.
+    return argv["saveSlot"] as number; // yargs converts this to a number
   }
 
   if (yes) {

package/src/commands/init/promptVSCode.ts

@@ -10,8 +10,7 @@ export async function promptVSCode(
   verbose: boolean,
 ): Promise<void> {
   if (vscode) {
-    // They supplied the "--vscode" command-line flag,
-    // so there is no need to prompt the user
+    // They supplied the "--vscode" command-line flag, so there is no need to prompt the user.
     openVSCode(projectPath, VSCodeCommand, verbose);
     return;
   }