scrabble-cheater 3.6.5 → 3.7.0

package/README.md

@@ -11,7 +11,7 @@ Of course you shouldn't be using this and I'm not responsible if people call you
 
 ## Setup
 
-ℹ️ This is a hybrid [CommonJS](https://nodejs.org/docs/latest/api/modules.html#modules-commonjs-modules) / [ESM](https://nodejs.org/api/esm.html#introduction) module.
+ℹ️ This is a pure [ESM](https://nodejs.org/api/esm.html#introduction) module.
 
 ```
 yarn

package/dist/{cjs/cli.js → cli.js}

@@ -1,9 +1,13 @@
 #!/usr/bin/env node
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { program as commander } from 'commander';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
 import { ScrabbleCheater } from './index.js';
-const { bin, description, version } = require('../package.json');
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const packageJsonPath = path.join(__dirname, '../package.json');
+const { bin, description, version } = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
 commander
     .name(Object.keys(bin)[0])
     .version(version)

package/dist/{esm/index.js → index.js}

@@ -1,8 +1,6 @@
+import { promises as fs } from 'node:fs';
+import readline from 'node:readline';
 import clipboard from 'clipboardy';
-import fs from 'fs';
-import readline from 'readline';
-import { promisify } from 'util';
-const readFileAsync = promisify(fs.readFile);
 const defaultOptions = {
     letters: '',
     maximum: 0,
@@ -48,7 +46,7 @@ export class ScrabbleCheater {
     }
     async loadWords() {
         const regex = new RegExp('^[A-Za-z]+$');
-        const wordList = await readFileAsync(this.wordListPath, 'utf-8');
+        const wordList = await fs.readFile(this.wordListPath, 'utf-8');
         this.dictionary = wordList.split('\n').filter(value => regex.test(value));
         return this.dictionary.length;
     }

package/dist/{cjs/index.test.js → index.test.js}

@@ -1,6 +1,6 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { assert, expect, describe, test } from 'vitest';
-import path from 'path';
-import { fileURLToPath } from 'url';
 import { ScrabbleCheater } from './index.js';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);

package/package.json

@@ -1,25 +1,20 @@
 {
   "author": "Florian Imdahl <git@ffflorian.de>",
-  "bin": "dist/cjs/cli.js",
+  "bin": "dist/cli.js",
   "dependencies": {
     "clipboardy": "4.0.0",
     "commander": "12.1.0"
   },
   "description": "A simple Scrabble cheating tool.",
   "devDependencies": {
-    "rimraf": "5.0.7",
-    "typescript": "5.5.2",
-    "vitest": "1.6.0"
+    "rimraf": "6.0.1",
+    "typescript": "5.5.4",
+    "vitest": "2.0.5"
   },
   "engines": {
     "node": ">= 18.0"
   },
-  "exports": {
-    ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js"
-    }
-  },
+  "exports": "./dist/index.js",
   "files": [
     "dist"
   ],
@@ -30,21 +25,17 @@
     "typescript"
   ],
   "license": "GPL-3.0",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
+  "module": "dist/index.js",
   "name": "scrabble-cheater",
   "repository": "https://github.com/ffflorian/node-packages/tree/main/packages/scrabble-cheater",
   "scripts": {
-    "build": "yarn build:cjs && yarn build:esm && yarn generate:packagejson",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
-    "build:esm": "tsc -p tsconfig.json",
+    "build": "tsc -p tsconfig.json",
     "clean": "rimraf dist",
     "dist": "yarn clean && yarn build",
-    "generate:packagejson": "../../bin/generate-hybrid-package-json.sh",
     "start": "node --loader ts-node/esm src/cli.ts -d",
     "test": "vitest run"
   },
   "type": "module",
-  "version": "3.6.5",
-  "gitHead": "f7a6a79286e4eb85392b5f2d33942ab166142109"
+  "version": "3.7.0",
+  "gitHead": "f1a74d8ec9721d5b52a00e41b2ec73278e048290"
 }

package/dist/cjs/index.js

@@ -1,102 +0,0 @@
-import clipboard from 'clipboardy';
-import fs from 'fs';
-import readline from 'readline';
-import { promisify } from 'util';
-const readFileAsync = promisify(fs.readFile);
-const defaultOptions = {
-    letters: '',
-    maximum: 0,
-    quietMode: false,
-    singleMode: false,
-};
-export class ScrabbleCheater {
-    constructor(wordListPath, options) {
-        this.dictionary = [];
-        this.wordListPath = wordListPath;
-        this.options = { ...defaultOptions, ...options };
-    }
-    setLetters(letters) {
-        this.options.letters = letters;
-        return this;
-    }
-    async start() {
-        const length = await this.loadWords();
-        if (!length) {
-            throw new Error('No words loaded. Wordlist file corrupt?');
-        }
-        this.log(`${length} word${length > 1 ? 's' : ''} loaded.`);
-        const letters = this.options.letters ? this.formatLetters(this.options.letters) : await this.readLineAsync();
-        let matches = this.findMatches(letters);
-        this.log(`ScrabbleCheater: ${matches.length} matches found`, true);
-        if (this.options.maximum) {
-            this.log(`, ${this.options.singleMode ? 'sending' : 'displaying'} the first ${this.options.maximum}`, true);
-            matches = matches.slice(0, this.options.maximum);
-        }
-        this.log('.\n\n', true);
-        if (this.options.singleMode) {
-            this.singleOutput(matches);
-        }
-        return matches;
-    }
-    findMatches(letters) {
-        const regex = new RegExp(`^[${letters}]+$`);
-        return this.dictionary.filter(word => regex.test(word)).sort((wordA, wordB) => wordB.length - wordA.length);
-    }
-    formatLetters(letters) {
-        const regex = new RegExp('[^A-Za-z]');
-        return letters.replace(regex, '').toLowerCase();
-    }
-    async loadWords() {
-        const regex = new RegExp('^[A-Za-z]+$');
-        const wordList = await readFileAsync(this.wordListPath, 'utf-8');
-        this.dictionary = wordList.split('\n').filter(value => regex.test(value));
-        return this.dictionary.length;
-    }
-    log(message, raw = false) {
-        if (!this.options.quietMode) {
-            if (!raw) {
-                console.info(`ScrabbleCheater: ${message}`);
-            }
-            else {
-                process.stdout.write(message);
-            }
-        }
-    }
-    readLineAsync() {
-        return new Promise((resolve, reject) => {
-            const rl = readline.createInterface({
-                input: process.stdin,
-                output: process.stdout,
-            });
-            rl.question('Letters? ', input => {
-                const letters = this.formatLetters(input);
-                if (letters) {
-                    resolve(letters);
-                }
-                else {
-                    reject(new Error('No letters entered.'));
-                }
-                rl.close();
-            });
-        });
-    }
-    singleOutput(matches) {
-        const rl = readline.createInterface({
-            input: process.stdin,
-            output: process.stdout,
-        });
-        let counter = 0;
-        const next = () => {
-            clipboard.writeSync(matches[counter]);
-            if (counter < matches.length - 1) {
-                this.log('Press Enter to copy the next word...');
-                counter++;
-            }
-            else {
-                return rl.close();
-            }
-        };
-        rl.on('line', next);
-        next();
-    }
-}

package/dist/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/dist/esm/cli.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/esm/cli.js

@@ -1,44 +0,0 @@
-#!/usr/bin/env node
-import { program as commander } from 'commander';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-import { ScrabbleCheater } from './index.js';
-const { bin, description, version } = require('../package.json');
-commander
-    .name(Object.keys(bin)[0])
-    .version(version)
-    .description(description)
-    .option('-w, --wordlist <file>', 'Specify a wordlist file (mandatory)')
-    .option('-l, --letters <letters>', 'Specify letters')
-    .option('-q, --quiet', 'Quiet mode: displays only the letters')
-    .option('-m, --maximum <number>', 'Specify a maximum of results')
-    .option('-s, --single', 'Single word mode: displays each word and copies it to the clipboard')
-    .parse(process.argv);
-const commanderOptions = commander.opts();
-if (!commanderOptions.wordlist) {
-    console.error('  Error: no wordlist file specified.');
-    commander.help();
-}
-if (commanderOptions.maximum && !parseInt(commanderOptions.maximum, 10)) {
-    console.error('  Error: invalid maximum number specified.');
-    commander.help();
-}
-const options = {
-    ...(commanderOptions.letters && { letters: commanderOptions.letters }),
-    ...(commanderOptions.maximum && { maximum: commanderOptions.maximum }),
-    ...(commanderOptions.quiet && { quiet: commanderOptions.quiet }),
-    ...(commanderOptions.single && { single: commanderOptions.single }),
-};
-void (async () => {
-    try {
-        const matches = await new ScrabbleCheater(commanderOptions.wordlist, options).start();
-        if (matches.length && !commanderOptions.single) {
-            console.info(matches.join('\n'));
-        }
-        process.exit();
-    }
-    catch (error) {
-        console.error(error);
-        process.exit(1);
-    }
-})();

package/dist/esm/index.d.ts

@@ -1,20 +0,0 @@
-export interface Options {
-    letters?: string;
-    maximum?: number;
-    quietMode?: boolean;
-    singleMode?: boolean;
-}
-export declare class ScrabbleCheater {
-    private dictionary;
-    private readonly options;
-    private readonly wordListPath;
-    constructor(wordListPath: string, options?: Options);
-    setLetters(letters: string): ScrabbleCheater;
-    start(): Promise<string[]>;
-    private findMatches;
-    private formatLetters;
-    private loadWords;
-    private log;
-    private readLineAsync;
-    private singleOutput;
-}

package/dist/esm/index.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/index.test.js

@@ -1,27 +0,0 @@
-import { assert, expect, describe, test } from 'vitest';
-import path from 'path';
-import { fileURLToPath } from 'url';
-import { ScrabbleCheater } from './index.js';
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-const wordList = path.resolve(__dirname, '../fixtures/wordlist.txt');
-const emptyList = path.resolve(__dirname, '../fixtures/empty.txt');
-describe('ScrabbleCheater', () => {
-    test('finds all words', async () => {
-        const sc = new ScrabbleCheater(wordList, { letters: 'her', quietMode: true });
-        const matches = await sc.start();
-        expect(matches.includes('here')).toBe(true);
-        expect(matches.includes('her')).toBe(true);
-        expect(matches.includes('he')).toBe(true);
-    });
-    test(`Doesn't accept an empty file`, async () => {
-        const sc = new ScrabbleCheater(emptyList);
-        try {
-            await sc.start();
-            assert.fail();
-        }
-        catch (error) {
-            // nothing to do
-        }
-    });
-});

package/dist/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}