docs: write docs

bin/release.sh

@@ -14,6 +14,12 @@ RELEASE_BRANCH="7.x"
 CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
 VERSION=$1
 
+# Make sure all tests are successful
+if ! bash bin/test.sh > /dev/null 2>&1; then
+  echo "Tests did not complete without errors!"
+  exit 1
+fi
+
 # Make sure current branch and release branch match.
 if [[ "$RELEASE_BRANCH" != "$CURRENT_BRANCH" ]]
 then

composer.json

@@ -50,15 +50,5 @@
         "spatie/laravel-queueable-action": "^2.14",
         "phpstan/phpstan": "^1.10|^2.0"
     },
-    "config": {
-        "allow-plugins": {
-            "pestphp/pest-plugin": true
-        }
-    },
-    "scripts": {
-        "pint": "vendor/bin/pint",
-        "test": "vendor/bin/phpunit",
-        "phpstan": "vendor/bin/phpstan"
-    },
     "minimum-stability": "dev"
 }

docs/README.md

@@ -1,4 +1,9 @@
 # Documentation
+
+> [!CAUTION]
+> Keep in mind: Laravel Beyond is a dev dependency. Do not use its helper functions like
+> `beyond_path`, `beyond_app_path`, `beyond_domain_path` or others.
+
 ## Commands
 ### Application
 - [`beyond:make:command`](commands/make-command.md)
@@ -16,10 +21,10 @@
 - [`beyond:make:collection`](commands/make-collection.md)
 - [`beyond:make:data`](commands/make-data.md)
 - [`beyond:make:enum`](commands/make-enum.md)
-- `beyond:make:event`
-- `beyond:make:listener`
+- [`beyond:make:event`](commands/make-event.md)
+- [`beyond:make:listener`](commands/make-listener.md)
 - [`beyond:make:model`](commands/make-model.md)
-- `beyond:make:observer`
+- [`beyond:make:observer`](commands/make-observer.md)
 - [`beyond:make:scope`](commands/make-scope.md)
 
 ### Support

docs/commands/make-event.md

@@ -0,0 +1,13 @@
+# `beyond:make:event`
+Creates a new event.
+
+## Signature
+`beyond:make:event {name} {--force}`
+
+| Parameters | Description            |
+|------------|------------------------|
+| name       | The name of your event |
+
+| Flags   | Description             |
+|---------|-------------------------|
+| --force | Overwrite existing file |

docs/commands/make-listener.md

@@ -0,0 +1,13 @@
+# `beyond:make:listener`
+Creates a new listener.
+
+## Signature
+`beyond:make:listener {name} {--force}`
+
+| Parameters | Description               |
+|------------|---------------------------|
+| name       | The name of your listener |
+
+| Flags   | Description             |
+|---------|-------------------------|
+| --force | Overwrite existing file |

docs/commands/make-observer.md

@@ -0,0 +1,13 @@
+# `beyond:make:observer`
+Creates a new observer.
+
+## Signature
+`beyond:make:observer {name} {--force}`
+
+| Parameters | Description               |
+|------------|---------------------------|
+| name       | The name of your observer |
+
+| Flags   | Description             |
+|---------|-------------------------|
+| --force | Overwrite existing file |

stubs/cast.stub

@@ -5,7 +5,7 @@ namespace {{ namespace }};
 use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
 use Illuminate\Database\Eloquent\Model;
 
-class {{ className }} implements CastsAttributes
+final class {{ className }} implements CastsAttributes
 {
     /**
      * Cast the given value.

stubs/query.stub

@@ -10,8 +10,8 @@ final class {{ className }} extends QueryBuilder
 {
     public function __construct(Request $request)
     {
-        // $subject = Model::query()
-        
+        $subject = Model::query();
+
         parent::__construct($subject, $request);
     }
 }