[FEATURE] Add script for generating the class diagram

Author: oliverklee

.gitignore

@@ -2,6 +2,7 @@
 /.php-cs-fixer.cache
 /.php_cs.cache
 /.phpunit.result.cache
+/class-diagram.md
 /composer.lock
 /coverage.xml
 /phpstan.neon

README.md

@@ -619,6 +619,7 @@ class Sabberworm\CSS\CSSList\Document#4 (2) {
 ## Class diagram
 
 ```mermaid
+    %% start of the generated part
 classDiagram
     direction LR
 
@@ -730,76 +731,131 @@ classDiagram
     CSSListItem <|-- AtRule: inheritance
     AtRule <|.. AtRuleBlockList: realization
     CSSBlockList <|-- AtRuleBlockList: inheritance
+    AtRuleBlockList ..> OutputFormat: dependency
     AtRule <|.. AtRuleSet: realization
+    AtRuleSet ..> OutputFormat: dependency
     RuleSet <|-- AtRuleSet: inheritance
     CSSList <|-- CSSBlockList: inheritance
     Renderable <|-- CSSElement: inheritance
-
-    RuleSet <|-- DeclarationBlock: inheritance
-    Renderable <|-- CSSListItem: inheritance
-    Commentable <|-- CSSListItem: inheritance
-    Positionable <|.. RuleSet: realization
-    CSSElement <|.. RuleSet: realization
-    CSSListItem <|.. RuleSet: realization
-    RuleContainer <|.. RuleSet: realization
-    Renderable <|.. Selector: realization
-    Selector <|-- KeyframeSelector: inheritance
-    Positionable <|.. Charset: realization
-    AtRule <|.. Charset: realization
-    Positionable <|.. Import: realization
-    AtRule <|.. Import: realization
-    Positionable <|.. CSSNamespace: realization
-    AtRule <|.. CSSNamespace: realization
-    CSSElement <|.. Rule: realization
-    Positionable <|.. Rule: realization
-    Commentable <|.. Rule: realization
-    SourceException <|-- OutputException: inheritance
-    UnexpectedTokenException <|-- UnexpectedEOFException: inheritance
-    Exception <|-- SourceException: inheritance
-    Positionable <|.. SourceException: realization
-    SourceException <|-- UnexpectedTokenException: inheritance
-    CSSBlockList <|-- Document: inheritance
+    CSSFunction ..> OutputFormat: dependency
+    CSSFunction ..> ParserState: dependency
+    ValueList <|-- CSSFunction: inheritance
+    CSSList ..> AtRuleBlockList: dependency
+    CSSList ..> AtRuleSet: dependency
     CSSElement <|.. CSSList: realization
-    Positionable <|.. CSSList: realization
     CSSListItem <|.. CSSList: realization
-    CSSList <|-- KeyFrame: inheritance
-    AtRule <|.. KeyFrame: realization
-    CSSFunction <|-- Color: inheritance
-    PrimitiveValue <|-- URL: inheritance
-    RuleValueList <|-- CalcRuleValueList: inheritance
-    Value <|-- ValueList: inheritance
-    CSSFunction <|-- CalcFunction: inheritance
-    ValueList <|-- LineName: inheritance
-    CSSElement <|.. Value: realization
-    Positionable <|.. Value: realization
-    PrimitiveValue <|-- Size: inheritance
-    PrimitiveValue <|-- CSSString: inheritance
-    Value <|-- PrimitiveValue: inheritance
-    ValueList <|-- CSSFunction: inheritance
-    ValueList <|-- RuleValueList: inheritance
-    Renderable <|.. Comment: realization
-    Positionable <|.. Comment: realization
-    CSSList ..> CSSList: dependency
+    CSSList ..> CSSNamespace: dependency
     CSSList ..> Charset: dependency
-    CSSList ..> Comment: dependency
     CSSList ..> Import: dependency
-    CSSList ..> RuleSet: dependency
-    CSSNamespace ..> Comment: dependency
-    Charset ..> Comment: dependency
+    CSSList ..> KeyFrame: dependency
+    CSSList ..> OutputFormat: dependency
+    CSSList ..> ParserState: dependency
+    Positionable <|.. CSSList: realization
+    CSSList ..> Selector: dependency
+    CSSList ..> SourceException: dependency
+    CSSList ..> UnexpectedTokenException: dependency
+    Commentable <|-- CSSListItem: inheritance
+    Renderable <|-- CSSListItem: inheritance
+    AtRule <|.. CSSNamespace: realization
+    CSSNamespace ..> OutputFormat: dependency
+    Positionable <|.. CSSNamespace: realization
+    CSSString ..> OutputFormat: dependency
+    CSSString ..> ParserState: dependency
+    PrimitiveValue <|-- CSSString: inheritance
+    CSSString ..> SourceException: dependency
+    CSSFunction <|-- CalcFunction: inheritance
+    CalcFunction ..> CalcRuleValueList: dependency
+    CalcFunction ..> ParserState: dependency
+    CalcFunction ..> RuleValueList: dependency
+    CalcFunction ..> UnexpectedTokenException: dependency
+    CalcRuleValueList ..> OutputFormat: dependency
+    RuleValueList <|-- CalcRuleValueList: inheritance
+    AtRule <|.. Charset: realization
     Charset ..> CSSString: dependency
+    Charset ..> OutputFormat: dependency
+    Positionable <|.. Charset: realization
+    CSSFunction <|-- Color: inheritance
+    Color ..> OutputFormat: dependency
+    Color ..> ParserState: dependency
+    Color ..> Size: dependency
+    Color ..> UnexpectedTokenException: dependency
+    Comment ..> OutputFormat: dependency
+    Positionable <|.. Comment: realization
+    Renderable <|.. Comment: realization
+    DeclarationBlock ..> KeyframeSelector: dependency
+    DeclarationBlock ..> OutputException: dependency
+    DeclarationBlock ..> OutputFormat: dependency
+    DeclarationBlock ..> ParserState: dependency
+    RuleSet <|-- DeclarationBlock: inheritance
     DeclarationBlock ..> Selector: dependency
-    Import ..> Comment: dependency
-    OutputFormat ..> OutputFormat: dependency
+    DeclarationBlock ..> UnexpectedTokenException: dependency
+    CSSBlockList <|-- Document: inheritance
+    Document ..> OutputFormat: dependency
+    Document ..> ParserState: dependency
+    AtRule <|.. Import: realization
+    Import ..> OutputFormat: dependency
+    Positionable <|.. Import: realization
+    Import ..> URL: dependency
+    AtRule <|.. KeyFrame: realization
+    CSSList <|-- KeyFrame: inheritance
+    KeyFrame ..> OutputFormat: dependency
+    Selector <|-- KeyframeSelector: inheritance
+    LineName ..> OutputFormat: dependency
+    LineName ..> ParserState: dependency
+    ValueList <|-- LineName: inheritance
+    SourceException <|-- OutputException: inheritance
     OutputFormat ..> OutputFormatter: dependency
+    OutputFormatter ..> Commentable: dependency
+    OutputFormatter ..> InvalidArgumentException: dependency
     OutputFormatter ..> OutputFormat: dependency
+    Parser ..> Document: dependency
     Parser ..> ParserState: dependency
+    ParserState ..> Anchor: dependency
+    ParserState ..> Comment: dependency
     ParserState ..> Settings: dependency
-    Rule ..> Comment: dependency
+    ParserState ..> SourceException: dependency
+    ParserState ..> UnexpectedEOFException: dependency
+    ParserState ..> UnexpectedTokenException: dependency
+    Value <|-- PrimitiveValue: inheritance
+    Renderable ..> OutputFormat: dependency
+    CSSElement <|.. Rule: realization
+    Commentable <|.. Rule: realization
+    Rule ..> OutputFormat: dependency
+    Rule ..> ParserState: dependency
+    Positionable <|.. Rule: realization
     Rule ..> RuleValueList: dependency
-    RuleSet ..> Comment: dependency
+    RuleContainer ..> Rule: dependency
+    CSSElement <|.. RuleSet: realization
+    CSSListItem <|.. RuleSet: realization
+    RuleSet ..> OutputFormat: dependency
+    RuleSet ..> ParserState: dependency
+    Positionable <|.. RuleSet: realization
     RuleSet ..> Rule: dependency
+    RuleContainer <|.. RuleSet: realization
+    RuleSet ..> UnexpectedValueException: dependency
+    ValueList <|-- RuleValueList: inheritance
+    Selector ..> OutputFormat: dependency
+    Renderable <|.. Selector: realization
+    Size ..> OutputFormat: dependency
+    Size ..> ParserState: dependency
+    PrimitiveValue <|-- Size: inheritance
+    Exception <|-- SourceException: inheritance
+    Positionable <|.. SourceException: realization
     URL ..> CSSString: dependency
-    ValueList ..> Value: dependency
+    URL ..> OutputFormat: dependency
+    URL ..> ParserState: dependency
+    PrimitiveValue <|-- URL: inheritance
+    UnexpectedTokenException <|-- UnexpectedEOFException: inheritance
+    SourceException <|-- UnexpectedTokenException: inheritance
+    CSSElement <|.. Value: realization
+    Value ..> CSSFunction: dependency
+    Value ..> ParserState: dependency
+    Positionable <|.. Value: realization
+    Value ..> RuleValueList: dependency
+    Value ..> UnexpectedTokenException: dependency
+    ValueList ..> OutputFormat: dependency
+    Value <|-- ValueList: inheritance
+    %% end of the generated part
 ```
 
 ## API and deprecation policy

