shogi.js 2.0.4 → 2.0.5

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.
Files changed (58) hide show
  1. package/.eslintrc.js +27 -0
  2. package/.nvmrc +1 -1
  3. package/.prettierignore +10 -0
  4. package/.prettierrc.json +5 -0
  5. package/.travis.yml +1 -1
  6. package/README.md +12 -13
  7. package/dist/shogi.js +2 -2
  8. package/dist/src/Kind.d.ts +19 -0
  9. package/dist/src/Piece.d.ts +6 -5
  10. package/dist/src/moveDefinitions.d.ts +3 -0
  11. package/dist/src/presets.d.ts +74 -0
  12. package/dist/src/shogi.d.ts +11 -11
  13. package/package.json +11 -7
  14. package/.github/workflows/gh-pages.yml +0 -33
  15. package/.idea/codeStyles/Project.xml +0 -21
  16. package/.idea/codeStyles/codeStyleConfig.xml +0 -5
  17. package/.idea/inspectionProfiles/Project_Default.xml +0 -6
  18. package/.idea/misc.xml +0 -6
  19. package/.idea/modules.xml +0 -8
  20. package/.idea/vcs.xml +0 -6
  21. package/dist/src/Constants.d.ts +0 -14
  22. package/docs/assets/css/main.css +0 -1
  23. package/docs/assets/images/icons.png +0 -0
  24. package/docs/assets/images/icons@2x.png +0 -0
  25. package/docs/assets/images/widgets.png +0 -0
  26. package/docs/assets/images/widgets@2x.png +0 -0
  27. package/docs/assets/js/main.js +0 -51
  28. package/docs/assets/js/search.js +0 -1
  29. package/docs/classes/piece.html +0 -563
  30. package/docs/classes/shogi.html +0 -1187
  31. package/docs/enums/color.html +0 -186
  32. package/docs/index.html +0 -204
  33. package/docs/interfaces/imove.html +0 -236
  34. package/docs/interfaces/imovedefinition.html +0 -186
  35. package/docs/interfaces/isettingtype.html +0 -200
  36. package/docs/modules.html +0 -149
  37. package/public/docs/assets/css/main.css +0 -1
  38. package/public/docs/assets/images/icons.png +0 -0
  39. package/public/docs/assets/images/icons@2x.png +0 -0
  40. package/public/docs/assets/images/widgets.png +0 -0
  41. package/public/docs/assets/images/widgets@2x.png +0 -0
  42. package/public/docs/assets/js/main.js +0 -51
  43. package/public/docs/assets/js/search.json +0 -1
  44. package/public/docs/classes/_piece_.piece.html +0 -576
  45. package/public/docs/classes/_shogi_.shogi.html +0 -1206
  46. package/public/docs/enums/_color_.color.html +0 -193
  47. package/public/docs/globals.html +0 -146
  48. package/public/docs/index.html +0 -227
  49. package/public/docs/interfaces/_imovedefinition_.imovedefinition.html +0 -194
  50. package/public/docs/interfaces/_shogi_.imove.html +0 -250
  51. package/public/docs/interfaces/_shogi_.isettingtype.html +0 -214
  52. package/public/docs/modules/_color_.html +0 -146
  53. package/public/docs/modules/_constants_.html +0 -1074
  54. package/public/docs/modules/_imovedefinition_.html +0 -146
  55. package/public/docs/modules/_piece_.html +0 -146
  56. package/public/docs/modules/_polyfills_.html +0 -112
  57. package/public/docs/modules/_serialization_.html +0 -262
  58. package/public/docs/modules/_shogi_.html +0 -159
