scrabble-solver 2.15.24 → 2.16.0-alpha.0

package/README.md

@@ -18,7 +18,7 @@
   </p>
 
   <p>
-    You can <a href="#run">run</a> it on your machine: <code>npx scrabble-solver@latest</code>
+    You can <a href="#run">run</a> it on your machine: <code>bunx scrabble-solver@latest</code>
   </p>
 
   <p>
@@ -41,11 +41,11 @@
 
   <p>
     <img src="https://github.com/kamilmielnik/scrabble-solver/actions/workflows/build.yml/badge.svg" alt="Build" />
-    <img src="https://github.com/kamilmielnik/scrabble-solver/actions/workflows/jest.yml/badge.svg" alt="Jest Tests" />
-    <img src="https://github.com/kamilmielnik/scrabble-solver/actions/workflows/cypress.yml/badge.svg" alt="Cypress Tests" />
-    <img src="https://github.com/kamilmielnik/scrabble-solver/actions/workflows/eslint.yml/badge.svg" alt="ESLint" />
-    <img src="https://github.com/kamilmielnik/scrabble-solver/actions/workflows/oxfmt.yml/badge.svg" alt="oxfmt" />
-    <img src="https://github.com/kamilmielnik/scrabble-solver/actions/workflows/npx.yml/badge.svg" alt="npx" />
+    <img src="https://github.com/kamilmielnik/scrabble-solver/actions/workflows/oxlint.yml/badge.svg" alt="Oxlint" />
+    <img src="https://github.com/kamilmielnik/scrabble-solver/actions/workflows/oxfmt.yml/badge.svg" alt="Oxfmt" />
+    <img src="https://github.com/kamilmielnik/scrabble-solver/actions/workflows/e2e-tests.yml/badge.svg" alt="E2E tests" />
+    <img src="https://github.com/kamilmielnik/scrabble-solver/actions/workflows/unit-tests.yml/badge.svg" alt="Unit tests" />
+    <img src="https://github.com/kamilmielnik/scrabble-solver/actions/workflows/bunx.yml/badge.svg" alt="bunx" />
   </p>
 
   <img alt="Screencast GIF showing user interface when solving for oxyphenbutazone, which is a top-scoring word in English version of Scrabble" src="https://raw.githubusercontent.com/kamilmielnik/scrabble-solver/master/screencast.gif" />
@@ -70,6 +70,8 @@
 
 ## Dictionaries
 