composer.json

@@ -101,6 +101,15 @@
         ],
         "fix:php:fixer": "\"./.phive/php-cs-fixer\" --config=config/php-cs-fixer.php fix bin src tests",
         "fix:php:rector": "rector --config=config/rector.php",
+        "generate:class-diagram": [
+            "composer require --dev tasuku43/mermaid-class-diagram:0.5.0",
+            "mermaid-class-diagram generate --path src > class-diagram.md",
+            "perl -i -0pe 's/(    %% start of the generated part).*(    %% end of the generated part)/\\1\\nCLASS_DIAGRAM\\n\\2/s' README.md",
+            "sed -i -n '/CLASS_DIAGRAM/!{p;d;}; r class-diagram.md' README.md",
+            "sed -i -E 's/(classDiagram)/\\1\\n    direction LR\\n/' README.md",
+            "rm class-diagram.md",
+            "composer remove --dev tasuku43/mermaid-class-diagram"
+        ],
         "phpstan:baseline": "phpstan --configuration=config/phpstan.neon --generate-baseline=config/phpstan-baseline.neon --allow-empty-baseline"
     },
     "scripts-descriptions": {
@@ -121,6 +130,7 @@
         "fix:php": "Autofixes all autofixable issues in the PHP code.",
         "fix:php:fixer": "Fixes autofixable issues found by PHP CS Fixer.",
         "fix:php:rector": "Fixes autofixable issues found by Rector.",
+        "generate:class-diagram": "Updates the class diagram in the README.md file.",
         "phpstan:baseline": "Updates the PHPStan baseline file to match the code."
     }
 }