package/public/docs/enums/_color_.color.html DELETED
@@ -1,193 +0,0 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>Color | shogi.js</title>
7
- <meta name="description" content="Documentation for shogi.js">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="../assets/css/main.css">
10
- </head>
11
- <body>
12
- <header>
13
- <div class="tsd-page-toolbar">
14
- <div class="container">
15
- <div class="table-wrap">
16
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
17
- <div class="field">
18
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
- <input id="tsd-search-field" type="text" />
20
- </div>
21
- <ul class="results">
22
- <li class="state loading">Preparing search index...</li>
23
- <li class="state failure">The search index is not available</li>
24
- </ul>
25
- <a href="../index.html" class="title">shogi.js</a>
26
- </div>
27
- <div class="table-cell" id="tsd-widgets">
28
- <div id="tsd-filter">
29
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
- <div class="tsd-filter-group">
31
- <div class="tsd-select" id="tsd-filter-visibility">
32
- <span class="tsd-select-label">All</span>
33
- <ul class="tsd-select-list">
34
- <li data-value="public">Public</li>
35
- <li data-value="protected">Public/Protected</li>
36
- <li data-value="private" class="selected">All</li>
37
- </ul>
38
- </div>
39
- <input type="checkbox" id="tsd-filter-inherited" checked />
40
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
- <input type="checkbox" id="tsd-filter-externals" checked />
42
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
- <input type="checkbox" id="tsd-filter-only-exported" />
44
- <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
- </div>
46
- </div>
47
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
- </div>
49
- </div>
50
- </div>
51
- </div>
52
- <div class="tsd-page-title">
53
- <div class="container">
54
- <ul class="tsd-breadcrumb">
55
- <li>
56
- <a href="../globals.html">Globals</a>
57
- </li>
58
- <li>
59
- <a href="../modules/_color_.html">&quot;Color&quot;</a>
60
- </li>
61
- <li>
62
- <a href="_color_.color.html">Color</a>
63
- </li>
64
- </ul>
65
- <h1>Enumeration Color</h1>
66
- </div>
67
- </div>
68
- </header>
69
- <div class="container container-main">
70
- <div class="row">
71
- <div class="col-8 col-content">
72
- <section class="tsd-panel tsd-comment">
73
- <div class="tsd-comment tsd-typography">
74
- <div class="lead">
75
- <p>先後番を表すクラス</p>
76
- </div>
77
- <p><code>Black</code> は先手で、 <code>White</code> は後手である．</p>
78
- </div>
79
- </section>
80
- <section class="tsd-panel-group tsd-index-group">
81
- <h2>Index</h2>
82
- <section class="tsd-panel tsd-index-panel">
83
- <div class="tsd-index-content">
84
- <section class="tsd-index-section ">
85
- <h3>Enumeration members</h3>
86
- <ul class="tsd-index-list">
87
- <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_color_.color.html#black" class="tsd-kind-icon">Black</a></li>
88
- <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_color_.color.html#white" class="tsd-kind-icon">White</a></li>
89
- </ul>
90
- </section>
91
- </div>
92
- </section>
93
- </section>
94
- <section class="tsd-panel-group tsd-member-group ">
95
- <h2>Enumeration members</h2>
96
- <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
97
- <a name="black" class="tsd-anchor"></a>
98
- <h3>Black</h3>
99
- <div class="tsd-signature tsd-kind-icon">Black<span class="tsd-signature-symbol">:</span></div>
100
- <aside class="tsd-sources">
101
- <ul>
102
- <li>Defined in <a href="https://github.com/na2hiro/Shogi.js/blob/24e2fd0/src/Color.ts#L6">Color.ts:6</a></li>
103
- </ul>
104
- </aside>
105
- </section>
106
- <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
107
- <a name="white" class="tsd-anchor"></a>
108
- <h3>White</h3>
109
- <div class="tsd-signature tsd-kind-icon">White<span class="tsd-signature-symbol">:</span></div>
110
- <aside class="tsd-sources">
111
- <ul>
112
- <li>Defined in <a href="https://github.com/na2hiro/Shogi.js/blob/24e2fd0/src/Color.ts#L6">Color.ts:6</a></li>
113
- </ul>
114
- </aside>
115
- </section>
116
- </section>
117
- </div>
118
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
119
- <nav class="tsd-navigation primary">
120
- <ul>
121
- <li class="globals ">
122
- <a href="../globals.html"><em>Globals</em></a>
123
- </li>
124
- <li class="current tsd-kind-module">
125
- <a href="../modules/_color_.html">&quot;<wbr>Color&quot;</a>
126
- </li>
127
- <li class=" tsd-kind-module">
128
- <a href="../modules/_constants_.html">&quot;<wbr>Constants&quot;</a>
129
- </li>
130
- <li class=" tsd-kind-module">
131
- <a href="../modules/_imovedefinition_.html">&quot;IMove<wbr>Definition&quot;</a>
132
- </li>
133
- <li class=" tsd-kind-module">
134
- <a href="../modules/_piece_.html">&quot;<wbr>Piece&quot;</a>
135
- </li>
136
- <li class=" tsd-kind-module">
137
- <a href="../modules/_serialization_.html">&quot;<wbr>Serialization&quot;</a>
138
- </li>
139
- <li class=" tsd-kind-module">
140
- <a href="../modules/_shogi_.html">&quot;shogi&quot;</a>
141
- </li>
142
- </ul>
143
- </nav>
144
- <nav class="tsd-navigation secondary menu-sticky">
145
- <ul class="before-current">
146
- </ul>
147
- <ul class="current">
148
- <li class="current tsd-kind-enum tsd-parent-kind-module">
149
- <a href="_color_.color.html" class="tsd-kind-icon">Color</a>
150
- <ul>
151
- <li class=" tsd-kind-enum-member tsd-parent-kind-enum">
152
- <a href="_color_.color.html#black" class="tsd-kind-icon">Black</a>
153
- </li>
154
- <li class=" tsd-kind-enum-member tsd-parent-kind-enum">
155
- <a href="_color_.color.html#white" class="tsd-kind-icon">White</a>
156
- </li>
157
- </ul>
158
- </li>
159
- </ul>
160
- <ul class="after-current">
161
- </ul>
162
- </nav>
163
- </div>
164
- </div>
165
- </div>
166
- <footer class="with-border-bottom">
167
- <div class="container">
168
- <h2>Legend</h2>
169
- <div class="tsd-legend-group">
170
- <ul class="tsd-legend">
171
- <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
172
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
173
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
174
- </ul>
175
- <ul class="tsd-legend">
176
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
177
- </ul>
178
- <ul class="tsd-legend">
179
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
180
- </ul>
181
- <ul class="tsd-legend">
182
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
183
- </ul>
184
- </div>
185
- </div>
186
- </footer>
187
- <div class="container tsd-generator">
188
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
189
- </div>
190
- <div class="overlay"></div>
191
- <script src="../assets/js/main.js"></script>
192
- </body>
193
- </html>
package/public/docs/globals.html DELETED
@@ -1,146 +0,0 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>shogi.js</title>
7
- <meta name="description" content="Documentation for shogi.js">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="assets/css/main.css">
10
- </head>
11
- <body>
12
- <header>
13
- <div class="tsd-page-toolbar">
14
- <div class="container">
15
- <div class="table-wrap">
16
- <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
17
- <div class="field">
18
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
- <input id="tsd-search-field" type="text" />
20
- </div>
21
- <ul class="results">
22
- <li class="state loading">Preparing search index...</li>
23
- <li class="state failure">The search index is not available</li>
24
- </ul>
25
- <a href="index.html" class="title">shogi.js</a>
26
- </div>
27
- <div class="table-cell" id="tsd-widgets">
28
- <div id="tsd-filter">
29
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
- <div class="tsd-filter-group">
31
- <div class="tsd-select" id="tsd-filter-visibility">
32
- <span class="tsd-select-label">All</span>
33
- <ul class="tsd-select-list">
34
- <li data-value="public">Public</li>
35
- <li data-value="protected">Public/Protected</li>
36
- <li data-value="private" class="selected">All</li>
37
- </ul>
38
- </div>
39
- <input type="checkbox" id="tsd-filter-inherited" checked />
40
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
- <input type="checkbox" id="tsd-filter-externals" checked />
42
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
- <input type="checkbox" id="tsd-filter-only-exported" />
44
- <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
- </div>
46
- </div>
47
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
- </div>
49
- </div>
50
- </div>
51
- </div>
52
- <div class="tsd-page-title">
53
- <div class="container">
54
- <ul class="tsd-breadcrumb">
55
- <li>
56
- <a href="globals.html">Globals</a>
57
- </li>
58
- </ul>
59
- <h1>shogi.js</h1>
60
- </div>
61
- </div>
62
- </header>
63
- <div class="container container-main">
64
- <div class="row">
65
- <div class="col-8 col-content">
66
- <section class="tsd-panel-group tsd-index-group">
67
- <h2>Index</h2>
68
- <section class="tsd-panel tsd-index-panel">
69
- <div class="tsd-index-content">
70
- <section class="tsd-index-section ">
71
- <h3>Modules</h3>
72
- <ul class="tsd-index-list">
73
- <li class="tsd-kind-module"><a href="modules/_color_.html" class="tsd-kind-icon">&quot;<wbr>Color&quot;</a></li>
74
- <li class="tsd-kind-module"><a href="modules/_constants_.html" class="tsd-kind-icon">&quot;<wbr>Constants&quot;</a></li>
75
- <li class="tsd-kind-module"><a href="modules/_imovedefinition_.html" class="tsd-kind-icon">&quot;IMove<wbr>Definition&quot;</a></li>
76
- <li class="tsd-kind-module"><a href="modules/_piece_.html" class="tsd-kind-icon">&quot;<wbr>Piece&quot;</a></li>
77
- <li class="tsd-kind-module"><a href="modules/_serialization_.html" class="tsd-kind-icon">&quot;<wbr>Serialization&quot;</a></li>
78
- <li class="tsd-kind-module"><a href="modules/_polyfills_.html" class="tsd-kind-icon">&quot;polyfills&quot;</a></li>
79
- <li class="tsd-kind-module"><a href="modules/_shogi_.html" class="tsd-kind-icon">&quot;shogi&quot;</a></li>
80
- </ul>
81
- </section>
82
- </div>
83
- </section>
84
- </section>
85
- </div>
86
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
87
- <nav class="tsd-navigation primary">
88
- <ul>
89
- <li class="globals current ">
90
- <a href="globals.html"><em>Globals</em></a>
91
- </li>
92
- <li class=" tsd-kind-module">
93
- <a href="modules/_color_.html">&quot;<wbr>Color&quot;</a>
94
- </li>
95
- <li class=" tsd-kind-module">
96
- <a href="modules/_constants_.html">&quot;<wbr>Constants&quot;</a>
97
- </li>
98
- <li class=" tsd-kind-module">
99
- <a href="modules/_imovedefinition_.html">&quot;IMove<wbr>Definition&quot;</a>
100
- </li>
101
- <li class=" tsd-kind-module">
102
- <a href="modules/_piece_.html">&quot;<wbr>Piece&quot;</a>
103
- </li>
104
- <li class=" tsd-kind-module">
105
- <a href="modules/_serialization_.html">&quot;<wbr>Serialization&quot;</a>
106
- </li>
107
- <li class=" tsd-kind-module">
108
- <a href="modules/_shogi_.html">&quot;shogi&quot;</a>
109
- </li>
110
- </ul>
111
- </nav>
112
- <nav class="tsd-navigation secondary menu-sticky">
113
- <ul class="before-current">
114
- </ul>
115
- </nav>
116
- </div>
117
- </div>
118
- </div>
119
- <footer class="with-border-bottom">
120
- <div class="container">
121
- <h2>Legend</h2>
122
- <div class="tsd-legend-group">
123
- <ul class="tsd-legend">
124
- <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
125
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
126
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
127
- </ul>
128
- <ul class="tsd-legend">
129
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
130
- </ul>
131
- <ul class="tsd-legend">
132
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
133
- </ul>
134
- <ul class="tsd-legend">
135
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
136
- </ul>
137
- </div>
138
- </div>
139
- </footer>
140
- <div class="container tsd-generator">
141
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
142
- </div>
143
- <div class="overlay"></div>
144
- <script src="assets/js/main.js"></script>
145
- </body>
146
- </html>
package/public/docs/index.html DELETED
@@ -1,227 +0,0 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>shogi.js</title>
7
- <meta name="description" content="Documentation for shogi.js">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="assets/css/main.css">
10
- </head>
11
- <body>
12
- <header>
13
- <div class="tsd-page-toolbar">
14
- <div class="container">
15
- <div class="table-wrap">
16
- <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
17
- <div class="field">
18
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
- <input id="tsd-search-field" type="text" />
20
- </div>
21
- <ul class="results">
22
- <li class="state loading">Preparing search index...</li>
23
- <li class="state failure">The search index is not available</li>
24
- </ul>
25
- <a href="index.html" class="title">shogi.js</a>
26
- </div>
27
- <div class="table-cell" id="tsd-widgets">
28
- <div id="tsd-filter">
29
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
- <div class="tsd-filter-group">
31
- <div class="tsd-select" id="tsd-filter-visibility">
32
- <span class="tsd-select-label">All</span>
33
- <ul class="tsd-select-list">
34
- <li data-value="public">Public</li>
35
- <li data-value="protected">Public/Protected</li>
36
- <li data-value="private" class="selected">All</li>
37
- </ul>
38
- </div>
39
- <input type="checkbox" id="tsd-filter-inherited" checked />
40
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
- <input type="checkbox" id="tsd-filter-externals" checked />
42
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
- <input type="checkbox" id="tsd-filter-only-exported" />
44
- <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
- </div>
46
- </div>
47
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
- </div>
49
- </div>
50
- </div>
51
- </div>
52
- <div class="tsd-page-title">
53
- <div class="container">
54
- <ul class="tsd-breadcrumb">
55
- <li>
56
- <a href="globals.html">Globals</a>
57
- </li>
58
- </ul>
59
- <h1>shogi.js</h1>
60
- </div>
61
- </div>
62
- </header>
63
- <div class="container container-main">
64
- <div class="row">
65
- <div class="col-8 col-content">
66
- <div class="tsd-panel tsd-typography">
67
- <a href="#shogijs-ver-20-" id="shogijs-ver-20-" style="color: inherit; text-decoration: none;">
68
- <h1>Shogi.js (Ver. 2.0) <a href="https://travis-ci.org/na2hiro/Shogi.js"><img src="https://travis-ci.org/na2hiro/Shogi.js.svg?branch=master" alt="Build Status"></a></h1>
69
- </a>
70
- <p>将棋の盤駒をモデルとするシンプルなJavaScriptライブラリ．TypeScript．</p>
71
- <a href="#インストール" id="インストール" style="color: inherit; text-decoration: none;">
72
- <h2>インストール</h2>
73
- </a>
74
- <pre><code>npm <span class="hljs-keyword">install</span> shogi.js</code></pre>
75
- <a href="#概要" id="概要" style="color: inherit; text-decoration: none;">
76
- <h2>概要</h2>
77
- </a>
78
- <ul>
79
- <li>最低限の将棋の法則に従って操作ができる．<ul>
80
- <li>局面を平手に並べることができる．</li>
81
- <li>駒を移動(move)すると，移動先の駒を取れる．</li>
82
- <li>駒を打つ(drop)ことができる．</li>
83
- <li>動作を戻すことができる．</li>
84
- </ul>
85
- </li>
86
- <li>モード(editMode)<ul>
87
- <li>通常(false)<ul>
88
- <li>手番，動きを守っているかどうかをチェック</li>
89
- <li>二歩検査</li>
90
- <li>手番を管理</li>
91
- </ul>
92
- </li>
93
- <li>編集(true): <ul>
94
- <li>手番や動きをチェックしない</li>
95
- <li>手番を変更する</li>
96
- <li>盤上の駒を駒台に載せる</li>
97
- <li>盤上の駒を裏返し・反転させる</li>
98
- </ul>
99
- </li>
100
- </ul>
101
- </li>
102
- </ul>
103
- <p>通常モードは棋譜再生および対局を，編集モードは盤面編集をモデル化するものである．</p>
104
- <a href="#クラス概要" id="クラス概要" style="color: inherit; text-decoration: none;">
105
- <h2>クラス概要</h2>
106
- </a>
107
- <p>各クラスのメソッドの概要についてはコメントを確認されたい．
108
- また，<code>test</code>ディレクトリ以下のテストで実際の挙動を確認されたい．</p>
109
- <ul>
110
- <li>class Shogi<ul>
111
- <li>将棋盤を管理するクラス</li>
112
- </ul>
113
- </li>
114
- <li>enum Color<ul>
115
- <li>Black=0, White=1</li>
116
- </ul>
117
- </li>
118
- <li>class Piece<ul>
119
- <li>駒を表すクラス</li>
120
- </ul>
121
- </li>
122
- </ul>
123
- <a href="#todo" id="todo" style="color: inherit; text-decoration: none;">
124
- <h2>TODO</h2>
125
- </a>
126
- <ul>
127
- <li>駒箱</li>
128
- </ul>
129
- <a href="#開発" id="開発" style="color: inherit; text-decoration: none;">
130
- <h2>開発</h2>
131
- </a>
132
- <a href="#準備" id="準備" style="color: inherit; text-decoration: none;">
133
- <h3>準備</h3>
134
- </a>
135
- <pre><code>$ npm <span class="hljs-keyword">install</span>
136
- </code></pre>
137
- <p>上記コマンドを実行することで開発に必要なパッケージをインストールできます．</p>
138
- <ul>
139
- <li>TypeScript 2.0</li>
140
- <li>Webpack 3 (バンドルツール)</li>
141
- <li>Browserify (JSバンドルツール)</li>
142
- <li>Jest (テストフレームワーク，カバレッジ計測)</li>
143
- <li>TSLint (Linter)</li>
144
- </ul>
145
- <a href="#コマンド" id="コマンド" style="color: inherit; text-decoration: none;">
146
- <h3>コマンド</h3>
147
- </a>
148
- <pre><code>$ npm <span class="hljs-keyword">run</span><span class="bash"> build</span>
149
- $ npm <span class="hljs-keyword">run</span><span class="bash"> build:watch</span></code></pre>
150
- <p>ビルドが走ります．<code>build:watch</code>の場合，変更されるたびにビルドが走ります．</p>
151
- <pre><code>$ npm <span class="hljs-keyword">run</span><span class="bash"> <span class="hljs-built_in">test</span>:watch</span></code></pre>
152
- <p>コンソールでテスト結果が表示されます．コードの変更が保存されるたびに必要なテストが再実行されるため，実装が既存の有効なテストを壊してないか簡単に確認できます．</p>
153
- <pre><code>$ npm <span class="hljs-keyword">run</span><span class="bash"> <span class="hljs-built_in">test</span></span></code></pre>
154
- <p>全てのテストが走るとともにカバレッジレポートが表示されます．<code>coverage/lcov-report/index.html</code>では，行ごとのカバレッジを確認できます．追加されたコードのブランチカバレッジが100%になるようにしてください．push時にチェックされ満たしていなければ却下されるはずです．</p>
155
- <pre><code>$ npm <span class="hljs-keyword">run</span><span class="bash"> lint</span></code></pre>
156
- <p>コードの品質が検査されます．エラーがあればそれに従い直してください．push前にもチェックされます．</p>
157
- <pre><code>$ npm <span class="hljs-keyword">run</span><span class="bash"> lint:fix</span></code></pre>
158
- <p>自動的に修正可能な問題(インデント等)を直してくれます．</p>
159
- <pre><code>$ npm <span class="hljs-keyword">run</span><span class="bash"> docs</span></code></pre>
160
- <p><code>docs/</code> 以下にドキュメントを生成します．</p>
161
- <a href="#license" id="license" style="color: inherit; text-decoration: none;">
162
- <h2>license</h2>
163
- </a>
164
- <p>MIT License (see LICENSE.txt)</p>
165
- </div>
166
- </div>
167
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
168
- <nav class="tsd-navigation primary">
169
- <ul>
170
- <li class="globals ">
171
- <a href="globals.html"><em>Globals</em></a>
172
- </li>
173
- <li class=" tsd-kind-module">
174
- <a href="modules/_color_.html">&quot;<wbr>Color&quot;</a>
175
- </li>
176
- <li class=" tsd-kind-module">
177
- <a href="modules/_constants_.html">&quot;<wbr>Constants&quot;</a>
178
- </li>
179
- <li class=" tsd-kind-module">
180
- <a href="modules/_imovedefinition_.html">&quot;IMove<wbr>Definition&quot;</a>
181
- </li>
182
- <li class=" tsd-kind-module">
183
- <a href="modules/_piece_.html">&quot;<wbr>Piece&quot;</a>
184
- </li>
185
- <li class=" tsd-kind-module">
186
- <a href="modules/_serialization_.html">&quot;<wbr>Serialization&quot;</a>
187
- </li>
188
- <li class=" tsd-kind-module">
189
- <a href="modules/_shogi_.html">&quot;shogi&quot;</a>
190
- </li>
191
- </ul>
192
- </nav>
193
- <nav class="tsd-navigation secondary menu-sticky">
194
- <ul class="before-current">
195
- </ul>
196
- </nav>
197
- </div>
198
- </div>
199
- </div>
200
- <footer class="with-border-bottom">
201
- <div class="container">
202
- <h2>Legend</h2>
203
- <div class="tsd-legend-group">
204
- <ul class="tsd-legend">
205
- <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
206
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
207
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
208
- </ul>
209
- <ul class="tsd-legend">
210
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
211
- </ul>
212
- <ul class="tsd-legend">
213
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
214
- </ul>
215
- <ul class="tsd-legend">
216
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
217
- </ul>
218
- </div>
219
- </div>
220
- </footer>
221
- <div class="container tsd-generator">
222
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
223
- </div>
224
- <div class="overlay"></div>
225
- <script src="assets/js/main.js"></script>
226
- </body>
227
- </html>