brick-engine-js 1.0.26 → 1.0.28

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 (67) hide show
  1. package/dist/css/game.bundle.css +5 -0
  2. package/dist/docs/GAME_DEVELOPER_GUIDE.html +2271 -662
  3. package/dist/docs/brick-engine-guide.html +2238 -609
  4. package/dist/docs/documentation_style_guide.html +2698 -973
  5. package/dist/docs/getting-started.html +2192 -574
  6. package/dist/docs/index.html +2278 -608
  7. package/dist/docs/jsdoc_standard.html +2235 -617
  8. package/dist/docs/publishing.html +2196 -572
  9. package/dist/docs/reference/bootstrap.html +2172 -555
  10. package/dist/docs/reference/context/RendererContext.html +2220 -582
  11. package/dist/docs/reference/enums/Color.html +2152 -538
  12. package/dist/docs/reference/enums/ControlEventType.html +2108 -506
  13. package/dist/docs/reference/enums/ControlKey.html +2144 -530
  14. package/dist/docs/reference/enums/EventSuffix.html +2121 -514
  15. package/dist/docs/reference/enums/FontAlignment.html +2157 -546
  16. package/dist/docs/reference/enums/FontSize.html +2122 -518
  17. package/dist/docs/reference/enums/Sound.html +2210 -559
  18. package/dist/docs/reference/enums/StateProperty.html +2131 -526
  19. package/dist/docs/reference/helpers/CellHelper.html +2135 -523
  20. package/dist/docs/reference/helpers/ControlInputHandlerHelper.html +2204 -572
  21. package/dist/docs/reference/helpers/CoordinateHelper.html +2377 -681
  22. package/dist/docs/reference/helpers/RelativeValuesHelper.html +2165 -553
  23. package/dist/docs/reference/interfaces/Debuggable.html +2103 -502
  24. package/dist/docs/reference/interfaces/GameModules.html +2203 -550
  25. package/dist/docs/reference/interfaces/Initializable.html +2093 -496
  26. package/dist/docs/reference/interfaces/RendererInitializable.html +2125 -518
  27. package/dist/docs/reference/interfaces/StateContext.html +2133 -518
  28. package/dist/docs/reference/interfaces/StateSyncable.html +2154 -543
  29. package/dist/docs/reference/interfaces/modules/Control.html +2353 -649
  30. package/dist/docs/reference/interfaces/modules/Grid.html +3202 -1277
  31. package/dist/docs/reference/interfaces/modules/Renderer.html +2140 -523
  32. package/dist/docs/reference/interfaces/modules/RendererComposite.html +2209 -578
  33. package/dist/docs/reference/interfaces/modules/Score.html +2326 -670
  34. package/dist/docs/reference/interfaces/modules/Session.html +2333 -660
  35. package/dist/docs/reference/interfaces/modules/State.html +2651 -898
  36. package/dist/docs/reference/interfaces/modules/Text.html +2362 -669
  37. package/dist/docs/reference/interfaces/modules/Time.html +2418 -739
  38. package/dist/docs/reference/modules/Debugger.html +2206 -578
  39. package/dist/docs/reference/modules/DisplayRenderer.html +2186 -558
  40. package/dist/docs/reference/modules/EventEmitter.html +2321 -631
  41. package/dist/docs/reference/modules/Game.html +2544 -808
  42. package/dist/docs/reference/modules/GameControl.html +2745 -879
  43. package/dist/docs/reference/modules/GameEventRegistry.html +2226 -587
  44. package/dist/docs/reference/modules/GameGrid.html +4236 -1967
  45. package/dist/docs/reference/modules/GameHudGrid.html +2103 -503
  46. package/dist/docs/reference/modules/GameRenderer.html +2247 -590
  47. package/dist/docs/reference/modules/GameScore.html +2383 -695
  48. package/dist/docs/reference/modules/GameSession.html +2232 -580
  49. package/dist/docs/reference/modules/GameSound.html +2300 -637
  50. package/dist/docs/reference/modules/GameState.html +2846 -1032
  51. package/dist/docs/reference/modules/GameText.html +2427 -702
  52. package/dist/docs/reference/modules/GameTime.html +2460 -763
  53. package/dist/docs/reference/modules/HudRenderer.html +2205 -569
  54. package/dist/docs/reference/modules/InitialStateSnapshot.html +2185 -561
  55. package/dist/docs/reference/modules/SessionModal.html +2145 -521
  56. package/dist/docs/reference/types/Axis.html +2102 -506
  57. package/dist/docs/reference/types/Cell.html +2124 -515
  58. package/dist/docs/reference/types/ControlCallback.html +2084 -489
  59. package/dist/docs/reference/types/Coordinate.html +2110 -511
  60. package/dist/docs/reference/types/GameEvent.html +2123 -515
  61. package/dist/docs/reference/types/RendererMetrics.html +2133 -515
  62. package/dist/docs/reference/types/Vector.html +2111 -510
  63. package/dist/docs/reference/view/GameView.html +2282 -613
  64. package/dist/docs/testing_best_practices.html +2338 -699
  65. package/dist/game.bundle.js +1 -1
  66. package/dist/types/view/components/layout/FrameLayout.d.ts +1 -1
  67. package/package.json +1 -1
