modpack-lock 0.6.1 → 0.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "modpack-lock",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Creates a modpack lockfile for files hosted on Modrinth (mods, resource packs, shaders and datapacks)",
   "bugs": {
     "url": "https://github.com/nickesc/modpack-lock/issues"
@@ -13,9 +13,9 @@
   "license": "MIT",
   "author": "N. Escobar <nick@nickesc.io> (https://nickesc.github.io/)",
   "type": "module",
-  "main": "src/modpack-lock.js",
+  "main": "build/modpack-lock.js",
   "bin": {
-    "modpack-lock": "src/cli.js"
+    "modpack-lock": "build/cli.js"
   },
   "keywords": [
     "modrinth",
@@ -27,26 +27,36 @@
     "node": ">=22.0.0"
   },
   "scripts": {
+    "build": "tsc",
     "test": "vitest --run",
-    "start": "node src/cli.js",
+    "start": "tsx src/cli.ts",
     "docs": "typedoc",
-    "modpack-lock": "node src/cli.js"
+    "modpack-lock": "tsx src/cli.ts",
+    "prepare": "npm run build"
   },
   "files": [
     "README.md",
     "LICENSE",
     "package.json",
-    "src/**/*.js"
+    "build/**/*"
   ],
   "dependencies": {
-    "commander": "^14.0.2",
+    "@sindresorhus/slugify": "^3.0.0",
+    "commander": "^14.0.3",
     "prompts": "^2.4.2",
     "slugify": "^1.6.6"
   },
   "devDependencies": {
-    "@vitest/coverage-v8": "^4.0.16",
-    "typedoc": "^0.28.16",
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^25.3.3",
+    "@types/prompts": "^2.4.9",
+    "@vitest/coverage-v8": "^4.0.18",
+    "eslint": "^10.0.0",
+    "globals": "^17.3.0",
+    "tsx": "^4.21.0",
+    "typedoc": "^0.28.17",
     "typedoc-github-theme": "^0.3.1",
+    "typescript": "^5.9.3",
     "unzipper": "^0.12.3",
     "vitest": "^4.0.16"
   }

package/src/cli.js

@@ -1,310 +0,0 @@
-#!/usr/bin/env NODE_OPTIONS=--no-warnings node
-
-import {Command} from "commander";
-import slugify from "slugify";
-import path from "path";
-import {spawn} from "child_process";
-import {generateLockfile, printLockfileSummary} from "./generate_lockfile.js";
-import {generateReadmeFiles} from "./generate_readme.js";
-import {generateGitignoreRules} from "./generate_gitignore.js";
-import {generateModpackFiles} from "./modpack-lock.js";
-import {promptUserForInfo, promptUserAboutOptionalFiles} from "./modpack_info.js";
-import {getModpackInfo} from "./directory_scanning.js";
-import * as config from "./config/index.js";
-import pkg from "../package.json" with {type: "json"};
-import {logm, styleText} from "./logger.js";
-
-const modpackLock = new Command("modpack-lock");
-
-/**
- * Merge modpack info with priority: options > existingInfo > defaults
- * Preserves all fields from existingInfo
- */
-function mergeModpackInfo(existingInfo, options, defaults) {
-    const result = {};
-    for (const [key, defaultValue] of Object.entries(defaults)) {
-        result[key] = options[key] || existingInfo?.[key] || defaultValue;
-    }
-
-    // Then, add any fields from existingInfo that aren't in defaults
-    if (existingInfo) {
-        for (const [key, value] of Object.entries(existingInfo)) {
-            if (!(key in defaults)) {
-                result[key] = value;
-            }
-        }
-    }
-
-    return result;
-}
-
-modpackLock
-    .name(pkg.name)
-    .description(pkg.description)
-    .summary("Create a modpack lockfile")
-    .optionsGroup(config.headings.options)
-    .option("-p, --path <path>", "Path to the modpack directory")
-    .option("-d, --dry-run", "Dry-run mode - no files will be written")
-    .optionsGroup(config.headings.generation)
-    .option("-l, --licenseFile", config.fileFields.addLicense.option)
-    .option("-g, --gitignore", config.fileFields.addGitignore.option)
-    .option("-r, --readme", config.fileFields.addReadme.option)
-    .optionsGroup(config.headings.logging)
-    .option("-q, --quiet", "Quiet mode - only show errors and warnings")
-    .option("-s, --silent", "Silent mode - no output")
-    .optionsGroup(config.headings.information)
-    .helpOption("-h, --help", `display help for ${pkg.name}`)
-    .version(pkg.version, "-V")
-    .action(async (options) => {
-        try {
-            const currDir = options.path || process.cwd();
-
-            logm.quietFromOptions(options);
-
-            const modpackInfo = await getModpackInfo(currDir);
-            if (modpackInfo) {
-                const lockfile = await generateModpackFiles(modpackInfo, currDir, options);
-                printLockfileSummary(lockfile);
-            } else {
-                // Warn if license option is passed but no modpack.json exists
-                if (options.licenseFile) {
-                    logm.warn(
-                        `License generation requires a ${config.MODPACK_JSON_NAME} file. Skipping license generation.`,
-                    );
-                }
-
-                // Generate lockfile
-                const lockfile = await generateLockfile(currDir, options);
-
-                if (options.gitignore || options.readme) {
-                    logm.header("Generating Optional Files");
-                }
-
-                // Generate gitignore if requested
-                if (options.gitignore) {
-                    await generateGitignoreRules(lockfile, currDir, options);
-                }
-
-                // Generate README files if requested
-                if (options.readme) {
-                    await generateReadmeFiles(lockfile, currDir, options);
-                }
-
-                printLockfileSummary(lockfile);
-            }
-        } catch (error) {
-            logm.error(error);
-            process.exitCode = 1;
-        }
-    });
-
-modpackLock
-    .command("init")
-    .description(
-        `Initialize a modpack with a ${config.MODPACK_JSON_NAME} file and a ${config.MODPACK_LOCKFILE_NAME} lockfile.`,
-    )
-    .optionsGroup(config.headings.options)
-    .option("-f, --folder <path>", "Path to the modpack directory")
-    .option("-n, --noninteractive", "Non-interactive mode - must provide options for required fields")
-    .option("--add-license", config.fileFields.addLicense.option)
-    .option("--add-gitignore", config.fileFields.addGitignore.option)
-    .option("--add-readme", config.fileFields.addReadme.option)
-    .optionsGroup(config.headings.packInfo)
-    .option("--name <name>", config.infoFields.name.option)
-    .option("--version <version>", config.infoFields.version.option)
-    .option("--id <id>", config.infoFields.id.option)
-    .option("--description <description>", config.infoFields.description.option)
-    .option("--author <author>", config.infoFields.author.option)
-    .option("--projectUrl <projectUrl>", config.infoFields.projectUrl.option)
-    .option("--sourceUrl <sourceUrl>", config.infoFields.sourceUrl.option)
-    .option("--license <license>", config.infoFields.license.option)
-    .option("--modloader <modloader>", config.infoFields.modloader.option)
-    .option("--targetModloaderVersion <targetModloaderVersion>", config.infoFields.targetModloaderVersion.option)
-    .option("--targetMinecraftVersion <targetMinecraftVersion>", config.infoFields.targetMinecraftVersion.option)
-    .optionsGroup(config.headings.information)
-    .helpOption("-h, --help", `display help for ${pkg.name} init`)
-    .action(async (options) => {
-        options._init = true;
-        const currDir = options.folder || process.cwd();
-
-        let existingInfo = await getModpackInfo(currDir);
-
-        if (options.noninteractive) {
-            logm.quiet();
-            if (
-                (!options.author && !existingInfo?.author) ||
-                (!options.modloader && !existingInfo?.modloader) ||
-                (!options.targetMinecraftVersion && !existingInfo?.targetMinecraftVersion)
-            ) {
-                logm.error("Must provide options for required fields");
-                process.exitCode = 1;
-                return;
-            } else {
-                const defaultName = path.basename(currDir);
-                const defaults = {
-                    name: defaultName,
-                    version: config.DEFAULT_MODPACK_VERSION,
-                    id: defaultName,
-                    description: "",
-                    author: options.author, // Required, no default
-                    projectUrl: "",
-                    sourceUrl: "",
-                    license: "",
-                    modloader: options.modloader, // Required, no default
-                    targetModloaderVersion: "",
-                    targetMinecraftVersion: options.targetMinecraftVersion, // Required, no default
-                };
-
-                const modpackInfo = mergeModpackInfo(existingInfo, options, defaults);
-                modpackInfo.id = slugify(modpackInfo.id, config.SLUGIFY_OPTIONS);
-
-                options.readme = options.addReadme;
-                options.gitignore = options.addGitignore;
-                options.licenseFile = options.addLicense;
-
-                // generate the modpack files
-                try {
-                    await generateModpackFiles(modpackInfo, currDir, options);
-                } catch (error) {
-                    logm.error(error);
-                    process.exitCode = 1;
-                }
-            }
-        } else {
-            logm.info(logm.label("modpack-lock"), styleText(["bold", "italic", "blueBright"], "init"));
-            logm.newline();
-            logm.info(
-                styleText(["dim"], "This utility will walk you through creating a"),
-                config.MODPACK_JSON_NAME,
-                styleText(["dim"], "file and a"),
-                config.MODPACK_LOCKFILE_NAME,
-                styleText(
-                    ["dim"],
-                    "lockfile. It only covers the most common items, and tries to guess sensible defaults.",
-                ),
-            );
-            logm.newline();
-            logm.info(
-                styleText(["dim"], "See"),
-                styleText(["white", "bgGray", "italic"], "modpack-lock init --help"),
-                styleText(["dim"], "for definitive documentation on these fields and exactly what they do."),
-            );
-            logm.newline();
-            logm.info(
-                styleText(["dim"], "Press"),
-                styleText(["yellow"], "^C"),
-                styleText(["dim"], "at any time to quit."),
-            );
-            logm.newline();
-            try {
-                const defaults = {
-                    name: path.basename(currDir),
-                    version: config.DEFAULT_MODPACK_VERSION,
-                    id: undefined,
-                    description: undefined,
-                    author: undefined,
-                    projectUrl: undefined,
-                    sourceUrl: undefined,
-                    license: config.DEFAULT_MODPACK_LICENSE,
-                    modloader: undefined,
-                    targetModloaderVersion: undefined,
-                    targetMinecraftVersion: undefined,
-                };
-                const mergedDefaults = mergeModpackInfo(existingInfo, options, defaults);
-
-                // prompt user for modpack information
-                const userAnswers = await promptUserForInfo(mergedDefaults);
-
-                // Preserve extra fields (e.g. scripts) from existing modpack.json
-                const modpackInfo = {...mergedDefaults, ...userAnswers};
-
-                // prompt user if they want to add the license text
-                const optionalFiles = await promptUserAboutOptionalFiles(modpackInfo, options);
-
-                logm.newline();
-
-                // generate the modpack files
-                options.readme = optionalFiles.addReadme;
-                options.gitignore = optionalFiles.addGitignore;
-                options.licenseFile = optionalFiles.addLicense;
-                const lockfile = await generateModpackFiles(modpackInfo, currDir, options);
-
-                printLockfileSummary(lockfile);
-            } catch (error) {
-                logm.error(error);
-                process.exitCode = 1;
-            }
-        }
-    });
-
-modpackLock
-    .command("run")
-    .description(`Run a script defined in the ${config.MODPACK_JSON_NAME} file's 'scripts' field`)
-    .argument("<script>", "The name of the script to run")
-    .optionsGroup(config.headings.options)
-    .option("-f, --folder <path>", "Path to the modpack directory")
-    .option("-D, --debug", "Debug mode -- show more information about how the command is being parsed")
-    .optionsGroup(config.headings.information)
-    .helpOption("-h, --help", `display help for ${pkg.name} run`)
-    .allowExcessArguments(true)
-    .allowUnknownOption(true)
-    .action(async (script, options, command) => {
-        options._run = true;
-        try {
-            if (options.debug) {
-                logm.debug("COMMAND:", command);
-            }
-
-            const currDir = options.folder || process.cwd();
-            const modpackInfo = await getModpackInfo(currDir);
-
-            // verify neccecary files and information exist
-            if (!modpackInfo) {
-                throw new Error(`No ${config.MODPACK_JSON_NAME} file found`);
-            }
-            if (!modpackInfo.scripts) {
-                throw new Error(`No scripts defined in ${config.MODPACK_JSON_NAME}`);
-            }
-            if (!modpackInfo.scripts[script]) {
-                throw new Error(`Script ${script} not found in ${config.MODPACK_JSON_NAME}`);
-            }
-
-            // build the full command
-            const scriptCommand = modpackInfo.scripts[script];
-            const args = command.args ? command.args.slice(1) : [];
-            const fullCommand = `${scriptCommand} ${args.join(" ")}`;
-
-            // debug logging
-            if (options.debug) {
-                logm.debug("CURR DIR:", currDir);
-                logm.debug("OPTIONS:", options);
-                logm.debug("SCRIPT:", script);
-                logm.debug("SCRIPT COMMAND:", scriptCommand);
-                logm.debug("ARGS:", args);
-                logm.debug("FULL COMMAND:", fullCommand);
-            }
-
-            // spawn the command
-            const child = spawn(fullCommand, [], {
-                shell: true,
-                stdio: "inherit",
-                cwd: currDir,
-            });
-
-            // preserve exit code on completion
-            const exitCode = await new Promise((resolve) => {
-                child.on("close", (code) => {
-                    resolve(code || 0);
-                });
-            });
-            process.exitCode = exitCode;
-        } catch (error) {
-            logm.error(error.message);
-            process.exitCode = 1;
-        }
-    });
-
-modpackLock.parseAsync().catch((error) => {
-    logm.error(error);
-    process.exit(1);
-});

package/src/config/defaults.js

@@ -1,66 +0,0 @@
-export const DEFAULT_MODPACK_VERSION = "1.0.0";
-
-export const DEFAULT_MODPACK_LICENSE = "mit";
-
-export const DEFAULT_PROJECT_URL = (id) => {
-    return `https://modrinth.com/modpack/${id}`;
-};
-export const DEFAULT_SOURCE_URL = (id, author) => {
-    return `https://github.com/${author}/${id}`;
-};
-
-/** All-Rights-Reserved license option */
-export const ALL_RIGHTS_RESERVED_LICENSE = {title: "All-Rights-Reserved", value: "all-rights-reserved"};
-
-/** Other option */
-export const OTHER_OPTION = {title: "Other", value: "other"};
-
-/** Fallback licenses */
-export const FALLBACK_LICENSES = [
-    {title: "MIT", value: "mit"},
-    {title: "Apache-2.0", value: "apache-2.0"},
-    {title: "GPL-3.0", value: "gpl-3.0"},
-    {title: "CC0-1.0", value: "cc0-1.0"},
-];
-
-/** Fallback modloaders */
-export const FALLBACK_MODLOADERS = [
-    {title: "fabric", value: "fabric"},
-    {title: "forge", value: "forge"},
-    {title: "neoforge", value: "neoforge"},
-    {title: "paper", value: "paper"},
-    {title: "purpur", value: "purpur"},
-    {title: "quilt", value: "quilt"},
-    {title: "sponge", value: "sponge"},
-    {title: "spigot", value: "spigot"},
-    {title: "vanilla", value: "vanilla"},
-];
-
-/** Fallback target Minecraft versions */
-export const FALLBACK_TARGET_MINECRAFT_VERSIONS = [
-    {title: "1.21.x", value: "1.21.x"},
-    {title: "1.20.x", value: "1.20.x"},
-    {title: "1.19.x", value: "1.19.x"},
-    {title: "1.18.x", value: "1.18.x"},
-    {title: "1.17.x", value: "1.17.x"},
-    {title: "1.16.x", value: "1.16.x"},
-    {title: "1.15.x", value: "1.15.x"},
-    {title: "1.14.x", value: "1.14.x"},
-    {title: "1.13.x", value: "1.13.x"},
-    {title: "1.12.x", value: "1.12.x"},
-    {title: "1.11.x", value: "1.11.x"},
-    {title: "1.10.x", value: "1.10.x"},
-    {title: "1.9.x", value: "1.9.x"},
-    {title: "1.8.x", value: "1.8.x"},
-    {title: "1.7.x", value: "1.7.x"},
-    {title: "1.6.x", value: "1.6.x"},
-    {title: "1.5.x", value: "1.5.x"},
-    {title: "1.4.x", value: "1.4.x"},
-    {title: "1.3.x", value: "1.3.x"},
-    {title: "1.2.x", value: "1.2.x"},
-    {title: "1.1.x", value: "1.1.x"},
-    {title: "1.0.x", value: "1.0.x"},
-    {title: "snapshot", value: "snapshot"},
-    {title: "beta", value: "beta"},
-    {title: "alpha", value: "alpha"},
-];

package/src/config/types.js

@@ -1,76 +0,0 @@
-/**
- * @typedef {Object} ModpackInfo
- * Contains information about the modpack that is not dependent on the lockfile.
- * @property {string} name - The name of the modpack (Required)
- * @property {string} version - The version of the modpack (Required)
- * @property {string} description - The description of the modpack
- * @property {string} id - The slug/ID of the modpack (Required)
- * @property {string} author - The author of the modpack (Required)
- * @property {string} projectUrl - The project URL of the modpack
- * @property {string} sourceUrl - The source code URL of the modpack
- * @property {string} license - The license of the modpack
- * @property {string} modloader - The modloader of the modpack (Required)
- * @property {string} targetModloaderVersion - The target modloader version of the modpack
- * @property {string} targetMinecraftVersion - The target Minecraft version of the modpack (Required)
- */
-
-/**
- * @typedef {Object} Lockfile
- * Contains information about the modpack dependencies and their versions.
- * @property {string} version - The version of the modpack
- * @property {string} generated - The date and time the lockfile was generated
- * @property {number} total - The total number of files in the modpack
- * @property {Object} counts - The counts object
- * @property {number} counts.mods - The mods count
- * @property {number} counts.resourcepacks - The resourcepacks count
- * @property {number} counts.datapacks - The datapacks count
- * @property {number} counts.shaderpacks - The shaderpacks count
- * @property {Object} dependencies - The dependencies object
- * @property {Array<Object>} dependencies.mods - The mods object
- * @property {Array<Object>} dependencies.resourcepacks - The resourcepacks object
- * @property {Array<Object>} dependencies.datapacks - The datapacks object
- * @property {Array<Object>} dependencies.shaderpacks - The shaderpacks object
- */
-
-/**
- * @typedef {Object} Options
- * Contains options for the generation of the modpack files.
- * @property {boolean} dryRun - Whether to dry run the generation
- * @property {boolean} quiet - Whether to quiet the console output
- * @property {boolean} silent - Whether to silent the console output
- * @property {boolean} gitignore - Whether to generate a .gitignore file
- * @property {boolean} readme - Whether to generate README.md files
- * @property {boolean} licenseFile - Whether to generate a license file
- */
-
-/**
- * @typedef {Object} InitOptions
- * Contains options for the initialization of the modpack files.
- * @property {string} folder - The folder to generate the modpack files in
- * @property {boolean} noninteractive - Whether to run the interactive mode
- * @property {boolean} addLicense - Whether to add the license file to the modpack
- * @property {boolean} addGitignore - Whether to generate .gitignore rules
- * @property {boolean} addReadme - Whether to generate README.md files
- * @property {string} name - The name of the modpack
- * @property {string} version - The version of the modpack
- * @property {string} id - The slug/ID of the modpack
- * @property {string} description - The description of the modpack
- * @property {string} author - The author of the modpack
- * @property {string} projectUrl - The modpack's project URL
- * @property {string} sourceUrl - The modpack's source code URL
- * @property {string} license - The modpack's license
- * @property {string} modloader - The modpack's modloader
- * @property {string} targetModloaderVersion - The target modloader version
- * @property {string} targetMinecraftVersion - The target Minecraft version
- * @property {boolean} _init - Internal boolean added to indicate options come from the `init` command.
- */
-
-/**
- * @typedef {Object} RunOptions
- * Contains options for the running scripts defined in modpack.json.
- * @property {string} folder - The folder to look for modpack.json in
- * @property {boolean} debug - Whether to print debug information about the executed script
- * @property {boolean} _run - Internal boolean added to indicate options come from the `run` command.
- */
-
-export {};

package/src/generate_license.js

@@ -1,54 +0,0 @@
-import fs from "fs/promises";
-import path from "path";
-import {getLicenseText} from "./github_interactions.js";
-import * as config from "./config/index.js";
-import {logm} from "./logger.js";
-
-/**
- * @typedef {import('./config/types.js').ModpackInfo} ModpackInfo
- * @typedef {import('./config/types.js').Options} Options
- * @typedef {import('./config/types.js').InitOptions} InitOptions
- */
-
-async function writeLicense(licenseText, outputPath) {
-    await fs.writeFile(path.join(outputPath, config.MODPACK_LICENSE_NAME), licenseText, "utf-8");
-    logm.generated(config.MODPACK_LICENSE_NAME, path.join(outputPath, config.MODPACK_LICENSE_NAME));
-}
-
-/**
- * Write a license to a file
- * @param {ModpackInfo} modpackInfo - The modpack information
- * @param {string} workingDir - The path to write the license to
- * @param {InitOptions} options - The initialization options object
- * @param {string} licenseTextOverride - The license text to override the default license text with
- * @returns {Promise<string> | null} The license text or null if the license text could not be generated
- */
-export default async function generateLicense(modpackInfo, workingDir, options = {}, licenseTextOverride = null) {
-    logm.quietFromOptions(options);
-
-    try {
-        const spdxId = modpackInfo.license;
-
-        let licenseText = licenseTextOverride || (await getLicenseText(spdxId));
-        licenseText = licenseText.replace("[year]", new Date().getFullYear());
-        licenseText = licenseText.replace("{{year}}", new Date().getFullYear());
-        licenseText = licenseText.replace("[fullname]", modpackInfo.author);
-        licenseText = licenseText.replace("{{fullname}}", modpackInfo.author);
-        licenseText = licenseText.replace("[organization]", modpackInfo.author);
-        licenseText = licenseText.replace("{{organization}}", modpackInfo.author);
-        licenseText = licenseText.replace("[project]", modpackInfo.name);
-        licenseText = licenseText.replace("{{project}}", modpackInfo.name);
-
-        if (options.dryRun) {
-            logm.debug(
-                config.dryRunText(config.MODPACK_LICENSE_NAME, path.join(workingDir, config.MODPACK_LICENSE_NAME)),
-            );
-        } else {
-            await writeLicense(licenseText, workingDir);
-        }
-        return licenseText;
-    } catch (error) {
-        logm.warn(`Unable to generate license for: ${modpackInfo.license}`);
-        return null;
-    }
-}