Add attributes documentation and a little more improvements

Author: SerafimArts

.github/workflows/deploy.yml

@@ -17,7 +17,7 @@ env:
   # Replace HI with the ID of the instance in capital letters
   ARTIFACT: webHelpTL2-all.zip
   # Writerside docker image version
-  DOCKER_VERSION: 233.14938
+  DOCKER_VERSION: 242.21870
   # Add the variable below to upload Algolia indexes
   # Replace HI with the ID of the instance in capital letters
   ALGOLIA_ARTIFACT: algolia-indexes-TL.zip

Writerside/cfg/buildprofiles.xml

@@ -4,13 +4,14 @@
     <sitemap priority="0.35" change-frequency="monthly"/>
 
     <variables>
-        <primary-color>blueberry</primary-color>
-        <color-preset>vivid</color-preset>
+        <primary-color>#2e44b2</primary-color>
+        <link-color>#1f55be</link-color>
+        <color-preset>contrast</color-preset>
         <custom-favicons>logo.svg</custom-favicons>
         <header-logo>logo.svg</header-logo>
         <product-web-url>https://typelang.dev</product-web-url>
         <noindex-content>false</noindex-content>
-        <offline-docs>true</offline-docs>
+        <offline-docs>false</offline-docs>
 
         <feedback-url>https://github.com/php-type-language/docs/issues</feedback-url>
         <web-root>/</web-root>
@@ -21,8 +22,9 @@
         <download-page>https://github.com/php-type-language</download-page>
         <showDownloadButton>true</showDownloadButton>
 
-        <enable-browser-edits>true</enable-browser-edits>
-        <browser-edits-url>https://github.com/php-type-language/docs/blob/master/Writerside/</browser-edits-url>
+        <enable-contribution>true</enable-contribution>
+        <contribute-url>https://github.com/php-type-language/docs/blob/master/Writerside/</contribute-url>
+        <custom-css>custom.css</custom-css>
     </variables>
 
     <icons>
@@ -31,6 +33,7 @@
 
     <footer>
         <social href="https://github.com/php-type-language" type="blog">GitHub</social>
+        <link href="https://packagist.org/packages/type-lang/parser">Packagist</link>
         <link href="https://github.com/php-type-language/parser/issues">Issue tracker</link>
         <link href="https://github.com/php-type-language/parser/pulls">Submit request</link>
         <copyright>PHP TypeLang</copyright>

Writerside/cfg/static/custom.css

@@ -0,0 +1,24 @@
+.article > .prompt {
+    max-width: auto !important;
+}
+
+.prompt__wrapper {
+    display: flex;
+}
+
+.prompt__content {
+    overflow: visible;
+}
+
+.prompt__wrapper > .prompt__content {
+    flex: 1;
+}
+
+.article__list + .code-block__wrapper,
+.article__list + .code-collapse__wrapper,
+p + .code-block__wrapper,
+p + .code-collapse__wrapper,
+.code-block__wrapper + .code-collapse__wrapper,
+.code-block__wrapper + .code-block__wrapper {
+    margin-top: 12px !important;
+}

Writerside/labels.list

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE labels SYSTEM "https://resources.jetbrains.com/writerside/1.0/labels-list.dtd">
+<labels xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/labels.xsd">
+    <primary-label id="component" name="Component" short-name="C" color="purple">
+        The implementation of the functionality available for installation
+    </primary-label>
+
+    <secondary-label id="psalm" name="Psalm" color="blue">
+        Also partially or fully supported by Psalm Linter.
+        Check out Psalm documentation for more details.
+    </secondary-label>
+    <secondary-label id="phpstan" name="PHPStan" color="blue">
+        Also partially or fully supported by PHPStan Linter.
+        Check out PHPStan documentation for more details.
+    </secondary-label>
+    <secondary-label id="storm" name="PhpStorm" color="blue">
+        Also partially or fully supported by PhpStorm IDE.
+        Check out PhpStorm documentation for more details.
+    </secondary-label>
+
+    <secondary-label id="wip" name="WIP" color="red">Work in progress</secondary-label>
+    <secondary-label id="beta" name="β" color="tangerine">Beta</secondary-label>
+    <secondary-label id="1.1" name="TypeLang 1.1" color="strawberry">Since type-lang/parser v1.1</secondary-label>
+</labels>