+Some of the word lists below are sourced from the companion repository [kamilmielnik/scrabble-dictionaries](https://github.com/kamilmielnik/scrabble-dictionaries).
+
 | Language    | Word list                                                                                                                                                                                               | Word definitions                                     | [Highest-scoring word](https://codesandbox.io/s/highest-scoring-words-in-scrabble-vbj1ns?file=/src/index.js) |
 | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
 | 🇬🇧 English  | [💾](https://raw.githubusercontent.com/kamilmielnik/scrabble-dictionaries/refs/heads/master/english/sowpods.txt) [SOWPODS](https://en.wikipedia.org/wiki/Collins_Scrabble_Words)                        | [Merriam-Webster](https://www.merriam-webster.com/)  | oxyphenbutazone (1458)                                                                                       |
@@ -84,10 +86,10 @@
 
 ## Run
 
-You can run Scrabble Solver on your machine - all you need is [Node.js](https://nodejs.org/) 24 or later.
+You can run Scrabble Solver on your machine - all you need is [Bun](https://bun.sh/) 1.3 or later.
 
 ```Shell
-npx scrabble-solver@latest
+bunx scrabble-solver@latest
 ```
 
 Give it a while to install and download dictionaries. When it's done it will automatically open http://localhost:3333/ in your browser.
@@ -114,8 +116,8 @@ One-time project setup.
 ```Shell
 git clone https://github.com/kamilmielnik/scrabble-solver.git
 cd scrabble-solver
-npm install
-npm run build
+bun install
+bun run build
 ```
 
 ### Run app dev server
@@ -123,7 +125,7 @@ npm run build
 The following command will serve the app at http://localhost:3000/.
 
 ```Shell
-npm run dev
+bun run dev
 ```
 
 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)).
@@ -131,7 +133,7 @@ Note: hot code reload works only for the [`scrabble-solver`](https://github.com/
 ### Rebuild the entire project
 
 ```Shell
-npm run build
+bun run build
 ```
 
 ### Rebuild a single package
@@ -139,15 +141,15 @@ npm run build
 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
-npm run build -w @scrabble-solver/dictionaries
-npm run build -w @scrabble-solver/logger
-npm run build -w @scrabble-solver/scrabble-solver
-npm run build -w @scrabble-solver/solver
-npm run build -w @scrabble-solver/types
-npm run build -w @scrabble-solver/word-definitions
-npm run build -w @scrabble-solver/word-lists
+bun run --filter @scrabble-solver/configs build
+bun run --filter @scrabble-solver/constants build
+bun run --filter @scrabble-solver/dictionaries build
+bun run --filter @scrabble-solver/logger build
+bun run --filter @scrabble-solver/scrabble-solver build
+bun run --filter @scrabble-solver/solver build
+bun run --filter @scrabble-solver/types build
+bun run --filter @scrabble-solver/word-definitions build
+bun run --filter @scrabble-solver/word-lists build
 ```
 
 ### Add a new language
@@ -159,7 +161,7 @@ npm run build -w @scrabble-solver/word-lists
 4. Add IETF language tag for the new locale in [packages/types/src/Locale.ts](https://github.com/kamilmielnik/scrabble-solver/blob/master/packages/types/src/Locale.ts)
 5. Rebuild the types package
    ```Shell
-   npm run build -w @scrabble-solver/types
+   bun run --filter @scrabble-solver/types build
    ```
 6. Add locale configuration in [packages/scrabble-solver/src/i18n/constants.ts](https://github.com/kamilmielnik/scrabble-solver/blob/master/packages/scrabble-solver/src/i18n/constants.ts)
 7. Update locale-detecting code in [packages/scrabble-solver/src/state/settings/lib.ts](https://github.com/kamilmielnik/scrabble-solver/blob/master/packages/scrabble-solver/src/state/settings/lib.ts)
@@ -177,6 +179,7 @@ npm run build -w @scrabble-solver/word-lists
 ## Tech stack
 
 - [TypeScript](https://www.typescriptlang.org/)
+- [Bun](https://bun.sh/docs)
 - [Node.js](https://nodejs.org/)
 - [Next.js](https://nextjs.org/)
 - [Express](https://expressjs.com/)
@@ -190,9 +193,8 @@ npm run build -w @scrabble-solver/word-lists
 - [include-media](https://eduardoboucas.github.io/include-media/)
 - [Lerna](https://lerna.js.org/)
 - [Cypress](https://www.cypress.io/)
-- [Jest](https://jestjs.io/)
-- [ESLint](https://eslint.org/)
-- [oxfmt](https://oxc.rs/docs/guide/usage/formatter)
+- [Oxlint](https://oxc.rs/docs/guide/usage/linter)
+- [Oxfmt](https://oxc.rs/docs/guide/usage/formatter)
 
 ## Related projects
 

package/bin/scrabble-solver.js

@@ -5,4 +5,4 @@ const path = require('path');
 
 const rootDirectory = path.join(__dirname, '..');
 process.chdir(rootDirectory);
-execSync('npm start');
+execSync('bun start');

package/bump-version.js

@@ -1,8 +1,8 @@
 /**
- * Due to the use of npm workspaces we need to explicitly specify "@scrabble-solver/scrabble-solver"
+ * Due to the use of Bun workspaces we need to explicitly specify "@scrabble-solver/scrabble-solver"
  * package in the dependencies of this very "scrabble-solver" package. Otherwise none of
- * the "dependencies" from underlying packages/ would have been installed and any npm scripts
- * that work on subpackages would not work - specifically: npm start.
+ * the "dependencies" from underlying packages/ would have been installed and any package scripts
+ * that work on subpackages would not work - specifically: bun start.
  *
  * This script exists to ensure that the dependency version is bumped during the release.
  */
@@ -24,4 +24,3 @@ const updateDependencyVersion = (filename, dependency, version) => {
 
 const currentAppVersion = getCurrentAppVersion();
 updateDependencyVersion('package.json', '@scrabble-solver/scrabble-solver', currentAppVersion);
-updateDependencyVersion('package-lock.json', '@scrabble-solver/scrabble-solver', currentAppVersion);

package/bun-test-globals.d.ts

@@ -0,0 +1 @@
+/// <reference types="bun-types/test-globals" />