Kifu for JSと関連ライブラリのmonorepoです。個々のパッケージのREADMEは各パッケージのディレクトリにあります。
kifu-for-js
: Kifu for JS 将棋再生盤とブックマークレットjson-kifu-format
: JSON棋譜フォーマットと関連ライブラリshogi.js
: 将棋の盤駒を扱うライブラリこのリポジトリは、npm packagesとlernaによるmonorepo環境です。
shogi.js
<- json-kifu-format
<- kifu-for-js
<- website
shogi.js
<- kifu-for-js
nvm i && nvm use
としてnpmを用意します。(nvm が必要です。)npm install
を実行すると、各パッケージの依存関係がインストールされます。npm run dev
を実行すると、各パッケージがビルドされ、変更があると自動的にビルドが再実行されます。npm run test
でテストを一括実行します。また、個々のパッケージで変更を監視しながらテストを実行するには、個々のパッケージに移動して(例:cd /packages/Kifu-for-JS
) npm run test:watch
を実行します。npm run lint:fix
として、修正可能なものは修正しつつLintを実行します。 npm install (ライブラリ名)
を実行します。npm install (ライブラリ名) -w (インストール先パッケージ名)
を実行します。npm run ... |
説明 |
---|---|
lint |
すべてのパッケージのlintを行う |
lint:fix |
すべてのパッケージのlintを行い、修正可能なものは修正する |
test |
すべてのパッケージのテストを行う |
build |
すべてのパッケージをビルドする |
dev |
すべてのパッケージをビルドしてexampleページを起動し、変更を監視する |
website |
すべてのパッケージをビルドして公式サイトを起動し、公式サイトへの変更を監視する(ライブラリへの変更は監視しません) |
cy:open |
exampleページに対して統合テストを行う |
bump
GitHub Actions でパッケージのバージョンを上げるpublish
GitHub Actions がリリースをビルド・公開するhttps://cdn.jsdelivr.net/npm/kifu-for-js@5/bundle/kifu-for-js.min.js
https://cdn.jsdelivr.net/npm/kifu-for-js@5/bundle/public-bookmarklet.min.js