Skip to content

Commit fae6958

Browse files
committed
Add reader and docs to subsplit
1 parent 1f47213 commit fae6958

19 files changed

Lines changed: 487 additions & 190 deletions

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ env:
1717
# Replace HI with the ID of the instance in capital letters
1818
ARTIFACT: webHelpTL2-all.zip
1919
# Writerside docker image version
20-
DOCKER_VERSION: '2025.04.8412'
20+
DOCKER_VERSION: '2026.06.8817'
2121
CONFIG_JSON_PRODUCT: 'TL'
2222
CONFIG_JSON_VERSION: '1.0'
2323

.idea/.gitignore

Lines changed: 0 additions & 3 deletions
This file was deleted.

.idea/docs.iml

Lines changed: 0 additions & 8 deletions
This file was deleted.

.idea/modules.xml

Lines changed: 0 additions & 8 deletions
This file was deleted.

.idea/vcs.xml

Lines changed: 0 additions & 6 deletions
This file was deleted.

Writerside/labels.list

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,9 @@
4848

4949
<secondary-label id="wip" name="WIP" color="red">Work in progress</secondary-label>
5050
<secondary-label id="beta" name="β" color="tangerine">Beta</secondary-label>
51-
<secondary-label id="tl1.1" name="parser v1.1" color="strawberry">Available since type-lang/parser 1.1+</secondary-label>
52-
<secondary-label id="tl1.2" name="parser v1.2" color="strawberry">Available since type-lang/parser 1.2+</secondary-label>
53-
<secondary-label id="tl1.4" name="parser v1.4" color="strawberry">Available since type-lang/parser 1.4+</secondary-label>
54-
<secondary-label id="r1.1" name="reader v1.1" color="strawberry">Available since type-lang/reader 1.1+</secondary-label>
55-
</labels>
51+
<secondary-label id="tl1.1" name="parser v1.1+" color="strawberry">Available since type-lang/parser 1.1+</secondary-label>
52+
<secondary-label id="tl1.2" name="parser v1.2+" color="strawberry">Available since type-lang/parser 1.2+</secondary-label>
53+
<secondary-label id="tl1.4" name="parser v1.4+" color="strawberry">Available since type-lang/parser 1.4+</secondary-label>
54+
<secondary-label id="tl1.6" name="parser v1.6+" color="strawberry">Available since type-lang/parser 1.6+</secondary-label>
55+
<secondary-label id="r1.1" name="reader v1.1+" color="strawberry">Available since type-lang/reader 1.1+</secondary-label>
56+
</labels>

Writerside/tl.tree

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,10 @@
2323
toc-title="Callables"/>
2424
<toc-element topic="offset-access.md"
2525
toc-title="Offsets"/>
26-
<!-- TODO -->
2726
<toc-element topic="conditional-types.md"
28-
toc-title="Conditions"
29-
hidden="true" />
30-
<toc-element topic="comparison.md"
31-
toc-title="Comparison of syntax between different tools" />
32-
33-
<toc-element toc-title="See also">
27+
toc-title="Conditions" />
28+
<toc-element toc-title="Community Tools"
29+
topic="comparison.md">
3430
<toc-element toc-title="PHPStan" href="https://phpstan.org/writing-php-code/phpdoc-types" />
3531
<toc-element toc-title="Psalm" href="https://psalm.dev/docs/annotating_code/typing_in_psalm/" />
3632
<toc-element toc-title="PhpStorm" href="https://www.jetbrains.com/help/phpstorm/php-type-checking.html" />

Writerside/topics/language/comparison.md

