modpack-lock 0.6.2 → 0.8.0

package/src/modpack-lock.js

@@ -1,69 +0,0 @@
-import {generateLockfile} from "./generate_lockfile.js";
-import {generateReadmeFiles} from "./generate_readme.js";
-import {generateGitignoreRules} from "./generate_gitignore.js";
-import generateJson from "./generate_json.js";
-import generateLicense from "./generate_license.js";
-import {logm} from "./logger.js";
-import {promptUserForInfo} from "./modpack_info.js";
-import {getModpackInfo, getLockfile} from "./directory_scanning.js";
-
-/**
- * @typedef {import('./config/types.js').ModpackInfo} ModpackInfo
- * @typedef {import('./config/types.js').Options} Options
- * @typedef {import('./config/types.js').InitOptions} InitOptions
- * @typedef {import('./config/types.js').Lockfile} Lockfile
- */
-
-/**
- * @license MIT
- * @author nickesc
- * @module modpack-lock
- */
-
-/**
- * Generate the modpack files (lockfile, JSON, and optionally license, gitignore, and readme)
- * @param {ModpackInfo} modpackInfo - The modpack information
- * @param {string} workingDir - The directory to generate the files in
- * @param {Options | InitOptions } options - The options object
- * @returns {Promise<Lockfile>} The lockfile object
- */
-async function generateModpackFiles(modpackInfo, workingDir, options = {}) {
-    logm.quietFromOptions(options);
-
-    const lockfile = await generateLockfile(workingDir, options);
-
-    await generateJson(modpackInfo, lockfile, workingDir, options);
-
-    if (options.licenseFile || options.gitignore || options.readme) {
-        logm.header("Generating Optional Files");
-    }
-
-    // Generate license if requested
-    if (options.licenseFile) {
-        await generateLicense(modpackInfo, workingDir, options);
-    }
-
-    // Generate gitignore if requested
-    if (options.gitignore) {
-        await generateGitignoreRules(lockfile, workingDir, options);
-    }
-
-    // Generate README files if requested
-    if (options.readme) {
-        await generateReadmeFiles(lockfile, workingDir, options);
-    }
-
-    return lockfile;
-}
-
-export {
-    generateModpackFiles,
-    generateJson,
-    generateLockfile,
-    generateGitignoreRules,
-    generateReadmeFiles,
-    generateLicense,
-    getModpackInfo,
-    getLockfile,
-    promptUserForInfo,
-};

package/src/modpack_info.js

