@wheelofnames/lib

Wheel of Names lib

This package contains some common utilities used by the https://wheelofnames.com web client, the Wheel of Names API, Discord bot, as well as various other tools. This package is likely useless to you if you are not a Wheel of Names developer.

Contents

• Wheel (and Wheel2) classes
• WheelConfig class
• standardizeWheelConfig function
• WheelPainter (web-only) class
• hubSizes object
• ImageUtil functions
• WheelEntry, WheelType, HubSize, ApiWheel, ShareMode types

Developing

This package is part of the Wheel of Names monorepo, which is private. Everything below this point is only useful for those with access to the repo.

Install dev dependencies with npm i.

Testing

npx playwright install --with-deps # only needs to be done once
npm run test

Developing lib and client together

To test local changes to lib in the client and backend, npm uninstall @wheelofnames/lib in their respective directories, then add "@wheelofnames/lib": "file:../lib", to their package.json and run npm i. When you update any code in lib, run npm run build in the lib directory. The client will detect the file change and do a hot reload.

You switch between the two lib versions with these two scripts in the client directory:

• npm run locallib
• npm run globallib

Don't forget to run npm run globallib before committing, since local dependencies don't work in CI/CD.

Publishing

Publish a new version:

npm run publish:patch # or minor/major