isaacscript 3.18.3 → 3.18.5

package/dist/commands/init/createProject.js

@@ -1,5 +1,5 @@
 import chalk from "chalk";
-import { PACKAGE_JSON, PackageManager, copyFileOrDirectory, getFileNamesInDirectory, getPackageManagerExecCommand, getPackageManagerInstallCICommand, getPackageManagerInstallCommand, getPackageManagerLockFileName, isFile, makeDirectory, readFile, renameFile, updatePackageJSON, writeFile, } from "isaacscript-common-node";
+import { PACKAGE_JSON, PackageManager, copyFileOrDirectory, deleteFileOrDirectory, getFileNamesInDirectory, getPackageManagerExecCommand, getPackageManagerInstallCICommand, getPackageManagerInstallCommand, getPackageManagerLockFileName, isFile, makeDirectory, readFile, renameFile, updatePackageJSON, writeFile, } from "isaacscript-common-node";
 import { removeLinesBetweenMarkers, removeLinesMatching, repeat, } from "isaacscript-common-ts";
 import path from "node:path";
 import { Config } from "../../classes/Config.js";
@@ -123,7 +123,10 @@ function copyDynamicFiles(projectName, authorName, projectPath, packageManager,
         const template = readFile(templatePath);
         // "PROJECT-NAME" must be hyphenated, as using an underscore will break Prettier for some
         // reason.
-        const readmeMD = template.replaceAll("PROJECT-NAME", projectName);
+        const command = getPackageManagerInstallCICommand(packageManager);
+        const readmeMD = template
+            .replaceAll("PROJECT-NAME", projectName)
+            .replaceAll("PACKAGE-MANAGER-INSTALL-COMMAND", command);
         const destinationPath = path.join(projectPath, README_MD);
         writeFile(destinationPath, readmeMD);
     }
@@ -178,13 +181,28 @@ function upgradeYarn(projectPath, packageManager, verbose) {
     if (packageManager !== PackageManager.yarn) {
         return;
     }
-    execShell("yarn", ["set", "version", "latest"], verbose, false, projectPath);
+    // This command will do two things:
+    // - It creates `./.yarn/releases/yarn-#.#.#.cjs`.
+    // - It creates the following string in the "package.json" file: `"packageManager": "yarn@#.#.#"`
+    //   Having the "yarn-#.#.#.cjs" file inside of the repository is now discouraged in Yarn 4+, so
+    //   we can safely delete this directory.
+    execShellString("yarn set version latest", verbose, false, projectPath);
+    const yarnDirectoryPath = path.join(projectPath, ".yarn");
+    deleteFileOrDirectory(yarnDirectoryPath);
+    // - The ".yarnrc.yml" file will now look like this: `yarnPath: .yarn/releases/yarn-4.0.1.cjs`
+    // - As mentioned above, we do not need the "yarnPath" setting if the "yarn-#.#.#.cjs" file is not
+    //   inside of the repository, so we need to delete it.
+    // - Additionally, since there is not a setting specified for "nodeLinker", it will use `pnp`,
+    //   which is not desired:
     // https://yarnpkg.com/features/linkers
-    // - `pnp` is the default, but it requires a VSCode extension.
-    // - `pnpm` is fast, but it does not work with a D drive:
+    //   - `pnp` is the default, but it requires a VSCode extension.
+    //   - `pnpm` is fast, but it does not work with a D drive:
     // https://github.com/yarnpkg/berry/issues/5326
-    // - Thus, we use `node-modules`.
-    execShell("yarn", ["config", "set", "nodeLinker", "node-modules"], verbose, false, projectPath);
+    // - Thus, we use `node-modules`, which can be set with: `yarn config set nodeLinker node-modules`
+    // - However, in order to fix both of these at the same time, we just overwrite the file, which is
+    //   simpler than running commands or manually editing the file.
+    const yarnConfigPath = path.join(projectPath, ".yarnrc.yml");
+    writeFile(yarnConfigPath, "nodeLinker: node-modules\n");
 }
 function installNodeModules(projectPath, skipInstall, packageManager, verbose) {
     if (skipInstall) {

package/file-templates/dynamic/README.mod.md

@@ -18,6 +18,7 @@ If you are a developer, or if the mod is not yet uploaded to the Steam Workshop,
 - Unzip the zip file to a new directory.
 - Open the command prompt (or another shell of your choice).
 - Use the `cd` command to navigate to the place where you unzipped the repository.
-- Use the `npm run start` command to start the IsaacScript watcher.
+- Use the `PACKAGE-MANAGER-INSTALL-COMMAND` command to install the project dependencies.
+- Use the `npx isaacscript` command to start the IsaacScript watcher.
 - If IsaacScript is successful, you will see "Compilation successful." (You can continue to leave the terminal window open; it will monitor for changes in your project, and recompile if necessary.)
 - Completely close Isaac if it is already open, and then open the game again, and the mod should be in the list of mods. You can now play or test the mod.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript",
-  "version": "3.18.3",
+  "version": "3.18.5",
   "description": "A command line tool for managing Isaac mods written in TypeScript.",
   "keywords": [
     "isaac",