wordulator 1.0.0 → 1.0.1

package/ReadMe.md

@@ -14,18 +14,15 @@ or optimal. It was however an interesting dive into entropy, bitwise optimisatio
 and implementing the Wordle ruleset!
 
 ## Installation
-- Clone repo
-- Navigate to `./` in terminal
-- Run `npm run install-wordulator` - and wait to finish
+- Run `npm install -g wordulator` - and wait to finish
   - Installs base Wordle solutions and guesses
   - Precomputes feedback matrix - This step might take a while
   - Creates 5000 benchmark test cases from the solution list
 - All Done
 
 ### Usage
-- Run in **user** mode using `node .`
-- Run a standard **benchmark** using `npm run benchmark`
-- Run a custom **benchmark** using `node . combo bench (# of tests)`
+- Run in **user** mode using `wordulator`
+- Run a standard **benchmark** using `wordulator bench (# of tests)`
 - Enjoy
 
 ### Example Usage

package/main.js

@@ -1,10 +1,13 @@
 #!/usr/bin/env node
 
-let { solve : combinedSolver   } = require('./src/solvers/combined.js')
-let { randomInt } = require('./src/lib/lib.js')
+// NodeJS Imports
+const path = require('path');
 
-let words = require('./data/filter/words.json');
-let test_data = require('./data/test/tests.json')
+let { solve : combinedSolver   } = require(path.join(__dirname, 'src/solvers/combined.js'));
+let { randomInt } = require(path.join(__dirname, 'src/lib/lib.js'))
+
+let words = require(path.join(__dirname, 'data/filter/words.json'));
+let test_data = require(path.join(__dirname, 'data/test/tests.json'))
 
 main();
 async function main() {
@@ -16,8 +19,8 @@ async function main() {
         let solve = combinedSolver;
 
         switch (type) {
-            case 'bench'     : await benchmark(solve, num, test_data, console.log);                  break;
-            case 'benchmark' : await benchmark(solve, num, test_data, console.log);                  break;                                          break;
+            case 'bench'     : await benchmark(solve, num, test_data, console.log); break;
+            case 'benchmark' : await benchmark(solve, num, test_data, console.log); break;                                       
             case 'user'      : await solve({ type: "user", rand: true, log: console.log }); break;
             default: throw `Invalid Mode Selected ${type}`
         }
@@ -80,5 +83,4 @@ async function benchmark(solve, benchmark_num = 100, tests, log) {
             log(`\t${i+1} guesses - ${no_of_guesses[i]}`);
         }
     }
-
 }

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "wordulator",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "An Entropy Based Wordle Solver",
-  "keywords": ["wordle", "entropy"],
+  "keywords": [
+    "wordle",
+    "entropy"
+  ],
   "license": "MIT",
   "author": "Arlo Filley",
   "repository": {
@@ -12,13 +15,14 @@
   "type": "commonjs",
   "main": "main.js",
   "bin": {
-    "wordulator": "node ./main.js"
+    "wordulator": "main.js"
   },
   "scripts": {
     "test": "echo \"What the hell is a test???? YALL TESTING UR CODE??? GETTOUTAHEER!!!\" && exit 1",
     "install-wordulator": "chmod u+x run/install.bash && run/install.bash && chmod u+x run/benchmark.bash",
     "benchmark": "run/benchmark.bash",
-    "bench": "run/benchmark.bash"
+    "bench": "run/benchmark.bash",
+    "postinstall": "scripts/postinstall.js"
   },
   "dependencies": {
     "@luminati-io/mmap-io": "^1.1.7-lum.6",

package/{run → scripts}/install.bash

@@ -1,8 +1,4 @@
 #!/bin/bash
-echo "installing node modules"
-npm i
-wait
-sleep 5
 
 echo "Creating Directory Structure"
 sleep 0.2

package/scripts/postinstall.js

@@ -0,0 +1,82 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+const { spawnSync } = require('child_process');
+
+function sleep(ms) {
+  return new Promise(resolve => setTimeout(resolve, ms));
+}
+
+// Helper to create directories safely
+function mkdirSafe(dirPath) {
+    if (!fs.existsSync(dirPath)) {
+        fs.mkdirSync(dirPath, { recursive: true });
+        console.log(`Created ${dirPath}`);
+    }
+}
+
+function copyFile(projectRoot, src, dest) {
+    fs.copyFileSync(path.join(projectRoot, src), path.join(projectRoot, dest));
+    console.log(`Copied ./${src} -> ./${dest}`);
+};
+
+function runNodeScript(script, args) {
+    const result = spawnSync('node', [script, ...args], { stdio: 'inherit' });
+    if (result.error) {
+        console.error(`Failed to run ${script}:`, result.error);
+        process.exit(1);
+    }
+    if (result.status !== 0) {
+        console.error(`${script} exited with code ${result.status}`);
+        process.exit(result.status);
+    }
+};
+
+async function main() {
+  const projectRoot = path.join(__dirname, '..');
+
+  // Create Directory Structure
+  const dirs = ['data', 'data/filter', 'data/proc', 'data/raw', 'data/test', 'bench']
+  console.log("Creating Directory Structure");
+  for (const dir of dirs) {
+    mkdirSafe(path.join(projectRoot, dir))
+    await sleep(200);
+  }
+  console.log('---|---|---|---|---\n')
+
+  // Copy files
+  console.log("Copying Files Into Correct Places");
+
+  copyFile(projectRoot, 'scripts/wordle.txt', 'data/raw/wordle.txt');
+  await sleep(200);
+
+  copyFile(projectRoot, 'scripts/solutions.txt', 'data/raw/solutions.txt');
+  await sleep(200);
+  console.log('---|---|---|---|---\n');
+
+  // Filtering Lists for Valid Words
+  console.log("Filtering List For Valid Words");
+  runNodeScript('src/pre/filter_words.js', ['data/raw/wordle.txt', 'data/filter/words.json', '5']);
+  runNodeScript('src/pre/filter_words.js', ['data/raw/solutions.txt', 'data/filter/solutions.json', '5']);
+  console.log('---|---|---|---|---\n');
+
+  // Generate feedback matrix
+  console.log("Generating Feedback Matrix");
+  console.log("This Step Might Take a While");
+  console.log("The Feedback Matrix Can Be Found at data/proc/feedback_matrix.bin. It Takes Up Roughly 200mb For 12k Words");
+  runNodeScript('src/pre/feedback_matrix.js', ['data/filter/words.json', 'data/proc/feedback_matrix.bin']);
+  console.log('---|---|---|---|---\n');
+
+  // Generate Benchmark Tests
+  console.log("Generating Benchmark Tests");
+  runNodeScript('src/pre/test.js', ['data/filter/solutions.json', 'data/test/tests.json', '5000']);
+  console.log('---|---|---|---|---\n');
+
+  console.log("Everything installed correctly :>");
+}
+
+main().catch(err => {
+  console.error('Postinstall failed:', err);
+  process.exit(1);
+});

package/src/pre/feedback_matrix.js

@@ -1,7 +1,8 @@
 /** Precomputes a frequency matrix for a given set of words */
 const fs = require('fs');
+const path = require('path')
 
-const { entropyFeedback } = require('../lib/entropy.js');
+const { entropyFeedback } = require(path.join(__dirname, '../lib/entropy.js'));
 
 try {
     const args = process.argv.slice(2);

package/src/pre/filter_words.js

@@ -1,5 +1,5 @@
 /** Filters words down to a valid list based on a given length and preset character set */
-const fs = require('node:fs');
+const fs = require('fs');
 
 try {
     const args = process.argv.slice(2);

package/src/pre/test.js

@@ -1,8 +1,8 @@
 /** Precomuputes Frequencies of Letters in Words */
-const fs = require('node:fs');
-
-const { randomInt } = require('../lib/lib.js')
+const fs = require('fs');
+const path = require('path');
 
+const { randomInt } = require(path.join(__dirname, '../lib/lib.js'));
 
 try {
     const args = process.argv.slice(2);

package/src/solvers/combined.js

@@ -1,13 +1,16 @@
+// NodeJS Imports
+const path = require('path');
+
 // Lib Imports
-const { calculatePosFreq, pfHeuristicScore: posFreqScore, createOverlap, overlapScore } = require('../lib/heuristic.js');
-const { calculateGuessEntropy: entropy_score, genEntropyTable, loadFeedbackMatrix }   = require('../lib/entropy.js');
-const { ask, normalise } = require('../lib/lib.js');
-const { Wordle, patternFromUserInput } = require('../lib/wordle.js')
+const { calculatePosFreq, pfHeuristicScore: posFreqScore, createOverlap, overlapScore } = require(path.join(__dirname, '../lib/heuristic.js'));
+const { calculateGuessEntropy: entropy_score, genEntropyTable, loadFeedbackMatrix } = require(path.join(__dirname, '../lib/entropy.js'));
+const { ask, normalise } = require(path.join(__dirname, '../lib/lib.js'));
+const { Wordle, patternFromUserInput } = require(path.join(__dirname, '../lib/wordle.js'));
 
 // Load Required Data
-const words = require('../../data/filter/words.json');
-const answers = require('../../data/filter/solutions.json');
-const feedback_matrix = loadFeedbackMatrix('./data/proc/feedback_matrix.bin');
+const words = require(path.join(__dirname, '../../data/filter/words.json'));
+const answers = require(path.join(__dirname, '../../data/filter/solutions.json'));
+const feedback_matrix = loadFeedbackMatrix(path.join(__dirname, '../../data/proc/feedback_matrix.bin'));
 const word_index = new Map();
 words.forEach((w, i) => word_index.set(w, i));