@@ -1,200 +0,0 @@
-import prompts from "prompts";
-import slugify from "slugify";
-import * as config from "./config/index.js";
-import {getLicenseList, getLicenseText} from "./github_interactions.js";
-import {getMinecraftVersions, getModloaders} from "./modrinth_interactions.js";
-
-/**
- * @typedef {import('./config/types.js').ModpackInfo} ModpackInfo
- */
-
-/**
- * Capitalizes a string
- */
-function capitalize(string) {
-    return `${string.charAt(0).toUpperCase()}${string.slice(1)}`;
-}
-
-/**
- * Validate that a value is not empty
- */
-function validateNotEmpty(value, field) {
-    if (value === undefined || value?.trim().length === 0) {
-        return `${field} cannot be empty`;
-    }
-    return true;
-}
-
-/**
- * Returns a required text prompt
- */
-function requiredText(name, message, initial) {
-    return {
-        type: "text",
-        name: name,
-        message: `${capitalize(message)}`,
-        initial: initial,
-        validate: (value) => {
-            return validateNotEmpty(value, name);
-        },
-    };
-}
-
-/**
- * Returns an optional text prompt
- */
-function optionalText(name, message, initial) {
-    return {
-        type: "text",
-        name: name,
-        message: `${capitalize(message)}`,
-        initial: initial,
-    };
-}
-
-/**
- * Get an other answer from the user
- */
-async function getOtherAnswer(value, message, initial) {
-    if (value && value !== config.OTHER_OPTION.value) {
-        return value;
-    }
-    const question = await prompts(requiredText("other", message, initial), config.PROMPTS_OPTIONS);
-
-    return question.other || config.OTHER_OPTION.value;
-}
-
-/**
- * Returns a required autocomplete prompt with a fallback to the other option
- */
-function requiredAutocomplete(name, message, initial, choices, defaultValue) {
-    initial = initial || defaultValue || config.OTHER_OPTION.value;
-    if (initial && !choices.some((choice) => choice.value === initial)) {
-        choices.push({title: initial, value: initial});
-    }
-
-    return {
-        type: "autocomplete",
-        name: name,
-        message: `${capitalize(message)}`,
-        initial: initial,
-        choices: choices,
-        fallback: config.OTHER_OPTION.value,
-        format: async (value) => {
-            return await getOtherAnswer(value, ` └─𜰙 Other ${message}`, initial);
-        },
-    };
-}
-
-/**
- * Returns an confirmation prompt to generate an optional file
- */
-function fileGenerationConfirm(name, message, showPrompt) {
-    return {
-        type: showPrompt ? "confirm" : null,
-        name: name,
-        message: `${capitalize(message)}`,
-        initial: true,
-    };
-}
-
-/**
- * Get user input for modpack information
- * @param {ModpackInfo} defaults - The initial/default modpack information
- * @returns {Promise<ModpackInfo>} The modpack information from the user
- */
-export async function promptUserForInfo(defaults = {}) {
-    const licenseList = await getLicenseList();
-    const minecraftVersions = await getMinecraftVersions();
-    const modloaders = await getModloaders();
-    let answers = await prompts(
-        [
-            requiredText("name", config.infoFields.name.prompt, defaults.name),
-            requiredText(
-                "version",
-                config.infoFields.version.prompt,
-                defaults.version || config.DEFAULT_MODPACK_VERSION,
-            ),
-            requiredText("id", config.infoFields.id.prompt, (prev, values) =>
-                slugify(defaults.id || values.name, config.SLUGIFY_OPTIONS),
-            ),
-            optionalText("description", config.infoFields.description.prompt, defaults.description),
-            requiredText("author", config.infoFields.author.prompt, defaults.author),
-            optionalText(
-                "projectUrl",
-                config.infoFields.projectUrl.prompt,
-                (prev, values) => defaults.projectUrl || config.DEFAULT_PROJECT_URL(values.id),
-            ),
-            optionalText(
-                "sourceUrl",
-                config.infoFields.sourceUrl.prompt,
-                (prev, values) => defaults.sourceUrl || config.DEFAULT_SOURCE_URL(values.id, values.author),
-            ),
-            requiredAutocomplete(
-                "license",
-                config.infoFields.license.prompt,
-                defaults.license,
-                licenseList,
-                config.DEFAULT_MODPACK_LICENSE,
-            ),
-            requiredAutocomplete(
-                "modloader",
-                config.infoFields.modloader.prompt,
-                defaults.modloader,
-                modloaders,
-                config.FALLBACK_MODLOADERS[0].value,
-            ),
-            optionalText(
-                "targetModloaderVersion",
-                config.infoFields.targetModloaderVersion.prompt,
-                defaults.targetModloaderVersion,
-            ),
-            requiredAutocomplete(
-                "targetMinecraftVersion",
-                config.infoFields.targetMinecraftVersion.prompt,
-                defaults.targetMinecraftVersion,
-                minecraftVersions,
-                minecraftVersions[0].value,
-            ),
-        ],
-        config.PROMPTS_OPTIONS,
-    );
-
-    return answers;
-}
-
-/**
- * Prompt the user about adding the license text to the modpack
- * @param {ModpackInfo} modpackInfo - The modpack information
- * @returns {Promise<Object>} The answers from the user
- */
-export async function promptUserAboutOptionalFiles(modpackInfo, defaults = {}) {
-    const licenseText = await getLicenseText(modpackInfo.license);
-    const answers = await prompts(
-        [
-            fileGenerationConfirm(
-                "addLicense",
-                `${config.fileFields.addLicense.prompt}?`,
-                licenseText && defaults.addLicense === undefined,
-            ),
-            fileGenerationConfirm(
-                "addReadme",
-                `${config.fileFields.addReadme.prompt}?`,
-                defaults.addReadme === undefined,
-            ),
-            fileGenerationConfirm(
-                "addGitignore",
-                `${config.fileFields.addGitignore.prompt}?`,
-                defaults.addGitignore === undefined,
-            ),
-        ],
-        config.PROMPTS_OPTIONS,
-    );
-
-    answers.addLicense =
-        answers.addLicense === undefined ? (licenseText ? defaults.addLicense : false) : answers.addLicense;
-    answers.addReadme = answers.addReadme === undefined ? defaults.addReadme : answers.addReadme;
-    answers.addGitignore = answers.addGitignore === undefined ? defaults.addGitignore : answers.addGitignore;
-
-    return answers;
-}