Lines changed: 140 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,17 +44,17 @@ General table across all type parsing capabilities
4444
<tr>
4545
<td>
4646
<note>
47-
<format style="bold" color="DarkSeaGreen">62/62</format>
47+
<format style="bold" color="DarkSeaGreen">69/69</format>
4848
</note>
4949
</td>
5050
<td>
5151
<warning>
52-
<format style="bold" color="RosyBrown">42/62</format>
52+
<format style="bold" color="RosyBrown">43/69</format>
5353
</warning>
5454
</td>
5555
<td>
5656
<warning>
57-
<format style="bold" color="RosyBrown">46/62</format>
57+
<format style="bold" color="RosyBrown">47/69</format>
5858
</warning>
5959
</td>
6060
</tr>
@@ -81,7 +81,7 @@ Below is a list of simple, logical and other common types.
8181
<td></td>
8282
<td>
8383
<note>
84-
<format style="bold" color="DarkSeaGreen">11/12</format>
84+
<format style="bold" color="DarkSeaGreen">12/12</format>
8585
</note>
8686
</td>
8787
<td>
@@ -367,17 +367,17 @@ Below is a list of conditional types.
367367
<td></td>
368368
<td>
369369
<note>
370-
<format style="bold" color="DarkSeaGreen">6/6</format>
370+
<format style="bold" color="DarkSeaGreen">10/10</format>
371371
</note>
372372
</td>
373373
<td>
374374
<warning>
375-
<format style="bold" color="RosyBrown">4/6</format>
375+
<format style="bold" color="RosyBrown">4/10</format>
376376
</warning>
377377
</td>
378378
<td>
379379
<warning>
380-
<format style="bold" color="RosyBrown">4/6</format>
380+
<format style="bold" color="RosyBrown">4/10</format>
381381
</warning>
382382
</td>
383383
</tr>
@@ -534,6 +534,94 @@ Below is a list of conditional types.
534534
</a>
535535
</td>
536536
</tr>
537+
<tr>
538+
<td colspan="4">
539+
<a href="conditional-types.md" anchor="comparison-operators">
540+
Less-than conditional types
541+
</a>
542+
<code-block lang="typescript">
543+
T &lt; A ? B : C
544+
</code-block>
545+
</td>
546+
</tr>
547+
<tr>
548+
<td></td>
549+
<td><icon src="ok.svg"/></td>
550+
<td>
551+
<icon src="ko.svg"/>
552+
Not Supported
553+
</td>
554+
<td>
555+
<icon src="ko.svg"/>
556+
Not Supported
557+
</td>
558+
</tr>
559+
<tr>
560+
<td colspan="4">
561+
<a href="conditional-types.md" anchor="comparison-operators">
562+
Greater-than conditional types
563+
</a>
564+
<code-block lang="typescript">
565+
T &gt; A ? B : C
566+
</code-block>
567+
</td>
568+
</tr>
569+
<tr>
570+
<td></td>
571+
<td><icon src="ok.svg"/></td>
572+
<td>
573+
<icon src="ko.svg"/>
574+
Not Supported
575+
</td>
576+
<td>
577+
<icon src="ko.svg"/>
578+
Not Supported
579+
</td>
580+
</tr>
581+
<tr>
582+
<td colspan="4">
583+
<a href="conditional-types.md" anchor="comparison-operators">
584+
Less-than-or-equal conditional types
585+
</a>
586+
<code-block lang="typescript">
587+
T &lt;= A ? B : C
588+
</code-block>
589+
</td>
590+
</tr>
591+
<tr>
592+
<td></td>
593+
<td><icon src="ok.svg"/></td>
594+
<td>
595+
<icon src="ko.svg"/>
596+
Not Supported
597+
</td>
598+
<td>
599+
<icon src="ko.svg"/>
600+
Not Supported
601+
</td>
602+
</tr>
603+
<tr>
604+
<td colspan="4">
605+
<a href="conditional-types.md" anchor="comparison-operators">
606+
Greater-than-or-equal conditional types
607+
</a>
608+
<code-block lang="typescript">
609+
T &gt;= A ? B : C
610+
</code-block>
611+
</td>
612+
</tr>
613+
<tr>
614+
<td></td>
615+
<td><icon src="ok.svg"/></td>
616+
<td>
617+
<icon src="ko.svg"/>
618+
Not Supported
619+
</td>
620+
<td>
621+
<icon src="ko.svg"/>
622+
Not Supported
623+
</td>
624+
</tr>
537625
</table>
538626

539627
## Literal Types
@@ -1043,17 +1131,17 @@ Below is a list of grammar of shaped types.
10431131
<td></td>
10441132
<td>
10451133
<note>
1046-
<format style="bold" color="DarkSeaGreen">11/11</format>
1134+
<format style="bold" color="DarkSeaGreen">13/13</format>
10471135
</note>
10481136
</td>
10491137
<td>
10501138
<warning>
1051-
<format style="bold" color="RosyBrown">9/11</format>
1139+
<format style="bold" color="RosyBrown">10/13</format>
10521140
</warning>
10531141
</td>
10541142
<td>
10551143
<warning>
1056-
<format style="bold" color="RosyBrown">10/11</format>
1144+
<format style="bold" color="RosyBrown">10/13</format>
10571145
</warning>
10581146
</td>
10591147
</tr>
@@ -1463,6 +1551,48 @@ Below is a list of grammar of shaped types.
14631551
</code-block>
14641552
</td>
14651553
</tr>
1554+
<tr>
1555+
<td></td>
1556+
<td><icon src="ok.svg"/></td>
1557+
<td>
1558+
<icon src="warning.svg"/>
1559+
<a href="https://github.com/phpstan/phpdoc-parser/releases/tag/2.3.0">
1560+
PHPStan parser only (since 2.3)
1561+
</a>
1562+
</td>
1563+
<td><icon src="ko.svg"/></td>
1564+
</tr>
1565+
<tr>
1566+
<td colspan="4">
1567+
<a href="shape-types.md" anchor="constant-keys">
1568+
Class constant shape keys
1569+
</a>
1570+
<code-block lang="typescript">
1571+
array{
1572+
Path\To\ClassName::CONSTANT_NAME: string,
1573+
}
1574+
</code-block>
1575+
</td>
1576+
</tr>
1577+
<tr>
1578+
<td></td>
1579+
<td><icon src="ok.svg"/></td>
1580+
<td><icon src="ko.svg"/></td>
1581+
<td><icon src="ko.svg"/></td>
1582+
</tr>
1583+
<tr>
1584+
<td colspan="4">
1585+
<a href="shape-types.md" anchor="constant-mask-keys">
1586+
Constant mask shape keys
1587+
</a>
1588+
<code-block lang="typescript">
1589+
array{
1590+
Path\To\ClassName::PREFIX_*: string,
1591+
JSON_*: string,
1592+
}
1593+
</code-block>
1594+
</td>
1595+
</tr>
14661596
<tr>
14671597
<td></td>
14681598
<td><icon src="ok.svg"/></td>

0 commit comments

Comments
 (0)