scrabble-solver 2.13.7 → 2.13.9

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2022 Kamil Mielnik <kamil@kamilmielnik.com>
+Copyright (c) 2024 Kamil Mielnik <kamil@kamilmielnik.com>
 
 Attribution-NonCommercial-NoDerivatives 4.0 International
 

package/README.md

@@ -17,6 +17,10 @@
     Available at <a href="https://scrabble-solver.org">https://scrabble-solver.org</a> in 8 languages.
   </p>
 
+  <p>
+    Run it on your machine: <code>npx scrabble-solver@latest</code>
+  </p>
+
   <p>
     <img height="32" src="https://raw.githubusercontent.com/twitter/twemoji/master/assets/svg/1f1ec-1f1e7.svg" alt="Flag of United Kingdom" title="English (GB)" />
     <img height="32" src="https://raw.githubusercontent.com/twitter/twemoji/master/assets/svg/1f1fa-1f1f8.svg" alt="Flag of United States" title="English (US)" />
@@ -49,16 +53,16 @@
 
 1. [Dictionaries](#dictionaries)
 2. [Run](#run)
-3. [Install](#install)
-4. [Uninstall](#uninstall)
-5. [Develop](#develop)
+3. [Uninstall](#uninstall)
+4. [Develop](#develop)
     1. [Setup](#setup)
     2. [Run app dev server](#run-app-dev-server)
-    3. [Rebuild a single package](#rebuild-a-single-package)
-    4. [Add a new language](#add-a-new-language)
-6. [Tech stack](#tech-stack)
-7. [Related projects](#related-projects)
-8. [Media](#media)
+    3. [Rebuild the entire project](#rebuild-the-entire-project)
+    4. [Rebuild a single package](#rebuild-a-single-package)
+    5. [Add a new language](#add-a-new-language)
+5. [Tech stack](#tech-stack)
+6. [Related projects](#related-projects)
+7. [Media](#media)
 
 ## Dictionaries
 
@@ -81,51 +85,54 @@ You can run Scrabble Solver on your machine - all you need is [Node.js](https://
 npx scrabble-solver@latest
 ```
 
-## Install
+Give it a while to install and download dictionaries. When it's done it will automatically open http://localhost:3333/ in your browser.
 
-```Shell
-npm install -g scrabble-solver
-
-# and then run anytime with:
-scrabble-solver
-```
+Hit <kbd>Ctrl</kbd> + <kbd>C</kbd> in your terminal to exit the app.
 
 ## Uninstall
 
-```Shell
-npm uninstall -g scrabble-solver
+Dictionaries and logs are stored in `$HOME/.scrabble-solver`.
+`$HOME` location is acquired using [`os.homedir()`](https://nodejs.org/api/os.html#oshomedir).
 
-# Logs and dictionaries are stored in $HOME/.scrabble-solver
-# $HOME location is acquired using os.homedir()
+```Shell
 rm -rf $HOME/.scrabble-solver
 ```
 
 ## Develop
 
+These steps are required only if you want to make changes to the source code.
+
 ### Setup
 
+One-time project setup.
+
 ```Shell
+git clone https://github.com/kamilmielnik/scrabble-solver.git
+cd scrabble-solver
 npm install
 npm run build
 ```
 
 ### Run app dev server
 
+The following command will serve the app at http://localhost:3000/.
+
 ```Shell
-npm run dev -w @scrabble-solver/scrabble-solver
+npm run dev
 ```
 
-or
+Note: hot code reload works only for the [`scrabble-solver`](https://github.com/kamilmielnik/scrabble-solver/tree/master/packages/scrabble-solver) package. If you make changes to any other package, you will need to rebuild it ([see below](#rebuild-a-single-package)).
+
+### Rebuild the entire project
 
 ```Shell
-cd packages/scrabble-solver
-npm run dev
+npm run build
 ```
 
-Note: hot code reload works only for the [`scrabble-solver`](https://github.com/kamilmielnik/scrabble-solver/tree/master/packages/scrabble-solver) package.
-
 ### Rebuild a single package
 
+For convenience, here's a list of commands to rebuild every package individually.
+
 ```Shell
 npm run build -w @scrabble-solver/configs
 npm run build -w @scrabble-solver/constants

package/jest.setup.js

@@ -1,6 +1,6 @@
 const POLISH_DICTIONARY_AVERAGE_DOWNLOAD_DURATION = 90 * 1000;
 
-// Dictionaries used in test are downloaded on demand (if not cached)
+// Dictionaries used in tests are downloaded on demand (if not cached)
 // and on average it takes 90 seconds to get the Polish dictionary downloaded.
 // Doubling that amount should be safe enough.
 jest.setTimeout(2 * POLISH_DICTIONARY_AVERAGE_DOWNLOAD_DURATION);

package/lerna.json

@@ -6,5 +6,5 @@
     "access": "public"
   },
   "tagVersionPrefix": "",
-  "version": "2.13.7"
+  "version": "2.13.9"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scrabble-solver",
-  "version": "2.13.7",
+  "version": "2.13.9",
   "description": "Scrabble Solver 2 - Free, open-source, and cross-platform analysis tool for Scrabble, Super Scrabble & Literaki. Quickly find top scoring words using given letters and board state. Available in English, French, German, Polish & Spanish.",
   "keywords": [
     "Scrabble",
@@ -36,6 +36,7 @@
   "scripts": {
     "build": "npm run build -w packages",
     "clean": "npm run clean -w packages && rimraf node_modules/",
+    "dev": "npm run dev -w @scrabble-solver/scrabble-solver",
     "lint": "eslint packages/*",
     "lint:fix": "npm run lint -- --fix",
     "prettier": "prettier --check './**/*.{js,ts,tsx,scss}'",
@@ -80,7 +81,7 @@
     "packages/scrabble-solver"
   ],
   "dependencies": {
-    "@scrabble-solver/scrabble-solver": "^2.13.7",
+    "@scrabble-solver/scrabble-solver": "^2.13.9",
     "npm-run-all": "^4.1.5",
     "open-cli": "^8.0.0"
   },
@@ -90,10 +91,10 @@
     "@babel/preset-env": "^7.24.7",
     "@types/jest": "^29.5.12",
     "@types/node": "^20.14.2",
-    "@typescript-eslint/eslint-plugin": "^7.12.0",
-    "@typescript-eslint/parser": "^7.12.0",
+    "@typescript-eslint/eslint-plugin": "^7.13.0",
+    "@typescript-eslint/parser": "^7.13.0",
     "babel-eslint": "10.1.0",
-    "eslint": "^8.56.0",
+    "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-node": "^0.3.9",
     "eslint-plugin-import": "^2.29.1",
@@ -103,7 +104,7 @@
     "jest": "29.7.0",
     "lerna": "^8.1.3",
     "np": "^10.0.5",
-    "prettier": "^3.3.1",
+    "prettier": "^3.3.2",
     "rimraf": "^5.0.7",
     "ts-jest": "^29.1.4",
     "typescript": "^5.4.5"

package/packages/configs/build/languages/english.js

@@ -1,4 +1,5 @@
 "use strict";
+/* eslint-disable max-lines */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.englishUsLiteraki = exports.englishUsSuperScrabble = exports.englishUsScrabble = exports.englishGbLiteraki = exports.englishGbSuperScrabble = exports.englishGbScrabble = void 0;
 const types_1 = require("@scrabble-solver/types");

package/packages/configs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scrabble-solver/configs",
-  "version": "2.13.7",
+  "version": "2.13.9",
   "description": "Scrabble Solver 2 - Configs",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -23,8 +23,8 @@
     "clean": "rimraf build/"
   },
   "dependencies": {
-    "@scrabble-solver/constants": "^2.13.7",
-    "@scrabble-solver/types": "^2.13.7"
+    "@scrabble-solver/constants": "^2.13.9",
+    "@scrabble-solver/types": "^2.13.9"
   },
   "gitHead": "1e2d1ad49a288d4a44196d8e3336740da132c637"
 }

package/packages/configs/src/languages/english.ts

@@ -1,3 +1,5 @@
+/* eslint-disable max-lines */
+
 import { Config, Locale } from '@scrabble-solver/types';
 
 import { literaki, scrabble, superScrabble } from '../games';

package/packages/constants/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scrabble-solver/constants",
-  "version": "2.13.7",
+  "version": "2.13.9",
   "description": "Scrabble Solver 2 - Constants",
   "main": "build/index.js",
   "types": "build/index.d.ts",

package/packages/dictionaries/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@scrabble-solver/dictionaries",
-  "version": "2.13.7",
+  "version": "2.13.9",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@scrabble-solver/dictionaries",
-      "version": "2.13.7",
+      "version": "2.13.9",
       "license": "CC-BY-NC-ND-4.0",
       "dependencies": {
         "@kamilmielnik/trie": "^3.0.0"

package/packages/dictionaries/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scrabble-solver/dictionaries",
-  "version": "2.13.7",
+  "version": "2.13.9",
   "description": "Scrabble Solver 2 - Dictionaries",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -30,9 +30,9 @@
   },
   "dependencies": {
     "@kamilmielnik/trie": "^3.0.0",
-    "@scrabble-solver/logger": "^2.13.7",
-    "@scrabble-solver/types": "^2.13.7",
-    "@scrabble-solver/word-lists": "^2.13.7"
+    "@scrabble-solver/logger": "^2.13.9",
+    "@scrabble-solver/types": "^2.13.9",
+    "@scrabble-solver/word-lists": "^2.13.9"
   },
   "gitHead": "1e2d1ad49a288d4a44196d8e3336740da132c637"
 }

package/packages/logger/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@scrabble-solver/logger",
-  "version": "2.13.7",
+  "version": "2.13.9",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@scrabble-solver/logger",
-      "version": "2.13.7",
+      "version": "2.13.9",
       "license": "CC-BY-NC-ND-4.0",
       "dependencies": {
         "winston": "^3.13.0"

package/packages/logger/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scrabble-solver/logger",
-  "version": "2.13.7",
+  "version": "2.13.9",
   "description": "Scrabble Solver 2 - Logger",
   "main": "build/index.js",
   "types": "build/index.d.ts",

package/packages/scrabble-solver/.next/BUILD_ID

@@ -1 +1 @@
-QbBIK_mEs1LhYSpQwv6rZ
+eLvYNd4B2hzSgBZ_PuZcQ

package/packages/scrabble-solver/.next/build-manifest.json

@@ -5,35 +5,35 @@
   "devFiles": [],
   "ampDevFiles": [],
   "lowPriorityFiles": [
-    "static/QbBIK_mEs1LhYSpQwv6rZ/_buildManifest.js",
-    "static/QbBIK_mEs1LhYSpQwv6rZ/_ssgManifest.js"
+    "static/eLvYNd4B2hzSgBZ_PuZcQ/_buildManifest.js",
+    "static/eLvYNd4B2hzSgBZ_PuZcQ/_ssgManifest.js"
   ],
   "rootMainFiles": [],
   "pages": {
     "/": [
       "static/chunks/webpack-6ef43a8d4a395f49.js",
       "static/chunks/framework-c623a49d0bf89652.js",
-      "static/chunks/main-6e708370ad13b1f9.js",
-      "static/css/11366b7489cf90ac.css",
-      "static/chunks/pages/index-710b5c27542027be.js"
+      "static/chunks/main-b5b360c6afb66b05.js",
+      "static/css/6682db14f926d4c7.css",
+      "static/chunks/pages/index-36c448d585a58425.js"
     ],
     "/404": [
       "static/chunks/webpack-6ef43a8d4a395f49.js",
       "static/chunks/framework-c623a49d0bf89652.js",
-      "static/chunks/main-6e708370ad13b1f9.js",
-      "static/chunks/pages/404-9d5621b1ca024a45.js"
+      "static/chunks/main-b5b360c6afb66b05.js",
+      "static/chunks/pages/404-01653a877b233143.js"
     ],
     "/_app": [
       "static/chunks/webpack-6ef43a8d4a395f49.js",
       "static/chunks/framework-c623a49d0bf89652.js",
-      "static/chunks/main-6e708370ad13b1f9.js",
-      "static/css/fe70298e6f597553.css",
-      "static/chunks/pages/_app-7bc3bf713c40526a.js"
+      "static/chunks/main-b5b360c6afb66b05.js",
+      "static/css/841a5b5f0b2fb131.css",
+      "static/chunks/pages/_app-735b5863675c1b5d.js"
     ],
     "/_error": [
       "static/chunks/webpack-6ef43a8d4a395f49.js",
       "static/chunks/framework-c623a49d0bf89652.js",
-      "static/chunks/main-6e708370ad13b1f9.js",
+      "static/chunks/main-b5b360c6afb66b05.js",
       "static/chunks/pages/_error-6f16571cf9224b25.js"
     ]
   },