refactor: update for Flarum 2.0

.github/workflows/backend.yml

@@ -4,7 +4,7 @@ on: [workflow_dispatch, push, pull_request]
 
 jobs:
   run:
-    uses: flarum/framework/.github/workflows/REUSABLE_backend.yml@main
+    uses: flarum/framework/.github/workflows/REUSABLE_backend.yml@2.x
     with:
       enable_backend_testing: false
       enable_phpstan: true

README.md

@@ -4,8 +4,6 @@
 
 A [Flarum](http://flarum.org) extension. Details BBCode for Flarum. Original by @sijad.
 
-![screenshot](https://i.imgur.com/mmtCS3M.png)
-
 ### Installation
 
 Use [Bazaar](https://discuss.flarum.org/d/5151-flagrow-bazaar-the-extension-marketplace) or install manually with composer:
@@ -20,6 +18,20 @@ composer require fof/bbcode-details
 composer update fof/bbcode-details
 ```
 
+### Usage
+
+Use the following BBCode in your posts:
+
+```
+[details="Summary text here"]Hidden content here[/details]
+[details title="Summary text here"]Hidden content here[/details]
+[details]Hidden content with no summary[/details]
+```
+
+You may optionally also provide the `open=` attribute to mark as open by default. The `name=` attribute may be used to provide a unique identifier for the details block (which can be used to only open one details block at a time in a group).
+
+<img src="https://i.imgur.com/mmtCS3M.png" width="300" loading="lazy" alt="screenshot" />
+
 ### Links
 
 - [Packagist](https://packagist.org/packages/fof/bbcode-details)

composer.json

@@ -19,7 +19,7 @@
         }
     ],
     "require": {
-        "flarum/core": "^1.2.0"
+        "flarum/core": "^2.0.0"
     },
     "authors": [
         {
@@ -28,7 +28,7 @@
         },
         {
             "name": "David Sevilla Martín",
-            "email": "david.s@redevs.org",
+            "email": "me+fof@dsevilla.dev",
             "role": "Developer"
         },
         {
@@ -55,23 +55,22 @@
                 "color": "#fff"
             }
         },
-        "flagrow": {
-            "discuss": "https://discuss.flarum.org/d/18796"
-        },
         "flarum-cli": {
             "modules": {
                 "githubActions": true
             }
         }
     },
     "require-dev": {
-        "flarum/phpstan": "*"
+        "flarum/phpstan": "^2.0.0"
     },
     "scripts": {
         "analyse:phpstan": "phpstan analyse",
         "clear-cache:phpstan": "phpstan clear-result-cache"
     },
     "scripts-descriptions": {
         "analyse:phpstan": "Run static analysis"
-    }
+    },
+    "minimum-stability": "beta",
+    "prefer-stable": true
 }

extend.php

@@ -14,14 +14,29 @@
 
 return [
     (new Extend\Frontend('forum'))
-        ->css(__DIR__.'/less/forum.less')
-        ->js(__DIR__.'/js/dist/forum.js'),
+        ->css(__DIR__.'/less/forum.less'),
 
     (new Extend\Formatter())
         ->configure(function (Configurator $configurator) {
             $configurator->BBCodes->addCustom(
-                '[DETAILS title={TEXT1;optional}]{TEXT2}[/DETAILS]',
-                '<details><summary>{TEXT1}</summary><div>{TEXT2}</div></details>'
+                '[DETAILS title={TEXT1;optional} open={ANYTHING?} name={SIMPLETEXT?}]{TEXT2}[/DETAILS]',
+                <<<'XML'
+<details class="bbcode-details">
+    <xsl:copy-of select="@name"/>
+
+    <xsl:if test="@open">
+        <xsl:attribute name="open">open</xsl:attribute>
+    </xsl:if>
+
+    <xsl:if test="string-length(normalize-space(@title)) &gt; 0">
+        <summary>{@title}</summary>
+    </xsl:if>
+
+    <div>
+        <xsl:apply-templates/>
+    </div>
+</details>
+XML
             );
         }),
 ];