@pai-forge/riichi-mahjong
v0.3.1
Published
Riichi Mahjong Logic Library
Downloads
468
Readme
Riichi Mahjong Library
リーチ麻雀のロジック(シャンテン数計算、点数計算など)を提供するTypeScriptライブラリです。
[!NOTE] This package is Pure ESM. Please use
import(notrequire) to use this library. 本パッケージは Pure ESM です。利用する際はrequireではなくimportを使用してください。
前提条件 (Prerequisites)
開発やテスト実行には以下のツールが必要です。
- Node.js: v20.0.0 以上
- Docker: 受け入れテスト(リファレンス実装との比較)を実行する場合は必要
セットアップ (Setup)
依存パッケージをインストールします。
npm install @pai-forge/riichi-mahjongテストの実行 (Running Tests)
ユニットテスト (Unit Tests)
src ディレクトリ内の主要なロジックに対するユニットテストを実行します。
npm testまたは
npx vitest src受け入れテスト (Acceptance Tests)
Pythonの mahjong ライブラリをリファレンス実装として使用し、計算結果の相互検証を行います。
実行時に自動的に検証用のDockerイメージ (riichi-mahjong-verifier) がビルドされます。
npx vitest tests/acceptance特定のテストファイルのみを実行する場合:
npx vitest tests/acceptance/shanten.test.tsその他のコマンド (Other Commands)
- ビルド:
npm run build - リント:
npm run lint - フォーマット:
npm run format
