isaacscript/dist/commands/init/init.js

A command line tool for managing Isaac mods written in TypeScript.

import { Command, InvalidOptionArgumentError, } from "@commander-js/extra-typings";
import chalk from "chalk";
import { parseIntSafe } from "complete-common";
import { getPackageManagerExecCommand } from "complete-node";
import path from "node:path";
import { printBanner } from "../../banner.js";
import { CWD, PROJECT_NAME } from "../../constants.js";
import { promptGitHubRepoOrGitRemoteURL } from "../../git.js";
import { getPackageManagerUsedForNewProject } from "../../packageManager.js";
import { checkIfProjectPathExists } from "./checkIfProjectPathExists.js";
import { checkModSubdirectory } from "./checkModSubdirectory.js";
import { checkModTargetDirectory } from "./checkModTargetDirectory.js";
import { createProject } from "./createProject.js";
import { getModsDirectory } from "./getModsDirectory.js";
import { getProjectPath } from "./getProjectPath.js";
import { getSaveSlot } from "./getSaveSlot.js";
import { vsCodeInit } from "./vsCode.js";
export const initCommand = new Command()
    .command("init [name]")
    .description(`Initialize a new ${PROJECT_NAME} mod.`)
    .allowExcessArguments(false) // By default, Commander.js will allow extra positional arguments.
    .helpOption("-h, --help", "Display the list of options for this command.")
    .option("-y, --yes", 'Answer yes to every dialog option, similar to how "npm init --yes" works.', false)
    .option("--use-current-directory", "Use the current directory as the root for the project.", false)
    .option("--custom-directory <directory>", "The directory to create the project in (instead of the current working directory).")
    .option("-m, --mods-directory <directory>", "The directory where Isaac mods live on your system.")
    .option("-s, --save-slot <slot>", "The in-game save slot that you use to test the mod.", validateSaveSlot, 1)
    .option("--vscode", "Open the project in VSCode after initialization.", false)
    .option("--npm", "Use npm as the package manager.", false)
    .option("--yarn", "Use Yarn as the package manager.", false)
    .option("--pnpm", "Use pnpm as the package manager.", false)
    .option("--skip-git", "Do not initialize Git.", false) // https://github.com/tj/commander.js/issues/2068
    .option("--skip-install", "Do not automatically install the dependencies after initializing the project.", false)
    .option("-f, --force-name", "Allow project names that are normally illegal", false)
    .option("-d, --dev", "Link the resulting mod to the local development version of isaacscript-common.", false)
    .option("-v, --verbose", "Enable verbose output.", false)
    .action(async (name, options) => {
    await init(name, options);
});
function validateSaveSlot(valueString) {
    const valueNumber = parseIntSafe(valueString);
    if (valueNumber === undefined) {
        throw new InvalidOptionArgumentError(`The save slot of "${valueString}" is not a number.`);
    }
    if (valueNumber !== 1 && valueNumber !== 2 && valueNumber !== 3) {
        throw new InvalidOptionArgumentError("The save slot must be equal to 1, 2, or 3.");
    }
    return valueNumber;
}
// eslint-disable-next-line @typescript-eslint/no-unused-vars
const initOptions = initCommand.opts();
async function init(name, options) {
    const { forceName, skipGit, skipInstall, useCurrentDirectory, customDirectory, verbose, vscode, yes, } = options;
    await printBanner();
    const packageManager = await getPackageManagerUsedForNewProject(options);
    // Prompt the end-user for some information (and validate it as we go).
    const { projectPath, createNewDir } = await getProjectPath(name, useCurrentDirectory, customDirectory, yes, forceName);
    await checkIfProjectPathExists(projectPath, yes);
    const projectName = path.basename(projectPath);
    const dev = "dev" in options ? options.dev : false;
    const gitRemoteURL = await promptGitHubRepoOrGitRemoteURL(projectName, yes, skipGit, dev, verbose);
    const modsDirectoryOption = "modsDirectory" in options ? options.modsDirectory : undefined;
    const modsDirectory = await getModsDirectory(modsDirectoryOption);
    checkModSubdirectory(projectPath, modsDirectory);
    await checkModTargetDirectory(modsDirectory, projectName, yes);
    const saveSlotOption = "saveSlot" in options ? options.saveSlot : undefined;
    const saveSlot = await getSaveSlot(saveSlotOption, yes);
    // Now that we have asked the user all of the questions we need, we can create the project.
    await createProject(projectName, projectPath, createNewDir, modsDirectory, saveSlot, gitRemoteURL, skipInstall, packageManager, dev, verbose);
    await vsCodeInit(projectPath, vscode, yes, verbose);
    printIsaacScriptMessage(projectPath, projectName, packageManager);
}
function printIsaacScriptMessage(projectPath, projectName, packageManager) {
    let commandsToType = "";
    if (projectPath !== CWD) {
        commandsToType += `"${chalk.green(`cd ${projectName}`)}" and `;
    }
    const command = getPackageManagerExecCommand(packageManager);
    commandsToType += `"${chalk.green(`${command} isaacscript`)}"`;
    console.log(`Now, start ${PROJECT_NAME} by typing ${commandsToType}.`);
}
//# sourceMappingURL=init.js.map