@@ -1,599 +1,2214 @@
1
- <!DOCTYPE html>
1
+ <!doctype html>
2
2
  <html lang="en">
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
7
- <meta name="generator" content="Asciidoctor 2.0.20">
8
- <title>Testing Best Practices with Vitest</title>
9
- <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
10
- <style>
11
- /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
12
- /* Uncomment the following line when using as a custom stylesheet */
13
- /* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
14
- html{font-family:sans-serif;-webkit-text-size-adjust:100%}
15
- a{background:none}
16
- a:focus{outline:thin dotted}
17
- a:active,a:hover{outline:0}
18
- h1{font-size:2em;margin:.67em 0}
19
- b,strong{font-weight:bold}
20
- abbr{font-size:.9em}
21
- abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
22
- dfn{font-style:italic}
23
- hr{height:0}
24
- mark{background:#ff0;color:#000}
25
- code,kbd,pre,samp{font-family:monospace;font-size:1em}
26
- pre{white-space:pre-wrap}
27
- q{quotes:"\201C" "\201D" "\2018" "\2019"}
28
- small{font-size:80%}
29
- sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
30
- sup{top:-.5em}
31
- sub{bottom:-.25em}
32
- img{border:0}
33
- svg:not(:root){overflow:hidden}
34
- figure{margin:0}
35
- audio,video{display:inline-block}
36
- audio:not([controls]){display:none;height:0}
37
- fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
38
- legend{border:0;padding:0}
39
- button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
40
- button,input{line-height:normal}
41
- button,select{text-transform:none}
42
- button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
43
- button[disabled],html input[disabled]{cursor:default}
44
- input[type=checkbox],input[type=radio]{padding:0}
45
- button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
46
- textarea{overflow:auto;vertical-align:top}
47
- table{border-collapse:collapse;border-spacing:0}
48
- *,::before,::after{box-sizing:border-box}
49
- html,body{font-size:100%}
50
- body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
51
- a:hover{cursor:pointer}
52
- img,object,embed{max-width:100%;height:auto}
53
- object,embed{height:100%}
54
- img{-ms-interpolation-mode:bicubic}
55
- .left{float:left!important}
56
- .right{float:right!important}
57
- .text-left{text-align:left!important}
58
- .text-right{text-align:right!important}
59
- .text-center{text-align:center!important}
60
- .text-justify{text-align:justify!important}
61
- .hide{display:none}
62
- img,object,svg{display:inline-block;vertical-align:middle}
63
- textarea{height:auto;min-height:50px}
64
- select{width:100%}
65
- .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
66
- div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
67
- a{color:#2156a5;text-decoration:underline;line-height:inherit}
68
- a:hover,a:focus{color:#1d4b8f}
69
- a img{border:0}
70
- p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
71
- p aside{font-size:.875em;line-height:1.35;font-style:italic}
72
- h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
73
- h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
74
- h1{font-size:2.125em}
75
- h2{font-size:1.6875em}
76
- h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
77
- h4,h5{font-size:1.125em}
78
- h6{font-size:1em}
79
- hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
80
- em,i{font-style:italic;line-height:inherit}
81
- strong,b{font-weight:bold;line-height:inherit}
82
- small{font-size:60%;line-height:inherit}
83
- code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
84
- ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
85
- ul,ol{margin-left:1.5em}
86
- ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
87
- ul.circle{list-style-type:circle}
88
- ul.disc{list-style-type:disc}
89
- ul.square{list-style-type:square}
90
- ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
91
- ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
92
- dl dt{margin-bottom:.3125em;font-weight:bold}
93
- dl dd{margin-bottom:1.25em}
94
- blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
95
- blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
96
- @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
97
- h1{font-size:2.75em}
98
- h2{font-size:2.3125em}
99
- h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
100
- h4{font-size:1.4375em}}
101
- table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
102
- table thead,table tfoot{background:#f7f8f7}
103
- table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
104
- table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
105
- table tr.even,table tr.alt{background:#f8f8f7}
106
- table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
107
- h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
108
- h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
109
- .center{margin-left:auto;margin-right:auto}
110
- .stretch{width:100%}
111
- .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
112
- .clearfix::after,.float-group::after{clear:both}
113
- :not(pre).nobreak{word-wrap:normal}
114
- :not(pre).nowrap{white-space:nowrap}
115
- :not(pre).pre-wrap{white-space:pre-wrap}
116
- :not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
117
- pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
118
- pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
119
- pre>code{display:block}
120
- pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
121
- em em{font-style:normal}
122
- strong strong{font-weight:400}
123
- .keyseq{color:rgba(51,51,51,.8)}
124
- kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
125
- .keyseq kbd:first-child{margin-left:0}
126
- .keyseq kbd:last-child{margin-right:0}
127
- .menuseq,.menuref{color:#000}
128
- .menuseq b:not(.caret),.menuref{font-weight:inherit}
129
- .menuseq{word-spacing:-.02em}
130
- .menuseq b.caret{font-size:1.25em;line-height:.8}
131
- .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
132
- b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
133
- b.button::before{content:"[";padding:0 3px 0 2px}
134
- b.button::after{content:"]";padding:0 2px 0 3px}
135
- p a>code:hover{color:rgba(0,0,0,.9)}
136
- #header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
137
- #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
138
- #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
139
- #content{margin-top:1.25em}
140
- #content::before{content:none}
141
- #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
142
- #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
143
- #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
144
- #header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
145
- #header .details span:first-child{margin-left:-.125em}
146
- #header .details span.email a{color:rgba(0,0,0,.85)}
147
- #header .details br{display:none}
148
- #header .details br+span::before{content:"\00a0\2013\00a0"}
149
- #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
150
- #header .details br+span#revremark::before{content:"\00a0|\00a0"}
151
- #header #revnumber{text-transform:capitalize}
152
- #header #revnumber::after{content:"\00a0"}
153
- #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
154
- #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
155
- #toc>ul{margin-left:.125em}
156
- #toc ul.sectlevel0>li>a{font-style:italic}
157
- #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
158
- #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
159
- #toc li{line-height:1.3334;margin-top:.3334em}
160
- #toc a{text-decoration:none}
161
- #toc a:active{text-decoration:underline}
162
- #toctitle{color:#7a2518;font-size:1.2em}
163
- @media screen and (min-width:768px){#toctitle{font-size:1.375em}
164
- body.toc2{padding-left:15em;padding-right:0}
165
- #toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
166
- #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
167
- #toc.toc2>ul{font-size:.9em;margin-bottom:0}
168
- #toc.toc2 ul ul{margin-left:0;padding-left:1em}
169
- #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
170
- body.toc2.toc-right{padding-left:0;padding-right:15em}
171
- body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
172
- @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
173
- #toc.toc2{width:20em}
174
- #toc.toc2 #toctitle{font-size:1.375em}
175
- #toc.toc2>ul{font-size:.95em}
176
- #toc.toc2 ul ul{padding-left:1.25em}
177
- body.toc2.toc-right{padding-left:0;padding-right:20em}}
178
- #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
179
- #content #toc>:first-child{margin-top:0}
180
- #content #toc>:last-child{margin-bottom:0}
181
- #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
182
- #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
183
- #content{margin-bottom:.625em}
184
- .sect1{padding-bottom:.625em}
185
- @media screen and (min-width:768px){#content{margin-bottom:1.25em}
186
- .sect1{padding-bottom:1.25em}}
187
- .sect1:last-child{padding-bottom:0}
188
- .sect1+.sect1{border-top:1px solid #e7e7e9}
189
- #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
190
- #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
191
- #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
192
- #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
193
- #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
194
- details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
195
- details{margin-left:1.25rem}
196
- details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
197
- details>summary::-webkit-details-marker{display:none}
198
- details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
199
- details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
200
- details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
201
- .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
202
- table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
203
- .paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
204
- .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
205
- .admonitionblock>table td.icon{text-align:center;width:80px}
206
- .admonitionblock>table td.icon img{max-width:none}
207
- .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
208
- .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
209
- .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
210
- .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
211
- .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
212
- .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
213
- .exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
214
- .exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
215
- .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
216
- @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
217
- @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
218
- .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
219
- .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
220
- .listingblock>.content{position:relative}
221
- .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
222
- .listingblock:hover code[data-lang]::before{display:block}
223
- .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
224
- .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
225
- .listingblock pre.highlightjs{padding:0}
226
- .listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
227
- .listingblock pre.prettyprint{border-width:0}
228
- .prettyprint{background:#f7f7f8}
229
- pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
230
- pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
231
- pre.prettyprint li code[data-lang]::before{opacity:1}
232
- pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
233
- table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
234
- table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
235
- table.linenotable td.code{padding-left:.75em}
236
- table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
237
- pre.pygments span.linenos{display:inline-block;margin-right:.75em}
238
- .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
239
- .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
240
- .quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
241
- .quoteblock blockquote{margin:0;padding:0;border:0}
242
- .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
243
- .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
244
- .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
245
- .verseblock{margin:0 1em 1.25em}
246
- .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
247
- .verseblock pre strong{font-weight:400}
248
- .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
249
- .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
250
- .quoteblock .attribution br,.verseblock .attribution br{display:none}
251
- .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
252
- .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
253
- .quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
254
- .quoteblock.abstract{margin:0 1em 1.25em;display:block}
255
- .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
256
- .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
257
- .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
258
- .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
259
- .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
260
- p.tableblock:last-child{margin-bottom:0}
261
- td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
262
- td.tableblock>.content>:last-child{margin-bottom:-1.25em}
263
- table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
264
- table.grid-all>*>tr>*{border-width:1px}
265
- table.grid-cols>*>tr>*{border-width:0 1px}
266
- table.grid-rows>*>tr>*{border-width:1px 0}
267
- table.frame-all{border-width:1px}
268
- table.frame-ends{border-width:1px 0}
269
- table.frame-sides{border-width:0 1px}
270
- table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
271
- table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
272
- table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
273
- table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
274
- table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
275
- th.halign-left,td.halign-left{text-align:left}
276
- th.halign-right,td.halign-right{text-align:right}
277
- th.halign-center,td.halign-center{text-align:center}
278
- th.valign-top,td.valign-top{vertical-align:top}
279
- th.valign-bottom,td.valign-bottom{vertical-align:bottom}
280
- th.valign-middle,td.valign-middle{vertical-align:middle}
281
- table thead th,table tfoot th{font-weight:bold}
282
- tbody tr th{background:#f7f8f7}
283
- tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
284
- p.tableblock>code:only-child{background:none;padding:0}
285
- p.tableblock{font-size:1em}
286
- ol{margin-left:1.75em}
287
- ul li ol{margin-left:1.5em}
288
- dl dd{margin-left:1.125em}
289
- dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
290
- li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
291
- ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
292
- ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
293
- ul.unstyled,ol.unstyled{margin-left:0}
294
- li>p:empty:only-child::before{content:"";display:inline-block}
295
- ul.checklist>li>p:first-child{margin-left:-1em}
296
- ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
297
- ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
298
- ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
299
- ul.inline>li{margin-left:1.25em}
300
- .unstyled dl dt{font-weight:400;font-style:normal}
301
- ol.arabic{list-style-type:decimal}
302
- ol.decimal{list-style-type:decimal-leading-zero}
303
- ol.loweralpha{list-style-type:lower-alpha}
304
- ol.upperalpha{list-style-type:upper-alpha}
305
- ol.lowerroman{list-style-type:lower-roman}
306
- ol.upperroman{list-style-type:upper-roman}
307
- ol.lowergreek{list-style-type:lower-greek}
308
- .hdlist>table,.colist>table{border:0;background:none}
309
- .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
310
- td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
311
- td.hdlist1{font-weight:bold;padding-bottom:1.25em}
312
- td.hdlist2{word-wrap:anywhere}
313
- .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
314
- .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
315
- .colist td:not([class]):first-child img{max-width:none}
316
- .colist td:not([class]):last-child{padding:.25em 0}
317
- .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
318
- .imageblock.left{margin:.25em .625em 1.25em 0}
319
- .imageblock.right{margin:.25em 0 1.25em .625em}
320
- .imageblock>.title{margin-bottom:0}
321
- .imageblock.thumb,.imageblock.th{border-width:6px}
322
- .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
323
- .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
324
- .image.left{margin-right:.625em}
325
- .image.right{margin-left:.625em}
326
- a.image{text-decoration:none;display:inline-block}
327
- a.image object{pointer-events:none}
328
- sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
329
- sup.footnote a,sup.footnoteref a{text-decoration:none}
330
- sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
331
- #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
332
- #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
333
- #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
334
- #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
335
- #footnotes .footnote:last-of-type{margin-bottom:0}
336
- #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
337
- div.unbreakable{page-break-inside:avoid}
338
- .big{font-size:larger}
339
- .small{font-size:smaller}
340
- .underline{text-decoration:underline}
341
- .overline{text-decoration:overline}
342
- .line-through{text-decoration:line-through}
343
- .aqua{color:#00bfbf}
344
- .aqua-background{background:#00fafa}
345
- .black{color:#000}
346
- .black-background{background:#000}
347
- .blue{color:#0000bf}
348
- .blue-background{background:#0000fa}
349
- .fuchsia{color:#bf00bf}
350
- .fuchsia-background{background:#fa00fa}
351
- .gray{color:#606060}
352
- .gray-background{background:#7d7d7d}
353
- .green{color:#006000}
354
- .green-background{background:#007d00}
355
- .lime{color:#00bf00}
356
- .lime-background{background:#00fa00}
357
- .maroon{color:#600000}
358
- .maroon-background{background:#7d0000}
359
- .navy{color:#000060}
360
- .navy-background{background:#00007d}
361
- .olive{color:#606000}
362
- .olive-background{background:#7d7d00}
363
- .purple{color:#600060}
364
- .purple-background{background:#7d007d}
365
- .red{color:#bf0000}
366
- .red-background{background:#fa0000}
367
- .silver{color:#909090}
368
- .silver-background{background:#bcbcbc}
369
- .teal{color:#006060}
370
- .teal-background{background:#007d7d}
371
- .white{color:#bfbfbf}
372
- .white-background{background:#fafafa}
373
- .yellow{color:#bfbf00}
374
- .yellow-background{background:#fafa00}
375
- span.icon>.fa{cursor:default}
376
- a span.icon>.fa{cursor:inherit}
377
- .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
378
- .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
379
- .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
380
- .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
381
- .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
382
- .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
383
- .conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
384
- .conum[data-value] *{color:#fff!important}
385
- .conum[data-value]+b{display:none}
386
- .conum[data-value]::after{content:attr(data-value)}
387
- pre .conum[data-value]{position:relative;top:-.125em}
388
- b.conum *{color:inherit!important}
389
- .conum:not([data-value]):empty{display:none}
390
- dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
391
- h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
392
- p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
393
- p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
394
- p{margin-bottom:1.25rem}
395
- .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
396
- .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
397
- .print-only{display:none!important}
398
- @page{margin:1.25cm .75cm}
399
- @media print{*{box-shadow:none!important;text-shadow:none!important}
400
- html{font-size:80%}
401
- a{color:inherit!important;text-decoration:underline!important}
402
- a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
403
- a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
404
- abbr[title]{border-bottom:1px dotted}
405
- abbr[title]::after{content:" (" attr(title) ")"}
406
- pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
407
- thead{display:table-header-group}
408
- svg{max-width:100%}
409
- p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
410
- h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
411
- #header,#content,#footnotes,#footer{max-width:none}
412
- #toc,.sidebarblock,.exampleblock>.content{background:none!important}
413
- #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
414
- body.book #header{text-align:center}
415
- body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
416
- body.book #header .details{border:0!important;display:block;padding:0!important}
417
- body.book #header .details span:first-child{margin-left:0!important}
418
- body.book #header .details br{display:block}
419
- body.book #header .details br+span::before{content:none!important}
420
- body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
421
- body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
422
- .listingblock code[data-lang]::before{display:block}
423
- #footer{padding:0 .9375em}
424
- .hide-on-print{display:none!important}
425
- .print-only{display:block!important}
426
- .hide-for-print{display:none!important}
427
- .show-for-print{display:inherit!important}}
428
- @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
429
- .sect1{padding:0!important}
430
- .sect1+.sect1{border:0}
431
- #footer{background:none}
432
- #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
433
- @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
434
- </style>
435
- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
436
- </head>
437
- <body class="article toc2 toc-left">
438
- <div id="header">
439
- <h1>Testing Best Practices with Vitest</h1>
440
- <div id="toc" class="toc2">
441
- <div id="toctitle">Table of Contents</div>
442
- <ul class="sectlevel1">
443
- <li><a href="#_core_pattern_triple_a_aaa">Core Pattern: Triple A (AAA)</a>
444
- <ul class="sectlevel2">
445
- <li><a href="#_arrange">[ARRANGE]</a></li>
446
- <li><a href="#_act">[ACT]</a></li>
447
- <li><a href="#_assert">[ASSERT]</a></li>
448
- </ul>
449
- </li>
450
- <li><a href="#_naming_conventions">Naming Conventions</a></li>
451
- <li><a href="#_ai_assisted_testing_best_practices">AI-Assisted Testing Best Practices</a></li>
452
- <li><a href="#_vitest_configuration_standard">Vitest Configuration Standard</a></li>
453
- <li><a href="#_advanced_mocking_stubs">Advanced Mocking &amp; Stubs</a>
454
- <ul class="sectlevel2">
455
- <li><a href="#_mocking_browser_apis">Mocking Browser APIs</a></li>
456
- <li><a href="#_constructible_mocks">Constructible Mocks</a></li>
457
- <li><a href="#_hoisted_variables">Hoisted Variables</a></li>
458
- </ul>
459
- </li>
460
- <li><a href="#_testing_entry_points_main_ts">Testing Entry Points (main.ts)</a>
461
- <ul class="sectlevel2">
462
- <li><a href="#_workaround_for_dynamic_imports_with_webpackts_ts1323">Workaround for Dynamic Imports with Webpack/TS (TS1323)</a></li>
463
- </ul>
464
- </li>
465
- <li><a href="#_eslint_type_safety_in_tests">ESLint &amp; Type Safety in Tests</a></li>
466
- <li><a href="#_example_testing_a_grid_engine">Example: Testing a Grid Engine</a></li>
467
- </ul>
468
- </div>
469
- </div>
470
- <div id="content">
471
- <div id="preamble">
472
- <div class="sectionbody">
473
- <div class="paragraph">
474
- <p>This document defines the standards and best practices for unit testing in the Brick Engine project using <strong>Vitest</strong>. It is designed to be easily parsed by both developers and AI assistants.</p>
475
- </div>
476
- </div>
477
- </div>
478
- <div class="sect1">
479
- <h2 id="_core_pattern_triple_a_aaa">Core Pattern: Triple A (AAA)</h2>
480
- <div class="sectionbody">
481
- <div class="paragraph">
482
- <p>All tests must follow the <strong>Arrange, Act, Assert</strong> pattern. Use explicit comments to demarcate these phases, as this helps AI models understand the test logic context.</p>
483
- </div>
484
- <div class="sect2">
485
- <h3 id="_arrange">[ARRANGE]</h3>
486
- <div class="paragraph">
487
- <p>Set up the test environment, prepare data, and initialize the object under test.</p>
488
- </div>
489
- <div class="listingblock">
490
- <div class="content">
491
- <pre class="highlight"><code class="language-typescript" data-lang="typescript">// [ARRANGE]
3
+ <head>
4
+ <meta charset="UTF-8" />
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge" />
6
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
7
+ <meta name="generator" content="Asciidoctor 2.0.20" />
8
+ <title>Testing Best Practices with Vitest</title>
9
+ <link
10
+ rel="stylesheet"
11
+ href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"
12
+ />
13
+ <style>
14
+ /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
15
+ /* Uncomment the following line when using as a custom stylesheet */
16
+ /* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
17
+ html {
18
+ font-family: sans-serif;
19
+ -webkit-text-size-adjust: 100%;
20
+ }
21
+ a {
22
+ background: none;
23
+ }
24
+ a:focus {
25
+ outline: thin dotted;
26
+ }
27
+ a:active,
28
+ a:hover {
29
+ outline: 0;
30
+ }
31
+ h1 {
32
+ font-size: 2em;
33
+ margin: 0.67em 0;
34
+ }
35
+ b,
36
+ strong {
37
+ font-weight: bold;
38
+ }
39
+ abbr {
40
+ font-size: 0.9em;
41
+ }
42
+ abbr[title] {
43
+ cursor: help;
44
+ border-bottom: 1px dotted #dddddf;
45
+ text-decoration: none;
46
+ }
47
+ dfn {
48
+ font-style: italic;
49
+ }
50
+ hr {
51
+ height: 0;
52
+ }
53
+ mark {
54
+ background: #ff0;
55
+ color: #000;
56
+ }
57
+ code,
58
+ kbd,
59
+ pre,
60
+ samp {
61
+ font-family: monospace;
62
+ font-size: 1em;
63
+ }
64
+ pre {
65
+ white-space: pre-wrap;
66
+ }
67
+ q {
68
+ quotes: '\201C' '\201D' '\2018' '\2019';
69
+ }
70
+ small {
71
+ font-size: 80%;
72
+ }
73
+ sub,
74
+ sup {
75
+ font-size: 75%;
76
+ line-height: 0;
77
+ position: relative;
78
+ vertical-align: baseline;
79
+ }
80
+ sup {
81
+ top: -0.5em;
82
+ }
83
+ sub {
84
+ bottom: -0.25em;
85
+ }
86
+ img {
87
+ border: 0;
88
+ }
89
+ svg:not(:root) {
90
+ overflow: hidden;
91
+ }
92
+ figure {
93
+ margin: 0;
94
+ }
95
+ audio,
96
+ video {
97
+ display: inline-block;
98
+ }
99
+ audio:not([controls]) {
100
+ display: none;
101
+ height: 0;
102
+ }
103
+ fieldset {
104
+ border: 1px solid silver;
105
+ margin: 0 2px;
106
+ padding: 0.35em 0.625em 0.75em;
107
+ }
108
+ legend {
109
+ border: 0;
110
+ padding: 0;
111
+ }
112
+ button,
113
+ input,
114
+ select,
115
+ textarea {
116
+ font-family: inherit;
117
+ font-size: 100%;
118
+ margin: 0;
119
+ }
120
+ button,
121
+ input {
122
+ line-height: normal;
123
+ }
124
+ button,
125
+ select {
126
+ text-transform: none;
127
+ }
128
+ button,
129
+ html input[type='button'],
130
+ input[type='reset'],
131
+ input[type='submit'] {
132
+ -webkit-appearance: button;
133
+ cursor: pointer;
134
+ }
135
+ button[disabled],
136
+ html input[disabled] {
137
+ cursor: default;
138
+ }
139
+ input[type='checkbox'],
140
+ input[type='radio'] {
141
+ padding: 0;
142
+ }
143
+ button::-moz-focus-inner,
144
+ input::-moz-focus-inner {
145
+ border: 0;
146
+ padding: 0;
147
+ }
148
+ textarea {
149
+ overflow: auto;
150
+ vertical-align: top;
151
+ }
152
+ table {
153
+ border-collapse: collapse;
154
+ border-spacing: 0;
155
+ }
156
+ *,
157
+ ::before,
158
+ ::after {
159
+ box-sizing: border-box;
160
+ }
161
+ html,
162
+ body {
163
+ font-size: 100%;
164
+ }
165
+ body {
166
+ background: #fff;
167
+ color: rgba(0, 0, 0, 0.8);
168
+ padding: 0;
169
+ margin: 0;
170
+ font-family: 'Noto Serif', 'DejaVu Serif', serif;
171
+ line-height: 1;
172
+ position: relative;
173
+ cursor: auto;
174
+ -moz-tab-size: 4;
175
+ -o-tab-size: 4;
176
+ tab-size: 4;
177
+ word-wrap: anywhere;
178
+ -moz-osx-font-smoothing: grayscale;
179
+ -webkit-font-smoothing: antialiased;
180
+ }
181
+ a:hover {
182
+ cursor: pointer;
183
+ }
184
+ img,
185
+ object,
186
+ embed {
187
+ max-width: 100%;
188
+ height: auto;
189
+ }
190
+ object,
191
+ embed {
192
+ height: 100%;
193
+ }
194
+ img {
195
+ -ms-interpolation-mode: bicubic;
196
+ }
197
+ .left {
198
+ float: left !important;
199
+ }
200
+ .right {
201
+ float: right !important;
202
+ }
203
+ .text-left {
204
+ text-align: left !important;
205
+ }
206
+ .text-right {
207
+ text-align: right !important;
208
+ }
209
+ .text-center {
210
+ text-align: center !important;
211
+ }
212
+ .text-justify {
213
+ text-align: justify !important;
214
+ }
215
+ .hide {
216
+ display: none;
217
+ }
218
+ img,
219
+ object,
220
+ svg {
221
+ display: inline-block;
222
+ vertical-align: middle;
223
+ }
224
+ textarea {
225
+ height: auto;
226
+ min-height: 50px;
227
+ }
228
+ select {
229
+ width: 100%;
230
+ }
231
+ .subheader,
232
+ .admonitionblock td.content > .title,
233
+ .audioblock > .title,
234
+ .exampleblock > .title,
235
+ .imageblock > .title,
236
+ .listingblock > .title,
237
+ .literalblock > .title,
238
+ .stemblock > .title,
239
+ .openblock > .title,
240
+ .paragraph > .title,
241
+ .quoteblock > .title,
242
+ table.tableblock > .title,
243
+ .verseblock > .title,
244
+ .videoblock > .title,
245
+ .dlist > .title,
246
+ .olist > .title,
247
+ .ulist > .title,
248
+ .qlist > .title,
249
+ .hdlist > .title {
250
+ line-height: 1.45;
251
+ color: #7a2518;
252
+ font-weight: 400;
253
+ margin-top: 0;
254
+ margin-bottom: 0.25em;
255
+ }
256
+ div,
257
+ dl,
258
+ dt,
259
+ dd,
260
+ ul,
261
+ ol,
262
+ li,
263
+ h1,
264
+ h2,
265
+ h3,
266
+ #toctitle,
267
+ .sidebarblock > .content > .title,
268
+ h4,
269
+ h5,
270
+ h6,
271
+ pre,
272
+ form,
273
+ p,
274
+ blockquote,
275
+ th,
276
+ td {
277
+ margin: 0;
278
+ padding: 0;
279
+ }
280
+ a {
281
+ color: #2156a5;
282
+ text-decoration: underline;
283
+ line-height: inherit;
284
+ }
285
+ a:hover,
286
+ a:focus {
287
+ color: #1d4b8f;
288
+ }
289
+ a img {
290
+ border: 0;
291
+ }
292
+ p {
293
+ line-height: 1.6;
294
+ margin-bottom: 1.25em;
295
+ text-rendering: optimizeLegibility;
296
+ }
297
+ p aside {
298
+ font-size: 0.875em;
299
+ line-height: 1.35;
300
+ font-style: italic;
301
+ }
302
+ h1,
303
+ h2,
304
+ h3,
305
+ #toctitle,
306
+ .sidebarblock > .content > .title,
307
+ h4,
308
+ h5,
309
+ h6 {
310
+ font-family: 'Open Sans', 'DejaVu Sans', sans-serif;
311
+ font-weight: 300;
312
+ font-style: normal;
313
+ color: #ba3925;
314
+ text-rendering: optimizeLegibility;
315
+ margin-top: 1em;
316
+ margin-bottom: 0.5em;
317
+ line-height: 1.0125em;
318
+ }
319
+ h1 small,
320
+ h2 small,
321
+ h3 small,
322
+ #toctitle small,
323
+ .sidebarblock > .content > .title small,
324
+ h4 small,
325
+ h5 small,
326
+ h6 small {
327
+ font-size: 60%;
328
+ color: #e99b8f;
329
+ line-height: 0;
330
+ }
331
+ h1 {
332
+ font-size: 2.125em;
333
+ }
334
+ h2 {
335
+ font-size: 1.6875em;
336
+ }
337
+ h3,
338
+ #toctitle,
339
+ .sidebarblock > .content > .title {
340
+ font-size: 1.375em;
341
+ }
342
+ h4,
343
+ h5 {
344
+ font-size: 1.125em;
345
+ }
346
+ h6 {
347
+ font-size: 1em;
348
+ }
349
+ hr {
350
+ border: solid #dddddf;
351
+ border-width: 1px 0 0;
352
+ clear: both;
353
+ margin: 1.25em 0 1.1875em;
354
+ }
355
+ em,
356
+ i {
357
+ font-style: italic;
358
+ line-height: inherit;
359
+ }
360
+ strong,
361
+ b {
362
+ font-weight: bold;
363
+ line-height: inherit;
364
+ }
365
+ small {
366
+ font-size: 60%;
367
+ line-height: inherit;
368
+ }
369
+ code {
370
+ font-family: 'Droid Sans Mono', 'DejaVu Sans Mono', monospace;
371
+ font-weight: 400;
372
+ color: rgba(0, 0, 0, 0.9);
373
+ }
374
+ ul,
375
+ ol,
376
+ dl {
377
+ line-height: 1.6;
378
+ margin-bottom: 1.25em;
379
+ list-style-position: outside;
380
+ font-family: inherit;
381
+ }
382
+ ul,
383
+ ol {
384
+ margin-left: 1.5em;
385
+ }
386
+ ul li ul,
387
+ ul li ol {
388
+ margin-left: 1.25em;
389
+ margin-bottom: 0;
390
+ }
391
+ ul.circle {
392
+ list-style-type: circle;
393
+ }
394
+ ul.disc {
395
+ list-style-type: disc;
396
+ }
397
+ ul.square {
398
+ list-style-type: square;
399
+ }
400
+ ul.circle ul:not([class]),
401
+ ul.disc ul:not([class]),
402
+ ul.square ul:not([class]) {
403
+ list-style: inherit;
404
+ }
405
+ ol li ul,
406
+ ol li ol {
407
+ margin-left: 1.25em;
408
+ margin-bottom: 0;
409
+ }
410
+ dl dt {
411
+ margin-bottom: 0.3125em;
412
+ font-weight: bold;
413
+ }
414
+ dl dd {
415
+ margin-bottom: 1.25em;
416
+ }
417
+ blockquote {
418
+ margin: 0 0 1.25em;
419
+ padding: 0.5625em 1.25em 0 1.1875em;
420
+ border-left: 1px solid #ddd;
421
+ }
422
+ blockquote,
423
+ blockquote p {
424
+ line-height: 1.6;
425
+ color: rgba(0, 0, 0, 0.85);
426
+ }
427
+ @media screen and (min-width: 768px) {
428
+ h1,
429
+ h2,
430
+ h3,
431
+ #toctitle,
432
+ .sidebarblock > .content > .title,
433
+ h4,
434
+ h5,
435
+ h6 {
436
+ line-height: 1.2;
437
+ }
438
+ h1 {
439
+ font-size: 2.75em;
440
+ }
441
+ h2 {
442
+ font-size: 2.3125em;
443
+ }
444
+ h3,
445
+ #toctitle,
446
+ .sidebarblock > .content > .title {
447
+ font-size: 1.6875em;
448
+ }
449
+ h4 {
450
+ font-size: 1.4375em;
451
+ }
452
+ }
453
+ table {
454
+ background: #fff;
455
+ margin-bottom: 1.25em;
456
+ border: 1px solid #dedede;
457
+ word-wrap: normal;
458
+ }
459
+ table thead,
460
+ table tfoot {
461
+ background: #f7f8f7;
462
+ }
463
+ table thead tr th,
464
+ table thead tr td,
465
+ table tfoot tr th,
466
+ table tfoot tr td {
467
+ padding: 0.5em 0.625em 0.625em;
468
+ font-size: inherit;
469
+ color: rgba(0, 0, 0, 0.8);
470
+ text-align: left;
471
+ }
472
+ table tr th,
473
+ table tr td {
474
+ padding: 0.5625em 0.625em;
475
+ font-size: inherit;
476
+ color: rgba(0, 0, 0, 0.8);
477
+ }
478
+ table tr.even,
479
+ table tr.alt {
480
+ background: #f8f8f7;
481
+ }
482
+ table thead tr th,
483
+ table tfoot tr th,
484
+ table tbody tr td,
485
+ table tr td,
486
+ table tfoot tr td {
487
+ line-height: 1.6;
488
+ }
489
+ h1,
490
+ h2,
491
+ h3,
492
+ #toctitle,
493
+ .sidebarblock > .content > .title,
494
+ h4,
495
+ h5,
496
+ h6 {
497
+ line-height: 1.2;
498
+ word-spacing: -0.05em;
499
+ }
500
+ h1 strong,
501
+ h2 strong,
502
+ h3 strong,
503
+ #toctitle strong,
504
+ .sidebarblock > .content > .title strong,
505
+ h4 strong,
506
+ h5 strong,
507
+ h6 strong {
508
+ font-weight: 400;
509
+ }
510
+ .center {
511
+ margin-left: auto;
512
+ margin-right: auto;
513
+ }
514
+ .stretch {
515
+ width: 100%;
516
+ }
517
+ .clearfix::before,
518
+ .clearfix::after,
519
+ .float-group::before,
520
+ .float-group::after {
521
+ content: ' ';
522
+ display: table;
523
+ }
524
+ .clearfix::after,
525
+ .float-group::after {
526
+ clear: both;
527
+ }
528
+ :not(pre).nobreak {
529
+ word-wrap: normal;
530
+ }
531
+ :not(pre).nowrap {
532
+ white-space: nowrap;
533
+ }
534
+ :not(pre).pre-wrap {
535
+ white-space: pre-wrap;
536
+ }
537
+ :not(pre):not([class^='L']) > code {
538
+ font-size: 0.9375em;
539
+ font-style: normal !important;
540
+ letter-spacing: 0;
541
+ padding: 0.1em 0.5ex;
542
+ word-spacing: -0.15em;
543
+ background: #f7f7f8;
544
+ border-radius: 4px;
545
+ line-height: 1.45;
546
+ text-rendering: optimizeSpeed;
547
+ }
548
+ pre {
549
+ color: rgba(0, 0, 0, 0.9);
550
+ font-family: 'Droid Sans Mono', 'DejaVu Sans Mono', monospace;
551
+ line-height: 1.45;
552
+ text-rendering: optimizeSpeed;
553
+ }
554
+ pre code,
555
+ pre pre {
556
+ color: inherit;
557
+ font-size: inherit;
558
+ line-height: inherit;
559
+ }
560
+ pre > code {
561
+ display: block;
562
+ }
563
+ pre.nowrap,
564
+ pre.nowrap pre {
565
+ white-space: pre;
566
+ word-wrap: normal;
567
+ }
568
+ em em {
569
+ font-style: normal;
570
+ }
571
+ strong strong {
572
+ font-weight: 400;
573
+ }
574
+ .keyseq {
575
+ color: rgba(51, 51, 51, 0.8);
576
+ }
577
+ kbd {
578
+ font-family: 'Droid Sans Mono', 'DejaVu Sans Mono', monospace;
579
+ display: inline-block;
580
+ color: rgba(0, 0, 0, 0.8);
581
+ font-size: 0.65em;
582
+ line-height: 1.45;
583
+ background: #f7f7f7;
584
+ border: 1px solid #ccc;
585
+ border-radius: 3px;
586
+ box-shadow:
587
+ 0 1px 0 rgba(0, 0, 0, 0.2),
588
+ inset 0 0 0 0.1em #fff;
589
+ margin: 0 0.15em;
590
+ padding: 0.2em 0.5em;
591
+ vertical-align: middle;
592
+ position: relative;
593
+ top: -0.1em;
594
+ white-space: nowrap;
595
+ }
596
+ .keyseq kbd:first-child {
597
+ margin-left: 0;
598
+ }
599
+ .keyseq kbd:last-child {
600
+ margin-right: 0;
601
+ }
602
+ .menuseq,
603
+ .menuref {
604
+ color: #000;
605
+ }
606
+ .menuseq b:not(.caret),
607
+ .menuref {
608
+ font-weight: inherit;
609
+ }
610
+ .menuseq {
611
+ word-spacing: -0.02em;
612
+ }
613
+ .menuseq b.caret {
614
+ font-size: 1.25em;
615
+ line-height: 0.8;
616
+ }
617
+ .menuseq i.caret {
618
+ font-weight: bold;
619
+ text-align: center;
620
+ width: 0.45em;
621
+ }
622
+ b.button::before,
623
+ b.button::after {
624
+ position: relative;
625
+ top: -1px;
626
+ font-weight: 400;
627
+ }
628
+ b.button::before {
629
+ content: '[';
630
+ padding: 0 3px 0 2px;
631
+ }
632
+ b.button::after {
633
+ content: ']';
634
+ padding: 0 2px 0 3px;
635
+ }
636
+ p a > code:hover {
637
+ color: rgba(0, 0, 0, 0.9);
638
+ }
639
+ #header,
640
+ #content,
641
+ #footnotes,
642
+ #footer {
643
+ width: 100%;
644
+ margin: 0 auto;
645
+ max-width: 62.5em;
646
+ *zoom: 1;
647
+ position: relative;
648
+ padding-left: 0.9375em;
649
+ padding-right: 0.9375em;
650
+ }
651
+ #header::before,
652
+ #header::after,
653
+ #content::before,
654
+ #content::after,
655
+ #footnotes::before,
656
+ #footnotes::after,
657
+ #footer::before,
658
+ #footer::after {
659
+ content: ' ';
660
+ display: table;
661
+ }
662
+ #header::after,
663
+ #content::after,
664
+ #footnotes::after,
665
+ #footer::after {
666
+ clear: both;
667
+ }
668
+ #content {
669
+ margin-top: 1.25em;
670
+ }
671
+ #content::before {
672
+ content: none;
673
+ }
674
+ #header > h1:first-child {
675
+ color: rgba(0, 0, 0, 0.85);
676
+ margin-top: 2.25rem;
677
+ margin-bottom: 0;
678
+ }
679
+ #header > h1:first-child + #toc {
680
+ margin-top: 8px;
681
+ border-top: 1px solid #dddddf;
682
+ }
683
+ #header > h1:only-child,
684
+ body.toc2 #header > h1:nth-last-child(2) {
685
+ border-bottom: 1px solid #dddddf;
686
+ padding-bottom: 8px;
687
+ }
688
+ #header .details {
689
+ border-bottom: 1px solid #dddddf;
690
+ line-height: 1.45;
691
+ padding-top: 0.25em;
692
+ padding-bottom: 0.25em;
693
+ padding-left: 0.25em;
694
+ color: rgba(0, 0, 0, 0.6);
695
+ display: flex;
696
+ flex-flow: row wrap;
697
+ }
698
+ #header .details span:first-child {
699
+ margin-left: -0.125em;
700
+ }
701
+ #header .details span.email a {
702
+ color: rgba(0, 0, 0, 0.85);
703
+ }
704
+ #header .details br {
705
+ display: none;
706
+ }
707
+ #header .details br + span::before {
708
+ content: '\00a0\2013\00a0';
709
+ }
710
+ #header .details br + span.author::before {
711
+ content: '\00a0\22c5\00a0';
712
+ color: rgba(0, 0, 0, 0.85);
713
+ }
714
+ #header .details br + span#revremark::before {
715
+ content: '\00a0|\00a0';
716
+ }
717
+ #header #revnumber {
718
+ text-transform: capitalize;
719
+ }
720
+ #header #revnumber::after {
721
+ content: '\00a0';
722
+ }
723
+ #content > h1:first-child:not([class]) {
724
+ color: rgba(0, 0, 0, 0.85);
725
+ border-bottom: 1px solid #dddddf;
726
+ padding-bottom: 8px;
727
+ margin-top: 0;
728
+ padding-top: 1rem;
729
+ margin-bottom: 1.25rem;
730
+ }
731
+ #toc {
732
+ border-bottom: 1px solid #e7e7e9;
733
+ padding-bottom: 0.5em;
734
+ }
735
+ #toc > ul {
736
+ margin-left: 0.125em;
737
+ }
738
+ #toc ul.sectlevel0 > li > a {
739
+ font-style: italic;
740
+ }
741
+ #toc ul.sectlevel0 ul.sectlevel1 {
742
+ margin: 0.5em 0;
743
+ }
744
+ #toc ul {
745
+ font-family: 'Open Sans', 'DejaVu Sans', sans-serif;
746
+ list-style-type: none;
747
+ }
748
+ #toc li {
749
+ line-height: 1.3334;
750
+ margin-top: 0.3334em;
751
+ }
752
+ #toc a {
753
+ text-decoration: none;
754
+ }
755
+ #toc a:active {
756
+ text-decoration: underline;
757
+ }
758
+ #toctitle {
759
+ color: #7a2518;
760
+ font-size: 1.2em;
761
+ }
762
+ @media screen and (min-width: 768px) {
763
+ #toctitle {
764
+ font-size: 1.375em;
765
+ }
766
+ body.toc2 {
767
+ padding-left: 15em;
768
+ padding-right: 0;
769
+ }
770
+ #toc.toc2 {
771
+ margin-top: 0 !important;
772
+ background: #f8f8f7;
773
+ position: fixed;
774
+ width: 15em;
775
+ left: 0;
776
+ top: 0;
777
+ border-right: 1px solid #e7e7e9;
778
+ border-top-width: 0 !important;
779
+ border-bottom-width: 0 !important;
780
+ z-index: 1000;
781
+ padding: 1.25em 1em;
782
+ height: 100%;
783
+ overflow: auto;
784
+ }
785
+ #toc.toc2 #toctitle {
786
+ margin-top: 0;
787
+ margin-bottom: 0.8rem;
788
+ font-size: 1.2em;
789
+ }
790
+ #toc.toc2 > ul {
791
+ font-size: 0.9em;
792
+ margin-bottom: 0;
793
+ }
794
+ #toc.toc2 ul ul {
795
+ margin-left: 0;
796
+ padding-left: 1em;
797
+ }
798
+ #toc.toc2 ul.sectlevel0 ul.sectlevel1 {
799
+ padding-left: 0;
800
+ margin-top: 0.5em;
801
+ margin-bottom: 0.5em;
802
+ }
803
+ body.toc2.toc-right {
804
+ padding-left: 0;
805
+ padding-right: 15em;
806
+ }
807
+ body.toc2.toc-right #toc.toc2 {
808
+ border-right-width: 0;
809
+ border-left: 1px solid #e7e7e9;
810
+ left: auto;
811
+ right: 0;
812
+ }
813
+ }
814
+ @media screen and (min-width: 1280px) {
815
+ body.toc2 {
816
+ padding-left: 20em;
817
+ padding-right: 0;
818
+ }
819
+ #toc.toc2 {
820
+ width: 20em;
821
+ }
822
+ #toc.toc2 #toctitle {
823
+ font-size: 1.375em;
824
+ }
825
+ #toc.toc2 > ul {
826
+ font-size: 0.95em;
827
+ }
828
+ #toc.toc2 ul ul {
829
+ padding-left: 1.25em;
830
+ }
831
+ body.toc2.toc-right {
832
+ padding-left: 0;
833
+ padding-right: 20em;
834
+ }
835
+ }
836
+ #content #toc {
837
+ border: 1px solid #e0e0dc;
838
+ margin-bottom: 1.25em;
839
+ padding: 1.25em;
840
+ background: #f8f8f7;
841
+ border-radius: 4px;
842
+ }
843
+ #content #toc > :first-child {
844
+ margin-top: 0;
845
+ }
846
+ #content #toc > :last-child {
847
+ margin-bottom: 0;
848
+ }
849
+ #footer {
850
+ max-width: none;
851
+ background: rgba(0, 0, 0, 0.8);
852
+ padding: 1.25em;
853
+ }
854
+ #footer-text {
855
+ color: hsla(0, 0%, 100%, 0.8);
856
+ line-height: 1.44;
857
+ }
858
+ #content {
859
+ margin-bottom: 0.625em;
860
+ }
861
+ .sect1 {
862
+ padding-bottom: 0.625em;
863
+ }
864
+ @media screen and (min-width: 768px) {
865
+ #content {
866
+ margin-bottom: 1.25em;
867
+ }
868
+ .sect1 {
869
+ padding-bottom: 1.25em;
870
+ }
871
+ }
872
+ .sect1:last-child {
873
+ padding-bottom: 0;
874
+ }
875
+ .sect1 + .sect1 {
876
+ border-top: 1px solid #e7e7e9;
877
+ }
878
+ #content h1 > a.anchor,
879
+ h2 > a.anchor,
880
+ h3 > a.anchor,
881
+ #toctitle > a.anchor,
882
+ .sidebarblock > .content > .title > a.anchor,
883
+ h4 > a.anchor,
884
+ h5 > a.anchor,
885
+ h6 > a.anchor {
886
+ position: absolute;
887
+ z-index: 1001;
888
+ width: 1.5ex;
889
+ margin-left: -1.5ex;
890
+ display: block;
891
+ text-decoration: none !important;
892
+ visibility: hidden;
893
+ text-align: center;
894
+ font-weight: 400;
895
+ }
896
+ #content h1 > a.anchor::before,
897
+ h2 > a.anchor::before,
898
+ h3 > a.anchor::before,
899
+ #toctitle > a.anchor::before,
900
+ .sidebarblock > .content > .title > a.anchor::before,
901
+ h4 > a.anchor::before,
902
+ h5 > a.anchor::before,
903
+ h6 > a.anchor::before {
904
+ content: '\00A7';
905
+ font-size: 0.85em;
906
+ display: block;
907
+ padding-top: 0.1em;
908
+ }
909
+ #content h1:hover > a.anchor,
910
+ #content h1 > a.anchor:hover,
911
+ h2:hover > a.anchor,
912
+ h2 > a.anchor:hover,
913
+ h3:hover > a.anchor,
914
+ #toctitle:hover > a.anchor,
915
+ .sidebarblock > .content > .title:hover > a.anchor,
916
+ h3 > a.anchor:hover,
917
+ #toctitle > a.anchor:hover,
918
+ .sidebarblock > .content > .title > a.anchor:hover,
919
+ h4:hover > a.anchor,
920
+ h4 > a.anchor:hover,
921
+ h5:hover > a.anchor,
922
+ h5 > a.anchor:hover,
923
+ h6:hover > a.anchor,
924
+ h6 > a.anchor:hover {
925
+ visibility: visible;
926
+ }
927
+ #content h1 > a.link,
928
+ h2 > a.link,
929
+ h3 > a.link,
930
+ #toctitle > a.link,
931
+ .sidebarblock > .content > .title > a.link,
932
+ h4 > a.link,
933
+ h5 > a.link,
934
+ h6 > a.link {
935
+ color: #ba3925;
936
+ text-decoration: none;
937
+ }
938
+ #content h1 > a.link:hover,
939
+ h2 > a.link:hover,
940
+ h3 > a.link:hover,
941
+ #toctitle > a.link:hover,
942
+ .sidebarblock > .content > .title > a.link:hover,
943
+ h4 > a.link:hover,
944
+ h5 > a.link:hover,
945
+ h6 > a.link:hover {
946
+ color: #a53221;
947
+ }
948
+ details,
949
+ .audioblock,
950
+ .imageblock,
951
+ .literalblock,
952
+ .listingblock,
953
+ .stemblock,
954
+ .videoblock {
955
+ margin-bottom: 1.25em;
956
+ }
957
+ details {
958
+ margin-left: 1.25rem;
959
+ }
960
+ details > summary {
961
+ cursor: pointer;
962
+ display: block;
963
+ position: relative;
964
+ line-height: 1.6;
965
+ margin-bottom: 0.625rem;
966
+ outline: none;
967
+ -webkit-tap-highlight-color: transparent;
968
+ }
969
+ details > summary::-webkit-details-marker {
970
+ display: none;
971
+ }
972
+ details > summary::before {
973
+ content: '';
974
+ border: solid transparent;
975
+ border-left: solid;
976
+ border-width: 0.3em 0 0.3em 0.5em;
977
+ position: absolute;
978
+ top: 0.5em;
979
+ left: -1.25rem;
980
+ transform: translateX(15%);
981
+ }
982
+ details[open] > summary::before {
983
+ border: solid transparent;
984
+ border-top: solid;
985
+ border-width: 0.5em 0.3em 0;
986
+ transform: translateY(15%);
987
+ }
988
+ details > summary::after {
989
+ content: '';
990
+ width: 1.25rem;
991
+ height: 1em;
992
+ position: absolute;
993
+ top: 0.3em;
994
+ left: -1.25rem;
995
+ }
996
+ .admonitionblock td.content > .title,
997
+ .audioblock > .title,
998
+ .exampleblock > .title,
999
+ .imageblock > .title,
1000
+ .listingblock > .title,
1001
+ .literalblock > .title,
1002
+ .stemblock > .title,
1003
+ .openblock > .title,
1004
+ .paragraph > .title,
1005
+ .quoteblock > .title,
1006
+ table.tableblock > .title,
1007
+ .verseblock > .title,
1008
+ .videoblock > .title,
1009
+ .dlist > .title,
1010
+ .olist > .title,
1011
+ .ulist > .title,
1012
+ .qlist > .title,
1013
+ .hdlist > .title {
1014
+ text-rendering: optimizeLegibility;
1015
+ text-align: left;
1016
+ font-family: 'Noto Serif', 'DejaVu Serif', serif;
1017
+ font-size: 1rem;
1018
+ font-style: italic;
1019
+ }
1020
+ table.tableblock.fit-content > caption.title {
1021
+ white-space: nowrap;
1022
+ width: 0;
1023
+ }
1024
+ .paragraph.lead > p,
1025
+ #preamble > .sectionbody > [class='paragraph']:first-of-type p {
1026
+ font-size: 1.21875em;
1027
+ line-height: 1.6;
1028
+ color: rgba(0, 0, 0, 0.85);
1029
+ }
1030
+ .admonitionblock > table {
1031
+ border-collapse: separate;
1032
+ border: 0;
1033
+ background: none;
1034
+ width: 100%;
1035
+ }
1036
+ .admonitionblock > table td.icon {
1037
+ text-align: center;
1038
+ width: 80px;
1039
+ }
1040
+ .admonitionblock > table td.icon img {
1041
+ max-width: none;
1042
+ }
1043
+ .admonitionblock > table td.icon .title {
1044
+ font-weight: bold;
1045
+ font-family: 'Open Sans', 'DejaVu Sans', sans-serif;
1046
+ text-transform: uppercase;
1047
+ }
1048
+ .admonitionblock > table td.content {
1049
+ padding-left: 1.125em;
1050
+ padding-right: 1.25em;
1051
+ border-left: 1px solid #dddddf;
1052
+ color: rgba(0, 0, 0, 0.6);
1053
+ word-wrap: anywhere;
1054
+ }
1055
+ .admonitionblock > table td.content > :last-child > :last-child {
1056
+ margin-bottom: 0;
1057
+ }
1058
+ .exampleblock > .content {
1059
+ border: 1px solid #e6e6e6;
1060
+ margin-bottom: 1.25em;
1061
+ padding: 1.25em;
1062
+ background: #fff;
1063
+ border-radius: 4px;
1064
+ }
1065
+ .sidebarblock {
1066
+ border: 1px solid #dbdbd6;
1067
+ margin-bottom: 1.25em;
1068
+ padding: 1.25em;
1069
+ background: #f3f3f2;
1070
+ border-radius: 4px;
1071
+ }
1072
+ .sidebarblock > .content > .title {
1073
+ color: #7a2518;
1074
+ margin-top: 0;
1075
+ text-align: center;
1076
+ }
1077
+ .exampleblock > .content > :first-child,
1078
+ .sidebarblock > .content > :first-child {
1079
+ margin-top: 0;
1080
+ }
1081
+ .exampleblock > .content > :last-child,
1082
+ .exampleblock > .content > :last-child > :last-child,
1083
+ .exampleblock > .content .olist > ol > li:last-child > :last-child,
1084
+ .exampleblock > .content .ulist > ul > li:last-child > :last-child,
1085
+ .exampleblock > .content .qlist > ol > li:last-child > :last-child,
1086
+ .sidebarblock > .content > :last-child,
1087
+ .sidebarblock > .content > :last-child > :last-child,
1088
+ .sidebarblock > .content .olist > ol > li:last-child > :last-child,
1089
+ .sidebarblock > .content .ulist > ul > li:last-child > :last-child,
1090
+ .sidebarblock > .content .qlist > ol > li:last-child > :last-child {
1091
+ margin-bottom: 0;
1092
+ }
1093
+ .literalblock pre,
1094
+ .listingblock > .content > pre {
1095
+ border-radius: 4px;
1096
+ overflow-x: auto;
1097
+ padding: 1em;
1098
+ font-size: 0.8125em;
1099
+ }
1100
+ @media screen and (min-width: 768px) {
1101
+ .literalblock pre,
1102
+ .listingblock > .content > pre {
1103
+ font-size: 0.90625em;
1104
+ }
1105
+ }
1106
+ @media screen and (min-width: 1280px) {
1107
+ .literalblock pre,
1108
+ .listingblock > .content > pre {
1109
+ font-size: 1em;
1110
+ }
1111
+ }
1112
+ .literalblock pre,
1113
+ .listingblock > .content > pre:not(.highlight),
1114
+ .listingblock > .content > pre[class='highlight'],
1115
+ .listingblock > .content > pre[class^='highlight '] {
1116
+ background: #f7f7f8;
1117
+ }
1118
+ .literalblock.output pre {
1119
+ color: #f7f7f8;
1120
+ background: rgba(0, 0, 0, 0.9);
1121
+ }
1122
+ .listingblock > .content {
1123
+ position: relative;
1124
+ }
1125
+ .listingblock code[data-lang]::before {
1126
+ display: none;
1127
+ content: attr(data-lang);
1128
+ position: absolute;
1129
+ font-size: 0.75em;
1130
+ top: 0.425rem;
1131
+ right: 0.5rem;
1132
+ line-height: 1;
1133
+ text-transform: uppercase;
1134
+ color: inherit;
1135
+ opacity: 0.5;
1136
+ }
1137
+ .listingblock:hover code[data-lang]::before {
1138
+ display: block;
1139
+ }
1140
+ .listingblock.terminal pre .command::before {
1141
+ content: attr(data-prompt);
1142
+ padding-right: 0.5em;
1143
+ color: inherit;
1144
+ opacity: 0.5;
1145
+ }
1146
+ .listingblock.terminal pre .command:not([data-prompt])::before {
1147
+ content: '$';
1148
+ }
1149
+ .listingblock pre.highlightjs {
1150
+ padding: 0;
1151
+ }
1152
+ .listingblock pre.highlightjs > code {
1153
+ padding: 1em;
1154
+ border-radius: 4px;
1155
+ }
1156
+ .listingblock pre.prettyprint {
1157
+ border-width: 0;
1158
+ }
1159
+ .prettyprint {
1160
+ background: #f7f7f8;
1161
+ }
1162
+ pre.prettyprint .linenums {
1163
+ line-height: 1.45;
1164
+ margin-left: 2em;
1165
+ }
1166
+ pre.prettyprint li {
1167
+ background: none;
1168
+ list-style-type: inherit;
1169
+ padding-left: 0;
1170
+ }
1171
+ pre.prettyprint li code[data-lang]::before {
1172
+ opacity: 1;
1173
+ }
1174
+ pre.prettyprint li:not(:first-child) code[data-lang]::before {
1175
+ display: none;
1176
+ }
1177
+ table.linenotable {
1178
+ border-collapse: separate;
1179
+ border: 0;
1180
+ margin-bottom: 0;
1181
+ background: none;
1182
+ }
1183
+ table.linenotable td[class] {
1184
+ color: inherit;
1185
+ vertical-align: top;
1186
+ padding: 0;
1187
+ line-height: inherit;
1188
+ white-space: normal;
1189
+ }
1190
+ table.linenotable td.code {
1191
+ padding-left: 0.75em;
1192
+ }
1193
+ table.linenotable td.linenos,
1194
+ pre.pygments .linenos {
1195
+ border-right: 1px solid;
1196
+ opacity: 0.35;
1197
+ padding-right: 0.5em;
1198
+ -webkit-user-select: none;
1199
+ -moz-user-select: none;
1200
+ -ms-user-select: none;
1201
+ user-select: none;
1202
+ }
1203
+ pre.pygments span.linenos {
1204
+ display: inline-block;
1205
+ margin-right: 0.75em;
1206
+ }
1207
+ .quoteblock {
1208
+ margin: 0 1em 1.25em 1.5em;
1209
+ display: table;
1210
+ }
1211
+ .quoteblock:not(.excerpt) > .title {
1212
+ margin-left: -1.5em;
1213
+ margin-bottom: 0.75em;
1214
+ }
1215
+ .quoteblock blockquote,
1216
+ .quoteblock p {
1217
+ color: rgba(0, 0, 0, 0.85);
1218
+ font-size: 1.15rem;
1219
+ line-height: 1.75;
1220
+ word-spacing: 0.1em;
1221
+ letter-spacing: 0;
1222
+ font-style: italic;
1223
+ text-align: justify;
1224
+ }
1225
+ .quoteblock blockquote {
1226
+ margin: 0;
1227
+ padding: 0;
1228
+ border: 0;
1229
+ }
1230
+ .quoteblock blockquote::before {
1231
+ content: '\201c';
1232
+ float: left;
1233
+ font-size: 2.75em;
1234
+ font-weight: bold;
1235
+ line-height: 0.6em;
1236
+ margin-left: -0.6em;
1237
+ color: #7a2518;
1238
+ text-shadow: 0 1px 2px rgba(0, 0, 0, 0.1);
1239
+ }
1240
+ .quoteblock blockquote > .paragraph:last-child p {
1241
+ margin-bottom: 0;
1242
+ }
1243
+ .quoteblock .attribution {
1244
+ margin-top: 0.75em;
1245
+ margin-right: 0.5ex;
1246
+ text-align: right;
1247
+ }
1248
+ .verseblock {
1249
+ margin: 0 1em 1.25em;
1250
+ }
1251
+ .verseblock pre {
1252
+ font-family: 'Open Sans', 'DejaVu Sans', sans-serif;
1253
+ font-size: 1.15rem;
1254
+ color: rgba(0, 0, 0, 0.85);
1255
+ font-weight: 300;
1256
+ text-rendering: optimizeLegibility;
1257
+ }
1258
+ .verseblock pre strong {
1259
+ font-weight: 400;
1260
+ }
1261
+ .verseblock .attribution {
1262
+ margin-top: 1.25rem;
1263
+ margin-left: 0.5ex;
1264
+ }
1265
+ .quoteblock .attribution,
1266
+ .verseblock .attribution {
1267
+ font-size: 0.9375em;
1268
+ line-height: 1.45;
1269
+ font-style: italic;
1270
+ }
1271
+ .quoteblock .attribution br,
1272
+ .verseblock .attribution br {
1273
+ display: none;
1274
+ }
1275
+ .quoteblock .attribution cite,
1276
+ .verseblock .attribution cite {
1277
+ display: block;
1278
+ letter-spacing: -0.025em;
1279
+ color: rgba(0, 0, 0, 0.6);
1280
+ }
1281
+ .quoteblock.abstract blockquote::before,
1282
+ .quoteblock.excerpt blockquote::before,
1283
+ .quoteblock .quoteblock blockquote::before {
1284
+ display: none;
1285
+ }
1286
+ .quoteblock.abstract blockquote,
1287
+ .quoteblock.abstract p,
1288
+ .quoteblock.excerpt blockquote,
1289
+ .quoteblock.excerpt p,
1290
+ .quoteblock .quoteblock blockquote,
1291
+ .quoteblock .quoteblock p {
1292
+ line-height: 1.6;
1293
+ word-spacing: 0;
1294
+ }
1295
+ .quoteblock.abstract {
1296
+ margin: 0 1em 1.25em;
1297
+ display: block;
1298
+ }
1299
+ .quoteblock.abstract > .title {
1300
+ margin: 0 0 0.375em;
1301
+ font-size: 1.15em;
1302
+ text-align: center;
1303
+ }
1304
+ .quoteblock.excerpt > blockquote,
1305
+ .quoteblock .quoteblock {
1306
+ padding: 0 0 0.25em 1em;
1307
+ border-left: 0.25em solid #dddddf;
1308
+ }
1309
+ .quoteblock.excerpt,
1310
+ .quoteblock .quoteblock {
1311
+ margin-left: 0;
1312
+ }
1313
+ .quoteblock.excerpt blockquote,
1314
+ .quoteblock.excerpt p,
1315
+ .quoteblock .quoteblock blockquote,
1316
+ .quoteblock .quoteblock p {
1317
+ color: inherit;
1318
+ font-size: 1.0625rem;
1319
+ }
1320
+ .quoteblock.excerpt .attribution,
1321
+ .quoteblock .quoteblock .attribution {
1322
+ color: inherit;
1323
+ font-size: 0.85rem;
1324
+ text-align: left;
1325
+ margin-right: 0;
1326
+ }
1327
+ p.tableblock:last-child {
1328
+ margin-bottom: 0;
1329
+ }
1330
+ td.tableblock > .content {
1331
+ margin-bottom: 1.25em;
1332
+ word-wrap: anywhere;
1333
+ }
1334
+ td.tableblock > .content > :last-child {
1335
+ margin-bottom: -1.25em;
1336
+ }
1337
+ table.tableblock,
1338
+ th.tableblock,
1339
+ td.tableblock {
1340
+ border: 0 solid #dedede;
1341
+ }
1342
+ table.grid-all > * > tr > * {
1343
+ border-width: 1px;
1344
+ }
1345
+ table.grid-cols > * > tr > * {
1346
+ border-width: 0 1px;
1347
+ }
1348
+ table.grid-rows > * > tr > * {
1349
+ border-width: 1px 0;
1350
+ }
1351
+ table.frame-all {
1352
+ border-width: 1px;
1353
+ }
1354
+ table.frame-ends {
1355
+ border-width: 1px 0;
1356
+ }
1357
+ table.frame-sides {
1358
+ border-width: 0 1px;
1359
+ }
1360
+ table.frame-none > colgroup + * > :first-child > *,
1361
+ table.frame-sides > colgroup + * > :first-child > * {
1362
+ border-top-width: 0;
1363
+ }
1364
+ table.frame-none > :last-child > :last-child > *,
1365
+ table.frame-sides > :last-child > :last-child > * {
1366
+ border-bottom-width: 0;
1367
+ }
1368
+ table.frame-none > * > tr > :first-child,
1369
+ table.frame-ends > * > tr > :first-child {
1370
+ border-left-width: 0;
1371
+ }
1372
+ table.frame-none > * > tr > :last-child,
1373
+ table.frame-ends > * > tr > :last-child {
1374
+ border-right-width: 0;
1375
+ }
1376
+ table.stripes-all > * > tr,
1377
+ table.stripes-odd > * > tr:nth-of-type(odd),
1378
+ table.stripes-even > * > tr:nth-of-type(even),
1379
+ table.stripes-hover > * > tr:hover {
1380
+ background: #f8f8f7;
1381
+ }
1382
+ th.halign-left,
1383
+ td.halign-left {
1384
+ text-align: left;
1385
+ }
1386
+ th.halign-right,
1387
+ td.halign-right {
1388
+ text-align: right;
1389
+ }
1390
+ th.halign-center,
1391
+ td.halign-center {
1392
+ text-align: center;
1393
+ }
1394
+ th.valign-top,
1395
+ td.valign-top {
1396
+ vertical-align: top;
1397
+ }
1398
+ th.valign-bottom,
1399
+ td.valign-bottom {
1400
+ vertical-align: bottom;
1401
+ }
1402
+ th.valign-middle,
1403
+ td.valign-middle {
1404
+ vertical-align: middle;
1405
+ }
1406
+ table thead th,
1407
+ table tfoot th {
1408
+ font-weight: bold;
1409
+ }
1410
+ tbody tr th {
1411
+ background: #f7f8f7;
1412
+ }
1413
+ tbody tr th,
1414
+ tbody tr th p,
1415
+ tfoot tr th,
1416
+ tfoot tr th p {
1417
+ color: rgba(0, 0, 0, 0.8);
1418
+ font-weight: bold;
1419
+ }
1420
+ p.tableblock > code:only-child {
1421
+ background: none;
1422
+ padding: 0;
1423
+ }
1424
+ p.tableblock {
1425
+ font-size: 1em;
1426
+ }
1427
+ ol {
1428
+ margin-left: 1.75em;
1429
+ }
1430
+ ul li ol {
1431
+ margin-left: 1.5em;
1432
+ }
1433
+ dl dd {
1434
+ margin-left: 1.125em;
1435
+ }
1436
+ dl dd:last-child,
1437
+ dl dd:last-child > :last-child {
1438
+ margin-bottom: 0;
1439
+ }
1440
+ li p,
1441
+ ul dd,
1442
+ ol dd,
1443
+ .olist .olist,
1444
+ .ulist .ulist,
1445
+ .ulist .olist,
1446
+ .olist .ulist {
1447
+ margin-bottom: 0.625em;
1448
+ }
1449
+ ul.checklist,
1450
+ ul.none,
1451
+ ol.none,
1452
+ ul.no-bullet,
1453
+ ol.no-bullet,
1454
+ ol.unnumbered,
1455
+ ul.unstyled,
1456
+ ol.unstyled {
1457
+ list-style-type: none;
1458
+ }
1459
+ ul.no-bullet,
1460
+ ol.no-bullet,
1461
+ ol.unnumbered {
1462
+ margin-left: 0.625em;
1463
+ }
1464
+ ul.unstyled,
1465
+ ol.unstyled {
1466
+ margin-left: 0;
1467
+ }
1468
+ li > p:empty:only-child::before {
1469
+ content: '';
1470
+ display: inline-block;
1471
+ }
1472
+ ul.checklist > li > p:first-child {
1473
+ margin-left: -1em;
1474
+ }
1475
+ ul.checklist > li > p:first-child > .fa-square-o:first-child,
1476
+ ul.checklist > li > p:first-child > .fa-check-square-o:first-child {
1477
+ width: 1.25em;
1478
+ font-size: 0.8em;
1479
+ position: relative;
1480
+ bottom: 0.125em;
1481
+ }
1482
+ ul.checklist > li > p:first-child > input[type='checkbox']:first-child {
1483
+ margin-right: 0.25em;
1484
+ }
1485
+ ul.inline {
1486
+ display: flex;
1487
+ flex-flow: row wrap;
1488
+ list-style: none;
1489
+ margin: 0 0 0.625em -1.25em;
1490
+ }
1491
+ ul.inline > li {
1492
+ margin-left: 1.25em;
1493
+ }
1494
+ .unstyled dl dt {
1495
+ font-weight: 400;
1496
+ font-style: normal;
1497
+ }
1498
+ ol.arabic {
1499
+ list-style-type: decimal;
1500
+ }
1501
+ ol.decimal {
1502
+ list-style-type: decimal-leading-zero;
1503
+ }
1504
+ ol.loweralpha {
1505
+ list-style-type: lower-alpha;
1506
+ }
1507
+ ol.upperalpha {
1508
+ list-style-type: upper-alpha;
1509
+ }
1510
+ ol.lowerroman {
1511
+ list-style-type: lower-roman;
1512
+ }
1513
+ ol.upperroman {
1514
+ list-style-type: upper-roman;
1515
+ }
1516
+ ol.lowergreek {
1517
+ list-style-type: lower-greek;
1518
+ }
1519
+ .hdlist > table,
1520
+ .colist > table {
1521
+ border: 0;
1522
+ background: none;
1523
+ }
1524
+ .hdlist > table > tbody > tr,
1525
+ .colist > table > tbody > tr {
1526
+ background: none;
1527
+ }
1528
+ td.hdlist1,
1529
+ td.hdlist2 {
1530
+ vertical-align: top;
1531
+ padding: 0 0.625em;
1532
+ }
1533
+ td.hdlist1 {
1534
+ font-weight: bold;
1535
+ padding-bottom: 1.25em;
1536
+ }
1537
+ td.hdlist2 {
1538
+ word-wrap: anywhere;
1539
+ }
1540
+ .literalblock + .colist,
1541
+ .listingblock + .colist {
1542
+ margin-top: -0.5em;
1543
+ }
1544
+ .colist td:not([class]):first-child {
1545
+ padding: 0.4em 0.75em 0;
1546
+ line-height: 1;
1547
+ vertical-align: top;
1548
+ }
1549
+ .colist td:not([class]):first-child img {
1550
+ max-width: none;
1551
+ }
1552
+ .colist td:not([class]):last-child {
1553
+ padding: 0.25em 0;
1554
+ }
1555
+ .thumb,
1556
+ .th {
1557
+ line-height: 0;
1558
+ display: inline-block;
1559
+ border: 4px solid #fff;
1560
+ box-shadow: 0 0 0 1px #ddd;
1561
+ }
1562
+ .imageblock.left {
1563
+ margin: 0.25em 0.625em 1.25em 0;
1564
+ }
1565
+ .imageblock.right {
1566
+ margin: 0.25em 0 1.25em 0.625em;
1567
+ }
1568
+ .imageblock > .title {
1569
+ margin-bottom: 0;
1570
+ }
1571
+ .imageblock.thumb,
1572
+ .imageblock.th {
1573
+ border-width: 6px;
1574
+ }
1575
+ .imageblock.thumb > .title,
1576
+ .imageblock.th > .title {
1577
+ padding: 0 0.125em;
1578
+ }
1579
+ .image.left,
1580
+ .image.right {
1581
+ margin-top: 0.25em;
1582
+ margin-bottom: 0.25em;
1583
+ display: inline-block;
1584
+ line-height: 0;
1585
+ }
1586
+ .image.left {
1587
+ margin-right: 0.625em;
1588
+ }
1589
+ .image.right {
1590
+ margin-left: 0.625em;
1591
+ }
1592
+ a.image {
1593
+ text-decoration: none;
1594
+ display: inline-block;
1595
+ }
1596
+ a.image object {
1597
+ pointer-events: none;
1598
+ }
1599
+ sup.footnote,
1600
+ sup.footnoteref {
1601
+ font-size: 0.875em;
1602
+ position: static;
1603
+ vertical-align: super;
1604
+ }
1605
+ sup.footnote a,
1606
+ sup.footnoteref a {
1607
+ text-decoration: none;
1608
+ }
1609
+ sup.footnote a:active,
1610
+ sup.footnoteref a:active {
1611
+ text-decoration: underline;
1612
+ }
1613
+ #footnotes {
1614
+ padding-top: 0.75em;
1615
+ padding-bottom: 0.75em;
1616
+ margin-bottom: 0.625em;
1617
+ }
1618
+ #footnotes hr {
1619
+ width: 20%;
1620
+ min-width: 6.25em;
1621
+ margin: -0.25em 0 0.75em;
1622
+ border-width: 1px 0 0;
1623
+ }
1624
+ #footnotes .footnote {
1625
+ padding: 0 0.375em 0 0.225em;
1626
+ line-height: 1.3334;
1627
+ font-size: 0.875em;
1628
+ margin-left: 1.2em;
1629
+ margin-bottom: 0.2em;
1630
+ }
1631
+ #footnotes .footnote a:first-of-type {
1632
+ font-weight: bold;
1633
+ text-decoration: none;
1634
+ margin-left: -1.05em;
1635
+ }
1636
+ #footnotes .footnote:last-of-type {
1637
+ margin-bottom: 0;
1638
+ }
1639
+ #content #footnotes {
1640
+ margin-top: -0.625em;
1641
+ margin-bottom: 0;
1642
+ padding: 0.75em 0;
1643
+ }
1644
+ div.unbreakable {
1645
+ page-break-inside: avoid;
1646
+ }
1647
+ .big {
1648
+ font-size: larger;
1649
+ }
1650
+ .small {
1651
+ font-size: smaller;
1652
+ }
1653
+ .underline {
1654
+ text-decoration: underline;
1655
+ }
1656
+ .overline {
1657
+ text-decoration: overline;
1658
+ }
1659
+ .line-through {
1660
+ text-decoration: line-through;
1661
+ }
1662
+ .aqua {
1663
+ color: #00bfbf;
1664
+ }
1665
+ .aqua-background {
1666
+ background: #00fafa;
1667
+ }
1668
+ .black {
1669
+ color: #000;
1670
+ }
1671
+ .black-background {
1672
+ background: #000;
1673
+ }
1674
+ .blue {
1675
+ color: #0000bf;
1676
+ }
1677
+ .blue-background {
1678
+ background: #0000fa;
1679
+ }
1680
+ .fuchsia {
1681
+ color: #bf00bf;
1682
+ }
1683
+ .fuchsia-background {
1684
+ background: #fa00fa;
1685
+ }
1686
+ .gray {
1687
+ color: #606060;
1688
+ }
1689
+ .gray-background {
1690
+ background: #7d7d7d;
1691
+ }
1692
+ .green {
1693
+ color: #006000;
1694
+ }
1695
+ .green-background {
1696
+ background: #007d00;
1697
+ }
1698
+ .lime {
1699
+ color: #00bf00;
1700
+ }
1701
+ .lime-background {
1702
+ background: #00fa00;
1703
+ }
1704
+ .maroon {
1705
+ color: #600000;
1706
+ }
1707
+ .maroon-background {
1708
+ background: #7d0000;
1709
+ }
1710
+ .navy {
1711
+ color: #000060;
1712
+ }
1713
+ .navy-background {
1714
+ background: #00007d;
1715
+ }
1716
+ .olive {
1717
+ color: #606000;
1718
+ }
1719
+ .olive-background {
1720
+ background: #7d7d00;
1721
+ }
1722
+ .purple {
1723
+ color: #600060;
1724
+ }
1725
+ .purple-background {
1726
+ background: #7d007d;
1727
+ }
1728
+ .red {
1729
+ color: #bf0000;
1730
+ }
1731
+ .red-background {
1732
+ background: #fa0000;
1733
+ }
1734
+ .silver {
1735
+ color: #909090;
1736
+ }
1737
+ .silver-background {
1738
+ background: #bcbcbc;
1739
+ }
1740
+ .teal {
1741
+ color: #006060;
1742
+ }
1743
+ .teal-background {
1744
+ background: #007d7d;
1745
+ }
1746
+ .white {
1747
+ color: #bfbfbf;
1748
+ }
1749
+ .white-background {
1750
+ background: #fafafa;
1751
+ }
1752
+ .yellow {
1753
+ color: #bfbf00;
1754
+ }
1755
+ .yellow-background {
1756
+ background: #fafa00;
1757
+ }
1758
+ span.icon > .fa {
1759
+ cursor: default;
1760
+ }
1761
+ a span.icon > .fa {
1762
+ cursor: inherit;
1763
+ }
1764
+ .admonitionblock td.icon [class^='fa icon-'] {
1765
+ font-size: 2.5em;
1766
+ text-shadow: 1px 1px 2px rgba(0, 0, 0, 0.5);
1767
+ cursor: default;
1768
+ }
1769
+ .admonitionblock td.icon .icon-note::before {
1770
+ content: '\f05a';
1771
+ color: #19407c;
1772
+ }
1773
+ .admonitionblock td.icon .icon-tip::before {
1774
+ content: '\f0eb';
1775
+ text-shadow: 1px 1px 2px rgba(155, 155, 0, 0.8);
1776
+ color: #111;
1777
+ }
1778
+ .admonitionblock td.icon .icon-warning::before {
1779
+ content: '\f071';
1780
+ color: #bf6900;
1781
+ }
1782
+ .admonitionblock td.icon .icon-caution::before {
1783
+ content: '\f06d';
1784
+ color: #bf3400;
1785
+ }
1786
+ .admonitionblock td.icon .icon-important::before {
1787
+ content: '\f06a';
1788
+ color: #bf0000;
1789
+ }
1790
+ .conum[data-value] {
1791
+ display: inline-block;
1792
+ color: #fff !important;
1793
+ background: rgba(0, 0, 0, 0.8);
1794
+ border-radius: 50%;
1795
+ text-align: center;
1796
+ font-size: 0.75em;
1797
+ width: 1.67em;
1798
+ height: 1.67em;
1799
+ line-height: 1.67em;
1800
+ font-family: 'Open Sans', 'DejaVu Sans', sans-serif;
1801
+ font-style: normal;
1802
+ font-weight: bold;
1803
+ }
1804
+ .conum[data-value] * {
1805
+ color: #fff !important;
1806
+ }
1807
+ .conum[data-value] + b {
1808
+ display: none;
1809
+ }
1810
+ .conum[data-value]::after {
1811
+ content: attr(data-value);
1812
+ }
1813
+ pre .conum[data-value] {
1814
+ position: relative;
1815
+ top: -0.125em;
1816
+ }
1817
+ b.conum * {
1818
+ color: inherit !important;
1819
+ }
1820
+ .conum:not([data-value]):empty {
1821
+ display: none;
1822
+ }
1823
+ dt,
1824
+ th.tableblock,
1825
+ td.content,
1826
+ div.footnote {
1827
+ text-rendering: optimizeLegibility;
1828
+ }
1829
+ h1,
1830
+ h2,
1831
+ p,
1832
+ td.content,
1833
+ span.alt,
1834
+ summary {
1835
+ letter-spacing: -0.01em;
1836
+ }
1837
+ p strong,
1838
+ td.content strong,
1839
+ div.footnote strong {
1840
+ letter-spacing: -0.005em;
1841
+ }
1842
+ p,
1843
+ blockquote,
1844
+ dt,
1845
+ td.content,
1846
+ td.hdlist1,
1847
+ span.alt,
1848
+ summary {
1849
+ font-size: 1.0625rem;
1850
+ }
1851
+ p {
1852
+ margin-bottom: 1.25rem;
1853
+ }
1854
+ .sidebarblock p,
1855
+ .sidebarblock dt,
1856
+ .sidebarblock td.content,
1857
+ p.tableblock {
1858
+ font-size: 1em;
1859
+ }
1860
+ .exampleblock > .content {
1861
+ background: #fffef7;
1862
+ border-color: #e0e0dc;
1863
+ box-shadow: 0 1px 4px #e0e0dc;
1864
+ }
1865
+ .print-only {
1866
+ display: none !important;
1867
+ }
1868
+ @page {
1869
+ margin: 1.25cm 0.75cm;
1870
+ }
1871
+ @media print {
1872
+ * {
1873
+ box-shadow: none !important;
1874
+ text-shadow: none !important;
1875
+ }
1876
+ html {
1877
+ font-size: 80%;
1878
+ }
1879
+ a {
1880
+ color: inherit !important;
1881
+ text-decoration: underline !important;
1882
+ }
1883
+ a.bare,
1884
+ a[href^='#'],
1885
+ a[href^='mailto:'] {
1886
+ text-decoration: none !important;
1887
+ }
1888
+ a[href^='http:']:not(.bare)::after,
1889
+ a[href^='https:']:not(.bare)::after {
1890
+ content: '(' attr(href) ')';
1891
+ display: inline-block;
1892
+ font-size: 0.875em;
1893
+ padding-left: 0.25em;
1894
+ }
1895
+ abbr[title] {
1896
+ border-bottom: 1px dotted;
1897
+ }
1898
+ abbr[title]::after {
1899
+ content: ' (' attr(title) ')';
1900
+ }
1901
+ pre,
1902
+ blockquote,
1903
+ tr,
1904
+ img,
1905
+ object,
1906
+ svg {
1907
+ page-break-inside: avoid;
1908
+ }
1909
+ thead {
1910
+ display: table-header-group;
1911
+ }
1912
+ svg {
1913
+ max-width: 100%;
1914
+ }
1915
+ p,
1916
+ blockquote,
1917
+ dt,
1918
+ td.content {
1919
+ font-size: 1em;
1920
+ orphans: 3;
1921
+ widows: 3;
1922
+ }
1923
+ h2,
1924
+ h3,
1925
+ #toctitle,
1926
+ .sidebarblock > .content > .title {
1927
+ page-break-after: avoid;
1928
+ }
1929
+ #header,
1930
+ #content,
1931
+ #footnotes,
1932
+ #footer {
1933
+ max-width: none;
1934
+ }
1935
+ #toc,
1936
+ .sidebarblock,
1937
+ .exampleblock > .content {
1938
+ background: none !important;
1939
+ }
1940
+ #toc {
1941
+ border-bottom: 1px solid #dddddf !important;
1942
+ padding-bottom: 0 !important;
1943
+ }
1944
+ body.book #header {
1945
+ text-align: center;
1946
+ }
1947
+ body.book #header > h1:first-child {
1948
+ border: 0 !important;
1949
+ margin: 2.5em 0 1em;
1950
+ }
1951
+ body.book #header .details {
1952
+ border: 0 !important;
1953
+ display: block;
1954
+ padding: 0 !important;
1955
+ }
1956
+ body.book #header .details span:first-child {
1957
+ margin-left: 0 !important;
1958
+ }
1959
+ body.book #header .details br {
1960
+ display: block;
1961
+ }
1962
+ body.book #header .details br + span::before {
1963
+ content: none !important;
1964
+ }
1965
+ body.book #toc {
1966
+ border: 0 !important;
1967
+ text-align: left !important;
1968
+ padding: 0 !important;
1969
+ margin: 0 !important;
1970
+ }
1971
+ body.book #toc,
1972
+ body.book #preamble,
1973
+ body.book h1.sect0,
1974
+ body.book .sect1 > h2 {
1975
+ page-break-before: always;
1976
+ }
1977
+ .listingblock code[data-lang]::before {
1978
+ display: block;
1979
+ }
1980
+ #footer {
1981
+ padding: 0 0.9375em;
1982
+ }
1983
+ .hide-on-print {
1984
+ display: none !important;
1985
+ }
1986
+ .print-only {
1987
+ display: block !important;
1988
+ }
1989
+ .hide-for-print {
1990
+ display: none !important;
1991
+ }
1992
+ .show-for-print {
1993
+ display: inherit !important;
1994
+ }
1995
+ }
1996
+ @media amzn-kf8, print {
1997
+ #header > h1:first-child {
1998
+ margin-top: 1.25rem;
1999
+ }
2000
+ .sect1 {
2001
+ padding: 0 !important;
2002
+ }
2003
+ .sect1 + .sect1 {
2004
+ border: 0;
2005
+ }
2006
+ #footer {
2007
+ background: none;
2008
+ }
2009
+ #footer-text {
2010
+ color: rgba(0, 0, 0, 0.6);
2011
+ font-size: 0.9em;
2012
+ }
2013
+ }
2014
+ @media amzn-kf8 {
2015
+ #header,
2016
+ #content,
2017
+ #footnotes,
2018
+ #footer {
2019
+ padding: 0;
2020
+ }
2021
+ }
2022
+ </style>
2023
+ <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" />
2024
+ </head>
2025
+ <body class="article toc2 toc-left">
2026
+ <div id="header">
2027
+ <h1>Testing Best Practices with Vitest</h1>
2028
+ <div id="toc" class="toc2">
2029
+ <div id="toctitle">Table of Contents</div>
2030
+ <ul class="sectlevel1">
2031
+ <li>
2032
+ <a href="#_core_pattern_triple_a_aaa">Core Pattern: Triple A (AAA)</a>
2033
+ <ul class="sectlevel2">
2034
+ <li><a href="#_arrange">[ARRANGE]</a></li>
2035
+ <li><a href="#_act">[ACT]</a></li>
2036
+ <li><a href="#_assert">[ASSERT]</a></li>
2037
+ </ul>
2038
+ </li>
2039
+ <li><a href="#_naming_conventions">Naming Conventions</a></li>
2040
+ <li><a href="#_ai_assisted_testing_best_practices">AI-Assisted Testing Best Practices</a></li>
2041
+ <li><a href="#_vitest_configuration_standard">Vitest Configuration Standard</a></li>
2042
+ <li>
2043
+ <a href="#_advanced_mocking_stubs">Advanced Mocking &amp; Stubs</a>
2044
+ <ul class="sectlevel2">
2045
+ <li><a href="#_mocking_browser_apis">Mocking Browser APIs</a></li>
2046
+ <li><a href="#_constructible_mocks">Constructible Mocks</a></li>
2047
+ <li><a href="#_hoisted_variables">Hoisted Variables</a></li>
2048
+ </ul>
2049
+ </li>
2050
+ <li>
2051
+ <a href="#_testing_entry_points_main_ts">Testing Entry Points (main.ts)</a>
2052
+ <ul class="sectlevel2">
2053
+ <li>
2054
+ <a href="#_workaround_for_dynamic_imports_with_webpackts_ts1323">Workaround for Dynamic Imports with Webpack/TS (TS1323)</a>
2055
+ </li>
2056
+ </ul>
2057
+ </li>
2058
+ <li><a href="#_eslint_type_safety_in_tests">ESLint &amp; Type Safety in Tests</a></li>
2059
+ <li><a href="#_example_testing_a_grid_engine">Example: Testing a Grid Engine</a></li>
2060
+ </ul>
2061
+ </div>
2062
+ </div>
2063
+ <div id="content">
2064
+ <div id="preamble">
2065
+ <div class="sectionbody">
2066
+ <div class="paragraph">
2067
+ <p>
2068
+ This document defines the standards and best practices for unit testing in the Brick Engine project using <strong>Vitest</strong>.
2069
+ It is designed to be easily parsed by both developers and AI assistants.
2070
+ </p>
2071
+ </div>
2072
+ </div>
2073
+ </div>
2074
+ <div class="sect1">
2075
+ <h2 id="_core_pattern_triple_a_aaa">Core Pattern: Triple A (AAA)</h2>
2076
+ <div class="sectionbody">
2077
+ <div class="paragraph">
2078
+ <p>
2079
+ All tests must follow the <strong>Arrange, Act, Assert</strong> pattern. Use explicit comments to demarcate these phases, as this
2080
+ helps AI models understand the test logic context.
2081
+ </p>
2082
+ </div>
2083
+ <div class="sect2">
2084
+ <h3 id="_arrange">[ARRANGE]</h3>
2085
+ <div class="paragraph">
2086
+ <p>Set up the test environment, prepare data, and initialize the object under test.</p>
2087
+ </div>
2088
+ <div class="listingblock">
2089
+ <div class="content">
2090
+ <pre class="highlight"><code class="language-typescript" data-lang="typescript">// [ARRANGE]
492
2091
  const grid = new GameGrid();
493
2092
  const coordinate = { x: 5, y: 5 };</code></pre>
494
- </div>
495
- </div>
496
- </div>
497
- <div class="sect2">
498
- <h3 id="_act">[ACT]</h3>
499
- <div class="paragraph">
500
- <p>Execute the specific method or behavior being tested. Limit this to a single action if possible.</p>
501
- </div>
502
- <div class="listingblock">
503
- <div class="content">
504
- <pre class="highlight"><code class="language-typescript" data-lang="typescript">// [ACT]
2093
+ </div>
2094
+ </div>
2095
+ </div>
2096
+ <div class="sect2">
2097
+ <h3 id="_act">[ACT]</h3>
2098
+ <div class="paragraph">
2099
+ <p>Execute the specific method or behavior being tested. Limit this to a single action if possible.</p>
2100
+ </div>
2101
+ <div class="listingblock">
2102
+ <div class="content">
2103
+ <pre class="highlight"><code class="language-typescript" data-lang="typescript">// [ACT]
505
2104
  const result = grid.isCoordinateValid(coordinate);</code></pre>
506
- </div>
507
- </div>
508
- </div>
509
- <div class="sect2">
510
- <h3 id="_assert">[ASSERT]</h3>
511
- <div class="paragraph">
512
- <p>Verify the outcome. Use descriptive expectations.</p>
513
- </div>
514
- <div class="listingblock">
515
- <div class="content">
516
- <pre class="highlight"><code class="language-typescript" data-lang="typescript">// [ASSERT]
2105
+ </div>
2106
+ </div>
2107
+ </div>
2108
+ <div class="sect2">
2109
+ <h3 id="_assert">[ASSERT]</h3>
2110
+ <div class="paragraph">
2111
+ <p>Verify the outcome. Use descriptive expectations.</p>
2112
+ </div>
2113
+ <div class="listingblock">
2114
+ <div class="content">
2115
+ <pre class="highlight"><code class="language-typescript" data-lang="typescript">// [ASSERT]
517
2116
  expect(result).toBe(true);</code></pre>
518
- </div>
519
- </div>
520
- </div>
521
- </div>
522
- </div>
523
- <div class="sect1">
524
- <h2 id="_naming_conventions">Naming Conventions</h2>
525
- <div class="sectionbody">
526
- <div class="paragraph">
527
- <p>Test descriptions should follow the pattern: <code>should [expected result] when [scenario or action]</code>.</p>
528
- </div>
529
- <div class="ulist">
530
- <ul>
531
- <li>
532
- <p><strong>Bad:</strong> <code>test grid validation</code></p>
533
- </li>
534
- <li>
535
- <p><strong>Good:</strong> <code>should return true when coordinate is within grid boundaries</code></p>
536
- </li>
537
- </ul>
538
- </div>
539
- </div>
540
- </div>
541
- <div class="sect1">
542
- <h2 id="_ai_assisted_testing_best_practices">AI-Assisted Testing Best Practices</h2>
543
- <div class="sectionbody">
544
- <div class="paragraph">
545
- <p>To facilitate AI-driven test generation and debugging:</p>
546
- </div>
547
- <div class="olist arabic">
548
- <ol class="arabic">
549
- <li>
550
- <p><strong>Be Explicit</strong>: Use the <code>// [ARRANGE]</code>, <code>// [ACT]</code>, and <code>// [ASSERT]</code> tags.</p>
551
- </li>
552
- <li>
553
- <p><strong>Context Injection</strong>: When asking an AI to write a test, provide the interface of the module and dependencies.</p>
554
- </li>
555
- <li>
556
- <p><strong>One Logic per Test</strong>: Avoid "Giant Tests". Test one specific behavior per <code>it</code> block.</p>
557
- </li>
558
- <li>
559
- <p><strong>Mocking Constants</strong>: Always mock global configurations (like <code>configs</code>) to ensure tests are deterministic.</p>
560
- </li>
561
- </ol>
562
- </div>
563
- </div>
564
- </div>
565
- <div class="sect1">
566
- <h2 id="_vitest_configuration_standard">Vitest Configuration Standard</h2>
567
- <div class="sectionbody">
568
- <div class="ulist">
569
- <ul>
570
- <li>
571
- <p><strong>Globals</strong>: Use <code>globals: true</code> to avoid importing <code>describe</code>, <code>it</code>, <code>expect</code> in every file.</p>
572
- </li>
573
- <li>
574
- <p><strong>Environment</strong>: Use <code>@vitest-environment jsdom</code> at the top of files that interact with DOM or p5.js.</p>
575
- </li>
576
- <li>
577
- <p><strong>Coverage</strong>: Target at least 80% coverage for "Engines" and "Helpers".</p>
578
- </li>
579
- <li>
580
- <p><strong>Aliases</strong>: If using bundler aliases (e.g., <code>@client-game</code>), define them in <code>vitest.config.ts</code> using <code>resolve.alias</code>.</p>
581
- </li>
582
- </ul>
583
- </div>
584
- </div>
585
- </div>
586
- <div class="sect1">
587
- <h2 id="_advanced_mocking_stubs">Advanced Mocking &amp; Stubs</h2>
588
- <div class="sectionbody">
589
- <div class="sect2">
590
- <h3 id="_mocking_browser_apis">Mocking Browser APIs</h3>
591
- <div class="paragraph">
592
- <p>For tests requiring browser features in JSDOM:</p>
593
- </div>
594
- <div class="listingblock">
595
- <div class="content">
596
- <pre class="highlight"><code class="language-typescript" data-lang="typescript">// [ARRANGE]
2117
+ </div>
2118
+ </div>
2119
+ </div>
2120
+ </div>
2121
+ </div>
2122
+ <div class="sect1">
2123
+ <h2 id="_naming_conventions">Naming Conventions</h2>
2124
+ <div class="sectionbody">
2125
+ <div class="paragraph">
2126
+ <p>Test descriptions should follow the pattern: <code>should [expected result] when [scenario or action]</code>.</p>
2127
+ </div>
2128
+ <div class="ulist">
2129
+ <ul>
2130
+ <li>
2131
+ <p><strong>Bad:</strong> <code>test grid validation</code></p>
2132
+ </li>
2133
+ <li>
2134
+ <p><strong>Good:</strong> <code>should return true when coordinate is within grid boundaries</code></p>
2135
+ </li>
2136
+ </ul>
2137
+ </div>
2138
+ </div>
2139
+ </div>
2140
+ <div class="sect1">
2141
+ <h2 id="_ai_assisted_testing_best_practices">AI-Assisted Testing Best Practices</h2>
2142
+ <div class="sectionbody">
2143
+ <div class="paragraph">
2144
+ <p>To facilitate AI-driven test generation and debugging:</p>
2145
+ </div>
2146
+ <div class="olist arabic">
2147
+ <ol class="arabic">
2148
+ <li>
2149
+ <p>
2150
+ <strong>Be Explicit</strong>: Use the <code>// [ARRANGE]</code>, <code>// [ACT]</code>, and <code>// [ASSERT]</code> tags.
2151
+ </p>
2152
+ </li>
2153
+ <li>
2154
+ <p>
2155
+ <strong>Context Injection</strong>: When asking an AI to write a test, provide the interface of the module and dependencies.
2156
+ </p>
2157
+ </li>
2158
+ <li>
2159
+ <p><strong>One Logic per Test</strong>: Avoid "Giant Tests". Test one specific behavior per <code>it</code> block.</p>
2160
+ </li>
2161
+ <li>
2162
+ <p>
2163
+ <strong>Mocking Constants</strong>: Always mock global configurations (like <code>configs</code>) to ensure tests are
2164
+ deterministic.
2165
+ </p>
2166
+ </li>
2167
+ </ol>
2168
+ </div>
2169
+ </div>
2170
+ </div>
2171
+ <div class="sect1">
2172
+ <h2 id="_vitest_configuration_standard">Vitest Configuration Standard</h2>
2173
+ <div class="sectionbody">
2174
+ <div class="ulist">
2175
+ <ul>
2176
+ <li>
2177
+ <p>
2178
+ <strong>Globals</strong>: Use <code>globals: true</code> to avoid importing <code>describe</code>, <code>it</code>,
2179
+ <code>expect</code> in every file.
2180
+ </p>
2181
+ </li>
2182
+ <li>
2183
+ <p>
2184
+ <strong>Environment</strong>: Use <code>@vitest-environment jsdom</code> at the top of files that interact with DOM or
2185
+ p5.js.
2186
+ </p>
2187
+ </li>
2188
+ <li>
2189
+ <p><strong>Coverage</strong>: Target at least 80% coverage for "Engines" and "Helpers".</p>
2190
+ </li>
2191
+ <li>
2192
+ <p>
2193
+ <strong>Aliases</strong>: If using bundler aliases (e.g., <code>@client-game</code>), define them in
2194
+ <code>vitest.config.ts</code> using <code>resolve.alias</code>.
2195
+ </p>
2196
+ </li>
2197
+ </ul>
2198
+ </div>
2199
+ </div>
2200
+ </div>
2201
+ <div class="sect1">
2202
+ <h2 id="_advanced_mocking_stubs">Advanced Mocking &amp; Stubs</h2>
2203
+ <div class="sectionbody">
2204
+ <div class="sect2">
2205
+ <h3 id="_mocking_browser_apis">Mocking Browser APIs</h3>
2206
+ <div class="paragraph">
2207
+ <p>For tests requiring browser features in JSDOM:</p>
2208
+ </div>
2209
+ <div class="listingblock">
2210
+ <div class="content">
2211
+ <pre class="highlight"><code class="language-typescript" data-lang="typescript">// [ARRANGE]
597
2212
  vi.stubGlobal('localStorage', {
598
2213
  getItem: vi.fn(),
599
2214
  setItem: vi.fn(),
@@ -605,86 +2220,101 @@ vi.stubGlobal('AudioContext', vi.fn().mockImplementation(function() {
605
2220
  destination: {},
606
2221
  };
607
2222
  }));</code></pre>
608
- </div>
609
- </div>
610
- </div>
611
- <div class="sect2">
612
- <h3 id="_constructible_mocks">Constructible Mocks</h3>
613
- <div class="paragraph">
614
- <p>When mocking a class that will be instantiated with <code>new</code>, Vitest requires the mock to be a <code>function</code> or <code>class</code>:</p>
615
- </div>
616
- <div class="listingblock">
617
- <div class="content">
618
- <pre class="highlight"><code class="language-typescript" data-lang="typescript">vi.mock('./MyModule', () =&gt; ({
2223
+ </div>
2224
+ </div>
2225
+ </div>
2226
+ <div class="sect2">
2227
+ <h3 id="_constructible_mocks">Constructible Mocks</h3>
2228
+ <div class="paragraph">
2229
+ <p>
2230
+ When mocking a class that will be instantiated with <code>new</code>, Vitest requires the mock to be a <code>function</code> or
2231
+ <code>class</code>:
2232
+ </p>
2233
+ </div>
2234
+ <div class="listingblock">
2235
+ <div class="content">
2236
+ <pre class="highlight"><code class="language-typescript" data-lang="typescript">vi.mock('./MyModule', () =&gt; ({
619
2237
  default: vi.fn().mockImplementation(function() {
620
2238
  return {
621
2239
  doSomething: vi.fn()
622
2240
  };
623
2241
  })
624
2242
  }));</code></pre>
625
- </div>
626
- </div>
627
- </div>
628
- <div class="sect2">
629
- <h3 id="_hoisted_variables">Hoisted Variables</h3>
630
- <div class="paragraph">
631
- <p>If you need to share variables between your test and the <code>vi.mock</code> factory (which is hoisted), use <code>vi.hoisted</code>:</p>
632
- </div>
633
- <div class="listingblock">
634
- <div class="content">
635
- <pre class="highlight"><code class="language-typescript" data-lang="typescript">const { mockRef } = vi.hoisted(() =&gt; ({
2243
+ </div>
2244
+ </div>
2245
+ </div>
2246
+ <div class="sect2">
2247
+ <h3 id="_hoisted_variables">Hoisted Variables</h3>
2248
+ <div class="paragraph">
2249
+ <p>
2250
+ If you need to share variables between your test and the <code>vi.mock</code> factory (which is hoisted), use
2251
+ <code>vi.hoisted</code>:
2252
+ </p>
2253
+ </div>
2254
+ <div class="listingblock">
2255
+ <div class="content">
2256
+ <pre class="highlight"><code class="language-typescript" data-lang="typescript">const { mockRef } = vi.hoisted(() =&gt; ({
636
2257
  mockRef: { id: 1 }
637
2258
  }));
638
2259
 
639
2260
  vi.mock('./module', () =&gt; ({
640
2261
  default: () =&gt; mockRef
641
2262
  }));</code></pre>
642
- </div>
643
- </div>
644
- </div>
645
- </div>
646
- </div>
647
- <div class="sect1">
648
- <h2 id="_testing_entry_points_main_ts">Testing Entry Points (main.ts)</h2>
649
- <div class="sectionbody">
650
- <div class="paragraph">
651
- <p>Tests for entry points that execute code on import require isolation:</p>
652
- </div>
653
- <div class="olist arabic">
654
- <ol class="arabic">
655
- <li>
656
- <p>Use <code>vi.resetModules()</code> in <code>beforeEach</code>.</p>
657
- </li>
658
- <li>
659
- <p>Use dynamic <code>import()</code> within the <code>it</code> block.</p>
660
- </li>
661
- <li>
662
- <p>Set environment flags (like <code>APP_MODE</code>) <strong>before</strong> the dynamic import.</p>
663
- </li>
664
- </ol>
665
- </div>
666
- <div class="listingblock">
667
- <div class="content">
668
- <pre class="highlight"><code class="language-typescript" data-lang="typescript">it('should init in client mode', async () =&gt; {
2263
+ </div>
2264
+ </div>
2265
+ </div>
2266
+ </div>
2267
+ </div>
2268
+ <div class="sect1">
2269
+ <h2 id="_testing_entry_points_main_ts">Testing Entry Points (main.ts)</h2>
2270
+ <div class="sectionbody">
2271
+ <div class="paragraph">
2272
+ <p>Tests for entry points that execute code on import require isolation:</p>
2273
+ </div>
2274
+ <div class="olist arabic">
2275
+ <ol class="arabic">
2276
+ <li>
2277
+ <p>Use <code>vi.resetModules()</code> in <code>beforeEach</code>.</p>
2278
+ </li>
2279
+ <li>
2280
+ <p>Use dynamic <code>import()</code> within the <code>it</code> block.</p>
2281
+ </li>
2282
+ <li>
2283
+ <p>Set environment flags (like <code>APP_MODE</code>) <strong>before</strong> the dynamic import.</p>
2284
+ </li>
2285
+ </ol>
2286
+ </div>
2287
+ <div class="listingblock">
2288
+ <div class="content">
2289
+ <pre class="highlight"><code class="language-typescript" data-lang="typescript">it('should init in client mode', async () =&gt; {
669
2290
  (isClientMode as vi.Mock).mockReturnValue(true);
670
2291
  await import('./main'); // Triggers execution
671
2292
  expect(p5).toHaveBeenCalled();
672
2293
  });</code></pre>
673
- </div>
674
- </div>
675
- <div class="sect2">
676
- <h3 id="_workaround_for_dynamic_imports_with_webpackts_ts1323">Workaround for Dynamic Imports with Webpack/TS (TS1323)</h3>
677
- <div class="paragraph">
678
- <p>When the project uses a <code>tsconfig.json</code> meant for the browser (e.g., configuring <code>module: commonjs</code>), running bundlers like <code>webpack</code> over the test files can trigger <strong>TS1323</strong> because the TS compiler doesn&#8217;t understand the dynamic inputs naturally.</p>
679
- </div>
680
- <div class="paragraph">
681
- <p><strong>To resolve this properly without ANY <code>@ts-expect-error</code>:</strong>
682
- 1. Set the <code>module</code> resolving option in <code>tsconfig.json</code> to <code>"ESNext"</code> or <code>"ES2020"</code> so TS allows dynamic imports. Webpack can still easily compile it targeting ES5.
683
- 2. Create ambient definition files (e.g., <code>src/client-game.d.ts</code>) containing module declarations (<code>declare module '@client-game';</code>) to resolve TS2307 dynamically missing paths.</p>
684
- </div>
685
- <div class="listingblock">
686
- <div class="content">
687
- <pre class="highlight"><code class="language-typescript" data-lang="typescript">it('should init in client mode', async () =&gt; {
2294
+ </div>
2295
+ </div>
2296
+ <div class="sect2">
2297
+ <h3 id="_workaround_for_dynamic_imports_with_webpackts_ts1323">Workaround for Dynamic Imports with Webpack/TS (TS1323)</h3>
2298
+ <div class="paragraph">
2299
+ <p>
2300
+ When the project uses a <code>tsconfig.json</code> meant for the browser (e.g., configuring <code>module: commonjs</code>),
2301
+ running bundlers like <code>webpack</code> over the test files can trigger <strong>TS1323</strong> because the TS compiler
2302
+ doesn&#8217;t understand the dynamic inputs naturally.
2303
+ </p>
2304
+ </div>
2305
+ <div class="paragraph">
2306
+ <p>
2307
+ <strong>To resolve this properly without ANY <code>@ts-expect-error</code>:</strong> 1. Set the <code>module</code> resolving
2308
+ option in <code>tsconfig.json</code> to <code>"ESNext"</code> or <code>"ES2020"</code> so TS allows dynamic imports. Webpack can
2309
+ still easily compile it targeting ES5. 2. Create ambient definition files (e.g., <code>src/client-game.d.ts</code>) containing
2310
+ module declarations (<code>declare module '@client-game';</code>) to resolve TS2307 dynamically missing paths.
2311
+ </p>
2312
+ </div>
2313
+ <div class="listingblock">
2314
+ <div class="content">
2315
+ <pre
2316
+ class="highlight"
2317
+ ><code class="language-typescript" data-lang="typescript">it('should init in client mode', async () =&gt; {
688
2318
  // Both dynamic imports work natively without errors!
689
2319
  const { isClientMode } = await import('./config/env');
690
2320
  (isClientMode as unknown as Mock).mockReturnValue(true);
@@ -694,38 +2324,49 @@ vi.mock('./module', () =&gt; ({
694
2324
 
695
2325
  // ... assertions ...
696
2326
  });</code></pre>
697
- </div>
698
- </div>
699
- </div>
700
- </div>
701
- </div>
702
- <div class="sect1">
703
- <h2 id="_eslint_type_safety_in_tests">ESLint &amp; Type Safety in Tests</h2>
704
- <div class="sectionbody">
705
- <div class="paragraph">
706
- <p>Maintain code quality even in tests:</p>
707
- </div>
708
- <div class="ulist">
709
- <ul>
710
- <li>
711
- <p><strong>Avoid <code>any</code></strong>: Use <code>unknown as vi.Mock</code> or cast to specific interfaces.</p>
712
- </li>
713
- <li>
714
- <p><strong>Private Members</strong>: Use <code>// @ts-expect-error</code> or <code>(instance as any)._privateProp</code> only when absolutely necessary to verify internal state, but prefer testing public behavior.</p>
715
- </li>
716
- <li>
717
- <p><strong>Mock Dependencies</strong>: Mock sub-packages (e.g., <code>view</code> or <code>manager</code>) when testing core orchestrators to isolate logic.</p>
718
- </li>
719
- </ul>
720
- </div>
721
- </div>
722
- </div>
723
- <div class="sect1">
724
- <h2 id="_example_testing_a_grid_engine">Example: Testing a Grid Engine</h2>
725
- <div class="sectionbody">
726
- <div class="listingblock">
727
- <div class="content">
728
- <pre class="highlight"><code class="language-typescript" data-lang="typescript">import { describe, it, expect, beforeEach, vi } from 'vitest';
2327
+ </div>
2328
+ </div>
2329
+ </div>
2330
+ </div>
2331
+ </div>
2332
+ <div class="sect1">
2333
+ <h2 id="_eslint_type_safety_in_tests">ESLint &amp; Type Safety in Tests</h2>
2334
+ <div class="sectionbody">
2335
+ <div class="paragraph">
2336
+ <p>Maintain code quality even in tests:</p>
2337
+ </div>
2338
+ <div class="ulist">
2339
+ <ul>
2340
+ <li>
2341
+ <p>
2342
+ <strong>Avoid <code>any</code></strong
2343
+ >: Use <code>unknown as vi.Mock</code> or cast to specific interfaces.
2344
+ </p>
2345
+ </li>
2346
+ <li>
2347
+ <p>
2348
+ <strong>Private Members</strong>: Use <code>// @ts-expect-error</code> or <code>(instance as any)._privateProp</code> only
2349
+ when absolutely necessary to verify internal state, but prefer testing public behavior.
2350
+ </p>
2351
+ </li>
2352
+ <li>
2353
+ <p>
2354
+ <strong>Mock Dependencies</strong>: Mock sub-packages (e.g., <code>view</code> or <code>manager</code>) when testing core
2355
+ orchestrators to isolate logic.
2356
+ </p>
2357
+ </li>
2358
+ </ul>
2359
+ </div>
2360
+ </div>
2361
+ </div>
2362
+ <div class="sect1">
2363
+ <h2 id="_example_testing_a_grid_engine">Example: Testing a Grid Engine</h2>
2364
+ <div class="sectionbody">
2365
+ <div class="listingblock">
2366
+ <div class="content">
2367
+ <pre
2368
+ class="highlight"
2369
+ ><code class="language-typescript" data-lang="typescript">import { describe, it, expect, beforeEach, vi } from 'vitest';
729
2370
  import GridAnalysisEngine from './GridAnalysisEngine';
730
2371
  import { Grid } from '../../../types/modules';
731
2372
 
@@ -756,15 +2397,13 @@ describe('GridAnalysisEngine', () =&gt; {
756
2397
  expect(fullRows.length).toBe(1);
757
2398
  });
758
2399
  });</code></pre>
759
- </div>
760
- </div>
761
- </div>
762
- </div>
763
- </div>
764
- <div id="footer">
765
- <div id="footer-text">
766
- Last updated 2026-02-25 16:03:50 -0300
767
- </div>
768
- </div>
769
- </body>
770
- </html>
2400
+ </div>
2401
+ </div>
2402
+ </div>
2403
+ </div>
2404
+ </div>
2405
+ <div id="footer">
2406
+ <div id="footer-text">Last updated 2026-02-25 16:03:50 -0300</div>
2407
+ </div>
2408
+ </body>
2409
+ </html>