Writerside/tl.tree

@@ -2,12 +2,7 @@
 <!DOCTYPE instance-profile
         SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
 
-<instance-profile id="tl"
-                  name="PHP TypeLang"
-                  status="eap"
-                  is-library="true"
-                  start-page="overview.topic">
-
+<instance-profile id="tl" name="PHP TypeLang" is-library="true" start-page="overview.topic">
     <toc-element topic="overview.topic" />
 
     <toc-element topic="language.md" toc-title="Syntax">
@@ -18,10 +13,12 @@
         <toc-element topic="const-types.md" toc-title="Constants"/>
         <toc-element topic="shape-types.md" toc-title="Shapes"/>
         <toc-element topic="callable-types.md" toc-title="Callables"/>
-        <toc-element topic="conditional-types.md" toc-title="Conditions" hidden="true"/>
+        <toc-element topic="conditional-types.md" toc-title="Conditions"/>
     </toc-element>
 
     <toc-element topic="parser.md" toc-title="Parser">
+        <toc-element topic="features.md"/>
+        <toc-element topic="tolerant-mode.md"/>
         <toc-element topic="visitors.md">
             <toc-element topic="class-name-matcher-visitor.md"/>
             <toc-element topic="stream-dumper-visitor.md"/>

Writerside/topics/language.md

@@ -44,17 +44,17 @@ General table across all type parsing capabilities
     <tr>
         <td>
             <note>
-                <format style="bold" color="DarkSeaGreen">60/60</format>
+                <format style="bold" color="DarkSeaGreen">62/62</format>
             </note>
         </td>
         <td>
             <warning>
-                <format style="bold" color="RosyBrown">42/60</format>
+                <format style="bold" color="RosyBrown">42/62</format>
             </warning>
         </td>
         <td>
             <warning>
-                <format style="bold" color="RosyBrown">46/60</format>
+                <format style="bold" color="RosyBrown">46/62</format>
             </warning>
         </td>
     </tr>
@@ -217,6 +217,28 @@ Below is a list of simple, logical and other common types.
             </a>
         </td>
     </tr>
+    <tr>
+        <td colspan="4">
+            <a href="generic-types.md" anchor="attributes">
+                Template argument attributes
+            </a>
+            <code-block lang="typescript">
+                ExampleCollection&lt;#[assert(not&lt;"0">)] array-key>
+            </code-block>
+        </td>
+    </tr>
+    <tr>
+        <td></td>
+        <td><icon src="ok.svg"/></td>
+        <td>
+            <icon src="ko.svg"/>
+            Not Supported
+        </td>
+        <td>
+            <icon src="ko.svg"/>
+            Not Supported
+        </td>
+    </tr>
     <tr>
         <td></td>
         <td colspan="3">
@@ -308,17 +330,17 @@ Below is a list of simple, logical and other common types.
         <td></td>
         <td>
             <note>
-                <format style="bold" color="DarkSeaGreen">11/11</format>
+                <format style="bold" color="DarkSeaGreen">11/12</format>
             </note>
         </td>
         <td>
             <warning>
-                <format style="bold" color="RosyBrown">9/11</format>
+                <format style="bold" color="RosyBrown">9/12</format>
             </warning>
         </td>
         <td>
             <warning>
-                <format style="bold" color="RosyBrown">10/11</format>
+                <format style="bold" color="RosyBrown">10/12</format>
             </warning>
         </td>
     </tr>
@@ -1410,22 +1432,41 @@ Below is a list of grammar of shaped types.
             </deflist>
         </td>
     </tr>
+    <tr>
+        <td colspan="4">
+            <a href="shape-types.md" anchor="attributes">
+                Shape field attributes
+            </a>
+            <code-block lang="typescript">
+            object {
+                #[inline, assert(not&lt;"">)]
+                name: string
+            }
+            </code-block>
+        </td>
+    </tr>
+    <tr>
+        <td></td>
+        <td><icon src="ok.svg"/></td>
+        <td><icon src="ko.svg"/></td>
+        <td><icon src="ko.svg"/></td>
+    </tr>
     <tr>
         <td></td>
         <td>
             <note>
-                <format style="bold" color="DarkSeaGreen">10/10</format>
+                <format style="bold" color="DarkSeaGreen">11/11</format>
             </note>
         </td>
         <td>
             <warning>
