shogi.js 3.1.1-alpha.0 → 3.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -56
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
# Shogi.js
|
|
1
|
+
# Shogi.js  [](https://opensource.org/licenses/MIT) [](https://badge.fury.io/js/shogi.js)
|
|
2
|
+
|
|
2
3
|
将棋の盤駒をモデルとするシンプルなJavaScriptライブラリ．TypeScript．
|
|
3
4
|
|
|
4
5
|
## インストール
|
|
@@ -31,63 +32,11 @@ npm install shogi.js
|
|
|
31
32
|
[TypeDoc ドキュメンテーション](https://apps.81.la/Kifu-for-JS/shogi.js/docs/) を参照のこと。
|
|
32
33
|
また，`test`ディレクトリ以下のテストで実際の挙動を確認されたい．
|
|
33
34
|
|
|
34
|
-
##
|
|
35
|
-
https://github.com/na2hiro/
|
|
35
|
+
## バグ・要望等
|
|
36
|
+
https://github.com/na2hiro/Kifu-for-JS/issues へお寄せください
|
|
36
37
|
|
|
37
38
|
## 開発
|
|
38
|
-
|
|
39
|
-
### 準備
|
|
40
|
-
|
|
41
|
-
```shell
|
|
42
|
-
$ nvm i && nvm use && npm install
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
上記コマンドを実行することで開発に必要なパッケージをインストールできます．
|
|
46
|
-
|
|
47
|
-
* TypeScript
|
|
48
|
-
* Webpack (バンドルツール)
|
|
49
|
-
* Jest (テストフレームワーク，カバレッジ計測)
|
|
50
|
-
* TSLint (Linter)
|
|
51
|
-
|
|
52
|
-
### コマンド
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
```shell
|
|
56
|
-
$ npm run build
|
|
57
|
-
$ npm run build:watch
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
ビルドが走ります．`build:watch`の場合，変更されるたびにビルドが走ります．
|
|
61
|
-
|
|
62
|
-
```shell
|
|
63
|
-
$ npm run test:watch
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
コンソールでテスト結果が表示されます．コードの変更が保存されるたびに必要なテストが再実行されるため，実装が既存の有効なテストを壊してないか簡単に確認できます．
|
|
67
|
-
|
|
68
|
-
```shell
|
|
69
|
-
$ npm run test
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
全てのテストが走るとともにカバレッジレポートが表示されます．`coverage/lcov-report/index.html`では，行ごとのカバレッジを確認できます．追加されたコードのブランチカバレッジが100%になるようにしてください．push時にチェックされ満たしていなければ却下されるはずです．
|
|
73
|
-
|
|
74
|
-
```shell
|
|
75
|
-
$ npm run lint
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
コードの品質が検査されます．エラーがあればそれに従い直してください．push前にもチェックされます．
|
|
79
|
-
|
|
80
|
-
```shell
|
|
81
|
-
$ npm run lint:fix
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
自動的に修正可能な問題(インデント等)を直してくれます．
|
|
85
|
-
|
|
86
|
-
```shell
|
|
87
|
-
$ npm run docs
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
`docs/` 以下にドキュメントを生成します．
|
|
39
|
+
[monorepoトップのREADME](../../README.md#開発)をご覧ください。
|
|
91
40
|
|
|
92
41
|
## license
|
|
93
42
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "shogi.js",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.2.0",
|
|
4
4
|
"description": "simple shogi library for JavaScript",
|
|
5
5
|
"main": "dist/shogi.js",
|
|
6
6
|
"types": "dist/src/shogi.d.ts",
|
|
@@ -33,9 +33,9 @@
|
|
|
33
33
|
"bugs": {
|
|
34
34
|
"url": "https://github.com/na2hiro/Shogi.js/issues"
|
|
35
35
|
},
|
|
36
|
-
"homepage": "https://github.com/na2hiro/
|
|
36
|
+
"homepage": "https://github.com/na2hiro/Kifu-for-JS/tree/master/packages/shogi.js#readme",
|
|
37
37
|
"devDependencies": {
|
|
38
38
|
"ts-jest": "^27.1.3"
|
|
39
39
|
},
|
|
40
|
-
"gitHead": "
|
|
40
|
+
"gitHead": "860fe96a8510c946576f8bb984f4d98a81eba1fe"
|
|
41
41
|
}
|