modpack-lock 0.4.0 → 0.5.0

package/README.md

@@ -12,12 +12,10 @@ Creates a modpack lockfile for files hosted on Modrinth (mods, resource packs, s
 
 Many mod and pack authors request that modpack creators link to Modrinth or CurseForge downloads rather than re-hosting files. This makes it difficult to track content files in version control when pushing to a remote server.
 
-This script generates a `modpack.lock` file in the current directory containing a plaintext representation of the modpack's contents. This object contains the metadata for the content available on Modrinth, including hashes, versions, names, download URLs and more. An optional `modpack.json` file can also be created to store your modpack's metadata (name, version, modloader, dependencies, etc.) alongside the lockfile. This setup allows for easy diffing and clear version history.
+This script generates a `modpack.lock` file containing a plaintext representation of the modpack's contents. This object contains the metadata for the content available on Modrinth, including hashes, versions, names, download URLs and more. An optional `modpack.json` file can also be created to store your modpack's metadata (name, version, modloader, dependencies, etc.) alongside the lockfile. This setup allows for easy diffing and clear version history.
 
 > While an `.mrpack` file could be used to track changes to the modpack, it is a large, binary file that cannot be diffed and can contain large amounts of duplicate data from the rest of the repository.
 
-The lockfile could also serve as a basis for restoring modpack contents after cloning the repository to a new machine.
-
 Using the `scripts` field in `modpack.json`, you can also define reusable, tracked shell commands for common modpack tasks (like publishing, generating assets or CI/CD workflows).
 
 ## Installation
@@ -36,7 +34,7 @@ npx modpack-lock
 
 ## CLI
 
-Navigate to your Minecraft profile directory (the folder containing `mods`, `resourcepacks`, `datapacks`, and `shaderpacks` folders) and run:
+To generate a lockfile for your modpack, run:
 
 ```bash
 modpack-lock
@@ -44,14 +42,12 @@ modpack-lock
 
 The script will:
 
-1. Scan the `mods`, `resourcepacks`, `datapacks`, and `shaderpacks` directories for `.jar` and `.zip` files
-2. Calculate SHA1 hashes for each file
-3. Query the Modrinth API to find version information
-4. Generate a `modpack.lock` file in the current directory
-
-If a `modpack.json` file exists in the directory, the lockfile's dependency list will also be written to it. Run `modpack-lock init` to create this file.
+- Scan target directory's `mods`, `resourcepacks`, `datapacks`, and `shaderpacks` directories for `.jar` and `.zip` files
+- Calculate SHA1 hashes for each file
+- Query the Modrinth API for matching versions
+- Generate a `modpack.lock` file (and update `modpack.json` dependencies if present)
 
-Then, commit the `modpack.lock` (and `modpack.json`) to your repository and push it to your remote.
+Use flags to generate `README.md` files for each category or update the `.gitignore` to ignore content hosted on Modrinth.
 
 ```text
 Usage: modpack-lock [options] [command]
@@ -59,25 +55,31 @@ Usage: modpack-lock [options] [command]
 Creates a modpack lockfile for files hosted on Modrinth (mods, resource packs, shaders and datapacks)
 
 Options:
-  -p, --path <path>  Path to the modpack directory
-  -d, --dry-run      Dry-run mode - no files will be written
+  -p, --path <path>       Path to the modpack directory
+  -d, --dry-run           Dry-run mode - no files will be written
 
 GENERATION
-  -g, --gitignore    Print .gitignore rules for files not hosted on Modrinth
-  -r, --readme       Generate README.md files for each category
+  -g, --gitignore         Update the .gitignore file to ignore content hosted on Modrinth
+  -r, --readme            Generate README.md files for each category
 
 LOGGING
-  -q, --quiet        Quiet mode - only show errors and warnings
-  -s, --silent       Silent mode - no output
+  -q, --quiet             Quiet mode - only show errors and warnings
+  -s, --silent            Silent mode - no output
 
 INFORMATION
-  -V                 output the version number
-  -h, --help         display help for modpack-lock
+  -V                      output the version number
+  -h, --help              display help for modpack-lock
 
 Commands:
-  init [options]     This utility will walk you through creating a modpack.json file. It only covers the most common items, and tries to guess sensible defaults.
+  init [options]          This utility will walk you through creating a modpack.json file. It only covers the most common items, and tries to guess sensible defaults.
+  run [options] <script>  Run a script defined in the modpack.json file's 'scripts' field
 ```
 
+> [!TIP]
+>
+> #### Did you know?
+>
+> You can generate summary files for each category by running `modpack-lock -r`. This will generate a `README.md` file in each of the content folders, detailing the scanned files and important attribution information for them.
 
 ### Initialization
 
@@ -87,9 +89,13 @@ To initialize a new modpack, run:
 modpack-lock init
 ```
 
-This will create a `modpack.json` file that stores your modpack's metadata (name, version, author, etc.), including a list of dependency slugs. This file is optional, but when present, the main command will also write the lockfile dependencies to `modpack.json`. It will also regenerate the lockfile.
+This command will:
+
+- Prompt the user for the modpack's metadata (name, version, author, etc.)
+- Generate the lockfile
+- Generate a `modpack.json` file that stores your modpack's metadata (name, version, author, etc.), including a list of dependencies
 
-The interactive mode will prompt you for each field. Set their initial values using the available option flags. Use `--noninteractive` with the required options (`--author`, `--modloader`, `--targetMinecraftVersion`) to skip prompts.
+The interactive mode will prompt you for each field. Set their initial values using the available option flags. Use `--noninteractive` with the required options to skip the interactive-prompt and use the provided values.
 
 ```text
 Usage: modpack-lock init [options]
@@ -99,46 +105,53 @@ This utility will walk you through creating a modpack.json file. It only covers
 Options:
   -f, --folder <path>                                Path to the modpack directory
   -n, --noninteractive                               Non-interactive mode - must provide options for required fields
+  --add-license                                      Add the LICENSE file to the modpack
+  --add-gitignore                                    Update the .gitignore file to ignore content hosted on Modrinth
+  --add-readme                                       Generate README.md files for each category
 
 MODPACK INFORMATION
-  --name <name>                                      Modpack name; defaults to the directory name; required
-  --version <version>                                Modpack version; defaults to 1.0.0; required
-  --id <id>                                          Modpack slug/ID; defaults to the directory name slugified; required
+  --name <name>                                      Modpack name; defaults to the directory name
+  --version <version>                                Modpack version; defaults to 1.0.0
+  --id <id>                                          Modpack slug/ID; defaults to the directory name slugified
   --description <description>                        Modpack description
   --author <author>                                  Modpack author; required
-  --projectUrl <projectUrl>                          Modpack URL
-  --sourceUrl <sourceUrl>                            Modpack source code URL
-  --license <license>                                Modpack license
-  --modloader <modloader>                            Modpack modloader; required
+  --projectUrl <projectUrl>                          Modpack URL; defaults to a guessed Modrinth project URL
+  --sourceUrl <sourceUrl>                            Modpack source code URL; defaults to a guessed GitHub repository URL
+  --license <license>                                Modpack license, popular licenses fetched from GitHub; defaults to MIT in interactive mode
+  --modloader <modloader>                            Modpack modloader, list of loaders fetched from Modrinth; required
   --targetModloaderVersion <targetModloaderVersion>  Target modloader version
-  --targetMinecraftVersion <targetMinecraftVersion>  Target Minecraft version; required
+  --targetMinecraftVersion <targetMinecraftVersion>  Target Minecraft version, list of versions fetched from Modrinth; required
 
 INFORMATION
-  --help                                             display help for modpack-lock init
+  -h, --help                                         display help for modpack-lock init
 ```
 
 ### Running Scripts
 
-To run a script defined in `modpack.json` run:
+To run a script defined in `modpack.json`, run:
 
 ```bash
 modpack-lock run <script>
 ```
 
-This command takes the name of the script as its first argument. Use the `-f` option to specify a different path to the modpack directory. For debug logging, use the `-D` option.
+This command takes the name of the script as its first argument:
 
-To pass additional arguments and options to the script, write them after a `--` separator:
+- It searches for a scripts fiels in `modpack.json` in the current directory by default.
+- Use the `-f` option to specify a different path to the modpack directory.
+- For debug logging, use the `-D` option.
 
-```bash
-modpack-lock run <script> -- [options] <args> 
-```
+> To pass additional arguments and options to the script, write them after a `--` separator:
+>
+> ```bash
+> modpack-lock run <script> -- [options] <args>
+> ```
 
 The `scripts` field in `modpack.json` is a key-value pair of script names and their corresponding shell commands. The `scripts` field is optional and is omitted by default.
 
 ```text
 Usage: modpack-lock run [options] <script>
 
-Run a script (shell command) defined in modpack.json's 'scripts' object
+Run a script defined in the modpack.json file's 'scripts' field
 
 Arguments:
   script               The name of the script to run
@@ -146,25 +159,11 @@ Arguments:
 Options:
   -f, --folder <path>  Path to the modpack directory
   -D, --debug          Debug mode -- show more information about how the command is being parsed
+
+INFORMATION
   -h, --help           display help for modpack-lock run
 ```
 
-> [!TIP]
->
-> You can run this script as a pre-commit hook to ensure that the modpack lockfile is up to date before committing your changes to your repository.
->
-> Also, consider adding these rules to your `.gitignore` to ensure you don't commit the modpack contents to your repository, with exceptions for any files that are not Modrinth-hosted:
->
-> ```txt
-> mods/*.jar
-> resourcepacks/*.zip
-> datapacks/*.zip
-> shaderpacks/*.zip
-> 
-> ## Exceptions
-> # !mods/example.jar
-> ```
-
 ## API
 
 For programmatic usage, `modpack-lock` exports these functions:
@@ -174,6 +173,7 @@ For programmatic usage, `modpack-lock` exports these functions:
 - `generateJson()`
 - `generateGitignoreRules()`
 - `generateReadmeFiles()`
+- `generateLicense()`
 - `generateLockfile()`
 - `generateModpackFiles()`
 - `promptUserForInfo()`
@@ -184,7 +184,7 @@ See the [API documentation](https://nickesc.github.io/modpack-lock) for full det
 
 ### `modpack.lock`
 
-The lockfile contains metadata about Modrinth-hosted files found in your modpack directories:
+The lockfile contains metadata about Modrinth-hosted files found in modpack directories:
 
 ```json
 {
@@ -213,7 +213,7 @@ The lockfile contains metadata about Modrinth-hosted files found in your modpack
 
 ### `modpack.json`
 
-If created via `modpack-lock init`, the JSON file combines your modpack metadata with the lockfile's dependency list:
+The JSON file contains your modpack metadata and a dependency list:
 
 ```json
 {
@@ -228,18 +228,41 @@ If created via `modpack-lock init`, the JSON file combines your modpack metadata
   "modloader": "modloader",
   "targetModloaderVersion": "",
   "targetMinecraftVersion": "x.y.z",
+  "scripts": {
+    "example": "echo 'example script'"
+  },
   "dependencies": {
     "mods": [ ... ],
     "resourcepacks": [ ... ],
     "datapacks": [ ... ],
     "shaderpacks": [ ... ]
-  },
-  "scripts": {
-    "example": "echo 'example script'"
   }
 }
 ```
 
+> [!IMPORTANT]
+>
+> #### Don't commit binaries
+>
+> Use `modpack-lock -g` to automatically update your `.gitignore` file with rules to ignore modpack contents, with exceptions for any files that are not hosted by Modrinth:
+>
+> ```txt
+> # .gitignore
+>
+> # modpack-lock:start
+> mods/*.jar
+> resourcepacks/*.zip
+> datapacks/*.zip
+> shaderpacks/*.zip
+> */**/*.disabled
+> 
+> ## Exceptions
+> !mods/example.jar
+> # modpack-lock:end
+> ```
+>
+> This section is managed by modpack-lock and will be updated automatically when you run `modpack-lock -g`. Changes made inside this section will be overwritten, but any changes you make outside of this section will be preserved.
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for more details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "modpack-lock",
-  "version": "0.4.0",
+  "version": "0.5.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"

package/src/cli.js

@@ -6,8 +6,9 @@ import path from 'path';
 import { spawn } from 'child_process';
 import {generateLockfile} from './generate_lockfile.js';
 import { generateModpackFiles } from './modpack-lock.js';
-import promptUserForInfo from './modpack_info.js';
+import { promptUserForInfo, promptUserAboutOptionalFiles } from './modpack_info.js';
 import { getModpackInfo } from './directory_scanning.js';
+import generateLicense from './generate_license.js';
 import * as config from './config/index.js';
 import pkg from '../package.json' with { type: 'json' };
 
@@ -69,16 +70,16 @@ modpackLock
     .name(pkg.name)
     .description(pkg.description)
     .summary("Create a modpack lockfile")
-    .optionsGroup("Options:")
+    .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("GENERATION")
-    .option('-g, --gitignore', 'Print .gitignore rules for files not hosted on Modrinth')
-    .option('-r, --readme', 'Generate README.md files for each category')
-    .optionsGroup("LOGGING")
+    .optionsGroup(config.headings.generation)
+    .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("INFORMATION")
+    .optionsGroup(config.headings.information)
     .helpOption("-h, --help", `display help for ${pkg.name}`)
     .version(pkg.version, '-V')
     .action(async (options) => {
@@ -107,24 +108,28 @@ const jsonDescription = `This utility will walk you through creating a ${config.
 
 modpackLock.command('init')
     .description(jsonDescription)
-    .optionsGroup("Options:")
+    .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')
-    .optionsGroup("MODPACK INFORMATION")
-    .option('--name <name>', 'Modpack name; defaults to the directory name')
-    .option('--version <version>', 'Modpack version; defaults to 1.0.0')
-    .option('--id <id>', 'Modpack slug/ID; defaults to the directory name slugified')
-    .option('--description <description>', 'Modpack description')
-    .option('--author <author>', 'Modpack author; required')
-    .option('--projectUrl <projectUrl>', 'Modpack URL')
-    .option('--sourceUrl <sourceUrl>', 'Modpack source code URL')
-    .option('--license <license>', 'Modpack license')
-    .option('--modloader <modloader>', 'Modpack modloader; required')
-    .option('--targetModloaderVersion <targetModloaderVersion>', 'Target modloader version')
-    .option('--targetMinecraftVersion <targetMinecraftVersion>', 'Target Minecraft version; required')
-    .optionsGroup("INFORMATION")
+    .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);
@@ -153,8 +158,17 @@ modpackLock.command('init')
 
                 const modpackInfo = mergeModpackInfo(existingInfo, options, defaults);
                 modpackInfo.id = slugify(modpackInfo.id, config.SLUGIFY_OPTIONS);
+
+                if (options.addLicense) {
+                    await generateLicense(modpackInfo, currDir, options);
+                }
+
+                options.readme = options.addReadme;
+                options.gitignore = options.addGitignore;
+
+                // generate the modpack files
                 try {
-                    await generateModpackFiles(modpackInfo, currDir, { dryRun: false });
+                    await generateModpackFiles(modpackInfo, currDir, options);
                 } catch (error) {
                     console.error('Error:', error);
                     process.exitCode = 1;
@@ -179,11 +193,23 @@ modpackLock.command('init')
                     targetMinecraftVersion: undefined,
                 };
 
+                // prompt user for modpack information
                 const modpackInfo = await promptUserForInfo(
                     mergeModpackInfo(existingInfo, options, defaults)
                 );
 
-                await generateModpackFiles(modpackInfo, currDir, { dryRun: false });
+                // prompt user if they want to add the license text
+                const optionalFiles = await promptUserAboutOptionalFiles(modpackInfo, options);
+                console.log();
+                if (options.addLicense || optionalFiles.addLicense) {
+                    await generateLicense(modpackInfo, currDir, options);
+                }
+                console.log();
+
+                // generate the modpack files
+                options.readme = optionalFiles.addReadme;
+                options.gitignore = optionalFiles.addGitignore;
+                await generateModpackFiles(modpackInfo, currDir, options);
             } catch (error) {
                 console.error('Error:', error);
                 process.exitCode = 1;
@@ -192,14 +218,17 @@ modpackLock.command('init')
     });
 
 modpackLock.command('run')
-    .description(`Run a script (shell command) defined in ${config.MODPACK_JSON_NAME}\'s \'scripts\' object`)
+    .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) {
                 console.log("COMMAND:", command);
@@ -210,13 +239,13 @@ modpackLock.command('run')
 
             // verify neccecary files and information exist
             if (!modpackInfo) {
-                throw new Error('No modpack.json file found');
+                throw new Error(`No ${config.MODPACK_JSON_NAME} file found`);
             }
             if (!modpackInfo.scripts) {
-                throw new Error('No scripts defined in modpack.json');
+                throw new Error(`No scripts defined in ${config.MODPACK_JSON_NAME}`);
             }
             if (!modpackInfo.scripts[script]) {
-                throw new Error(`Script ${script} not found in modpack.json`);
+                throw new Error(`Script ${script} not found in ${config.MODPACK_JSON_NAME}`);
             }
 
             // build the full command

package/src/config/api.js

@@ -10,5 +10,23 @@ export const MODRINTH_PROJECTS_ENDPOINT = `${MODRINTH_API_BASE}/projects`;
 /** Modrinth users endpoint */
 export const MODRINTH_USERS_ENDPOINT = `${MODRINTH_API_BASE}/users`;
 
+/** Modrinth Minecraft versions endpoint */
+export const MODRINTH_MINECRAFT_VERSIONS_ENDPOINT = `${MODRINTH_API_BASE}/tag/game_version`;
+
+/** Modrinth Modloaders endpoint */
+export const MODRINTH_MODLOADERS_ENDPOINT = `${MODRINTH_API_BASE}/tag/loader`;
+
 /** Batch size for Modrinth API requests */
 export const BATCH_SIZE = 100;
+
+/** GitHub API base URL */
+export const GITHUB_API_BASE = 'https://api.github.com';
+
+/** GitHub licenses endpoint */
+export const GITHUB_LICENSES_ENDPOINT = `${GITHUB_API_BASE}/licenses`;
+
+/** GitHub featured licenses endpoint */
+export const GITHUB_FEATURED_LICENSES_ENDPOINT = `${GITHUB_LICENSES_ENDPOINT}?featured=true`;
+
+/** GitHub license endpoint */
+export const GITHUB_LICENSE_ENDPOINT = (license) => `${GITHUB_API_BASE}/licenses/${license}`;

package/src/config/constants.js

@@ -1,3 +1,5 @@
+import pkg from '../../package.json' with { type: 'json' };
+
 /** Lockfile format version -- increment on changes to the format */
 export const LOCKFILE_VERSION = "1.0.1";
 
@@ -18,3 +20,19 @@ export const DEPENDENCY_CATEGORIES = [
     "shaderpacks",
     "datapacks"
 ];
+
+/** Minecraft version types */
+export const MINECRAFT_VERSION_TYPES = [
+    "release",
+    "alpha",
+    "beta",
+    "snapshot"
+];
+
+const gitignoreMarker = (mode) =>  `# ${pkg.name}:${mode}`;
+
+/** Gitignore section start marker */
+export const GITIGNORE_START_MARKER = gitignoreMarker('start');
+
+/** Gitignore section end marker */
+export const GITIGNORE_END_MARKER = gitignoreMarker('end');

package/src/config/defaults.js

@@ -1,8 +1,66 @@
 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/files.js

@@ -3,3 +3,12 @@ export const MODPACK_LOCKFILE_NAME = "modpack.lock";
 
 /** Human-readable/JSON file name */
 export const MODPACK_JSON_NAME = "modpack.json";
+
+/** License file name */
+export const MODPACK_LICENSE_NAME = "LICENSE";
+
+/** Gitignore file name */
+export const GITIGNORE_NAME = ".gitignore";
+
+/** README.md file name */
+export const README_NAME = "README.md";

package/src/config/index.js

@@ -3,3 +3,4 @@ export * from './api.js';
 export * from './files.js';
 export * from './options.js';
 export * from './defaults.js';
+export * from './strings.js';

package/src/config/options.js

@@ -1,2 +1,16 @@
 /** Options for slugify */
-export const SLUGIFY_OPTIONS = { lower: true, strict: true, separator: '-', locale: 'en', trim: true };
+export const SLUGIFY_OPTIONS = {
+    lower: true,
+    strict: true,
+    separator: '-',
+    locale: 'en',
+    trim: true
+};
+
+/** Options for prompts */
+export const PROMPTS_OPTIONS = {
+    onCancel: () => {
+        console.warn('Modpack initialization was interrupted');
+        process.exit(1);
+    }
+};