-                <format style="bold" color="RosyBrown">9/10</format>
+                <format style="bold" color="RosyBrown">9/11</format>
             </warning>
         </td>
         <td>
-            <note>
-                <format style="bold" color="DarkSeaGreen">10/10</format>
-            </note>
+            <warning>
+                <format style="bold" color="RosyBrown">10/11</format>
+            </warning>
         </td>
     </tr>
 </table>

Writerside/topics/language/basic-types.md

@@ -1,5 +1,8 @@
 # Basic Types
 
+<secondary-label ref="phpstan"/>
+<secondary-label ref="psalm"/>
+<secondary-label ref="storm"/>
 <show-structure for="chapter" depth="2"/>
 
 The parser does not impose restrictions on type naming. The type name must begin
@@ -24,21 +27,18 @@ is **unacceptable**.
 > ```typescript
 > ExampleTypeName
 > ```
-> {style="note"}
 
 > Dashes (`-`) in <tooltip term="Identifier">Identifier</tooltip> are also 
 > acceptable.
 > ```typescript
 > example-type
 > ```
-> {style="note"}
 
 > The reserved keyword (`true`) is allowed as part of the <tooltip
 > term="Identifier">Identifier</tooltip>.
 > ```typescript
 > true-type
 > ```
-> {style="note"}
 
 </tab>
 <tab title="Counterexamples">
@@ -48,29 +48,38 @@ is **unacceptable**.
 > literal value rather than an <tooltip term="Identifier">Identifier</tooltip>.
 > ```typescript
 > TrUe
-> 
-> // TypeLang\Parser\Node\Literal\BoolLiteralNode {
-> //    +offset: 0
-> //    +raw: "TrUe"
-> //    +value: true
-> // }
 > ```
+> ```php
+> TypeLang\Parser\Node\Literal\BoolLiteralNode {
+>     +offset: 0
+>     +raw: "TrUe"
+>     +value: true
+> }
+> ```
+> {collapsible="true" collapsed-title="TypeLang\Parser\Node\Literal\BoolLiteralNode"}
+> 
 > {style="warning"}
 
 > <tooltip term="Identifier">Identifiers</tooltip> cannot begin with digits
 > (`0-9`) or a dash (`-`) symbol.
 > ```typescript
 > 42type
-> 
-> // Syntax error, unexpected "type"
 > ```
+> ```
+> Syntax error, unexpected "type"
+> ```
+> {collapsible="true" collapsed-title="TypeLang\Parser\Exception\ParseException"}
 > {style="warning"}
 
 </tab>
 </tabs>
 
 ## Namespace
 
+<secondary-label ref="phpstan"/>
+<secondary-label ref="psalm"/>
+<secondary-label ref="storm"/>
+
 Each name can contain a namespace symbol (`\` — backslash), which is 
 [similar to that in PHP](https://www.php.net/manual/en/language.namespaces.rationale.php). The separator can be located either in the middle
 or at the beginning of any <tooltip term="Identifier">Identifier</tooltip>. End
@@ -86,13 +95,11 @@ The namespace delimiter can be used in conjunction with keywords such as `true`,
 > ```typescript
 > Example\Name
 > ```
-> {style="note"}
 
 > Absolute class <tooltip term="FQN">FQN</tooltip> reference.
 > ```typescript
 > \Absolute\Type\Name
 > ```
-> {style="note"}
 
 </tab>
 <tab title="Counterexamples">
@@ -101,17 +108,21 @@ The namespace delimiter can be used in conjunction with keywords such as `true`,
 > reserved for literal values.
 > ```typescript
 > true\null
-> 
-> // Syntax error, unexpected "\"
 > ```
+> ```
+> Syntax error, unexpected "\"
+> ```
+> {collapsible="true" collapsed-title="TypeLang\Parser\Exception\ParseException"}
 > {style="warning"}
 
 > <tooltip term="FQN">FQN</tooltip> type names cannot end in `\` delimiter.
 > ```typescript
 > example\name\
->
-> // Syntax error, unexpected end of input
 > ```
+> ```
+> Syntax error, unexpected end of input
+> ```
+> {collapsible="true" collapsed-title="TypeLang\Parser\Exception\ParseException"}
 > {style="warning"}
 
 </tab>