modpack-lock 0.1.0 → 0.1.1

package/README.md

@@ -41,6 +41,13 @@ Navigate to your Minecraft profile directory (the folder containing `mods`, `res
 modpack-lock
 ```
 
+Flags:
+
+- `--dry-run` or `-d`: Print the files that would be scanned, but don't actually scan them
+- `--quiet` or `-q`: Print only errors and warnings
+- `--silent` or `-s`: Print nothing
+- `--gitignore` or `-g`: Print the rules to add to your `.gitignore` file
+
 The script will:
 
 1. Scan the `mods`, `resourcepacks`, `datapacks`, and `shaderpacks` directories for `.jar` and `.zip` files
@@ -51,6 +58,7 @@ The script will:
 Then, commit the `modpack.lock` file to your repository and push it to your remote.
 
 > [!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:
@@ -87,17 +95,6 @@ The `modpack.lock` file has the following structure:
 }
 ```
 
-## Future Plans
-
-- [ ] Add support for CurseForge
-- [ ] Add support for restoring modpack contents using the lockfile
-- [ ] Add CLI option for dry-run
-- [ ] Add CLI option for verbose output
-- [ ] Add CLI option for quiet output
-- [ ] Add CLI option for printout of rules to add to .gitignore (the files that are not hosted)
-
-Feel free to submit a pull request working on any of the above, or open an issue for any feature requests or bug reports.
-
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for more details.

package/index.js

@@ -12,6 +12,39 @@ const MODRINTH_VERSION_FILES_ENDPOINT = `${MODRINTH_API_BASE}/version_files`;
 // Get the workspace root from the current working directory
 const WORKSPACE_ROOT = process.cwd();
 
+/**
+ * Parse command-line arguments
+ */
+function parseArgs() {
+  const args = process.argv.slice(2);
+  return {
+    dryRun: args.includes('--dry-run') || args.includes('-d'),
+    quiet: args.includes('--quiet') || args.includes('-q'),
+    silent: args.includes('--silent') || args.includes('-s'),
+    gitignore: args.includes('--gitignore') || args.includes('-g'),
+  };
+}
+
+/**
+ * Create a logger function that respects quiet mode
+ */
+function createLogger(quiet) {
+  if (quiet) {
+    return () => {}; // No-op function when quiet
+  }
+  return (...args) => console.log(...args);
+}
+
+/**
+ * Silence all console.log output
+ */
+function silenceConsole() {
+  console.log = () => {};
+  console.warn = () => {};
+  console.error = () => {};
+  console.info = () => {};
+}
+
 const DIRECTORIES_TO_SCAN = [
   { name: 'mods', path: path.join(WORKSPACE_ROOT, 'mods') },
   { name: 'resourcepacks', path: path.join(WORKSPACE_ROOT, 'resourcepacks') },
@@ -152,36 +185,85 @@ function createLockfile(fileEntries, versionData) {
 /**
  * Write lockfile to disk
  */
-async function writeLockfile(lockfile, outputPath) {
+async function writeLockfile(lockfile, outputPath, log) {
   const content = JSON.stringify(lockfile, null, 2);
   await fs.writeFile(outputPath, content, 'utf-8');
-  console.log(`Lockfile written to: ${outputPath}`);
+  log(`Lockfile written to: ${outputPath}`);
+}
+
+/**
+ * Generate .gitignore rules for files not hosted on Modrinth
+ */
+function generateGitignoreRules(lockfile) {
+  const rules = [];
+  const exceptions = [];
+
+  // Base ignore patterns for each category
+  rules.push('mods/*.jar');
+  rules.push('resourcepacks/*.zip');
+  rules.push('datapacks/*.zip');
+  rules.push('shaderpacks/*.zip');
+  rules.push('');
+  rules.push('## Exceptions');
+
+  // Find files not hosted on Modrinth
+  for (const [category, entries] of Object.entries(lockfile.dependencies)) {
+    for (const entry of entries) {
+      if (entry.version === null) {
+        exceptions.push(`!${entry.path}`);
+      }
+    }
+  }
+
+  // Add exceptions if any
+  if (exceptions.length > 0) {
+    rules.push(...exceptions);
+  } else {
+    rules.push('# No exceptions needed - all files are hosted on Modrinth');
+  }
+
+  return rules.join('\n');
 }
 
 /**
  * Main execution function
  */
 async function main() {
-  console.log('Scanning directories for modpack files...');
+  const config = parseArgs();
+  const log = createLogger(config.quiet);
+
+  if (config.silent) {
+    silenceConsole();
+  }
+
+  if (config.dryRun) {
+    log('[DRY RUN] Preview mode - no files will be written');
+  }
+
+  log('Scanning directories for modpack files...');
 
   // Scan all directories
   const allFileEntries = [];
   for (const dirInfo of DIRECTORIES_TO_SCAN) {
-    console.log(`Scanning ${dirInfo.name}...`);
+    log(`Scanning ${dirInfo.name}...`);
     const fileEntries = await scanDirectory(dirInfo);
-    console.log(`  Found ${fileEntries.length} file(s)`);
+    log(`  Found ${fileEntries.length} file(s)`);
     allFileEntries.push(...fileEntries);
   }
 
   if (allFileEntries.length === 0) {
-    console.log('No files found. Creating empty lockfile.');
+    log('No files found. Creating empty lockfile.');
     const outputPath = path.join(WORKSPACE_ROOT, MODPACK_LOCKFILE_NAME);
-    await writeLockfile(createEmptyLockfile(), outputPath);
+    if (config.dryRun) {
+      log(`[DRY RUN] Would write lockfile to: ${outputPath}`);
+    } else {
+      await writeLockfile(createEmptyLockfile(), outputPath, log);
+    }
     return;
   }
 
-  console.log(`\nTotal files found: ${allFileEntries.length}`);
-  console.log('\nQuerying Modrinth API...');
+  log(`\nTotal files found: ${allFileEntries.length}`);
+  log('\nQuerying Modrinth API...');
 
   // Extract all hashes
   const hashes = allFileEntries.map(info => info.hash);
@@ -189,21 +271,31 @@ async function main() {
   // Query Modrinth API
   const versionData = await getVersionsFromHashes(hashes);
 
-  console.log(`\nFound version information for ${Object.keys(versionData).length} out of ${hashes.length} files`);
+  log(`\nFound version information for ${Object.keys(versionData).length} out of ${hashes.length} files`);
 
   // Create lockfile
   const lockfile = createLockfile(allFileEntries, versionData);
 
   // Write lockfile
   const outputPath = path.join(WORKSPACE_ROOT, MODPACK_LOCKFILE_NAME);
-  await writeLockfile(lockfile, outputPath);
+  if (config.dryRun) {
+    log(`[DRY RUN] Would write lockfile to: ${outputPath}`);
+  } else {
+    await writeLockfile(lockfile, outputPath, log);
+  }
 
   // Summary
-  console.log('\n=== Summary ===');
+  log('\n=== Summary ===');
   for (const [category, entries] of Object.entries(lockfile.dependencies)) {
     const withVersion = entries.filter(e => e.version !== null).length;
     const withoutVersion = entries.length - withVersion;
-    console.log(`${category}: ${entries.length} file(s) (${withVersion} found on Modrinth, ${withoutVersion} unknown)`);
+    log(`${category}: ${entries.length} file(s) (${withVersion} found on Modrinth, ${withoutVersion} unknown)`);
+  }
+
+  // Generate .gitignore rules if requested
+  if (config.gitignore) {
+    log('\n=== .gitignore Rules ===');
+    log(generateGitignoreRules(lockfile));
   }
 }
 

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "modpack-lock",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Create a modpack lockfile for files hosted on Modrinth (mods, resource packs, shaders and datapacks)",
-  "homepage": "https://github.com/nickesc/modpack-lock#readme",
   "bugs": {
     "url": "https://github.com/nickesc/modpack-lock/issues"
   },