refactor: plugin setup

SlimDeluxe · SlimDeluxe · commit d0efe8da6098 · 2025-04-14T10:14:00.000+02:00
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
@@ -16,4 +16,4 @@ jobs:
       - uses: google-github-actions/release-please-action@v3
         with:
           release-type: php
-          package-name: eclipsephp-plugin-template
+          package-name: eclipsephp-catalogue-plugin
diff --git a/.lando.dist.yml b/.lando.dist.yml
@@ -1,11 +1,12 @@
-name: eclipsephp-plugin-template
+#file: noinspection ComposeUnknownKeys
+name: eclipse-catalogue
 services:
   appserver:
     type: php:custom
     xdebug: "debug,develop,coverage"
     via: cli
     overrides:
-      image: slimdeluxe/php:8.2-v1.0
+      image: slimdeluxe/php:8.2-v1.1
 tooling:
   php:
     service: appserver
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,11 +1 @@
 # Changelog
-
-## 1.0.0 (2025-03-21)
-
-
-### Features
-
-* add division method with test ([6acebfb](https://github.com/DataLinx/eclipsephp-plugin-template/commit/6acebfb8e784e2a6a2f43bf0d318ee3555455ff6))
-* add Math source file with tests ([bdca326](https://github.com/DataLinx/eclipsephp-plugin-template/commit/bdca3261e55aa6893684eba4517c138a795e8ecb))
-* add placeholder files ([2dda560](https://github.com/DataLinx/eclipsephp-plugin-template/commit/2dda5603cb60df1973f1d91130814965b76801b1))
-* add service provider and plugin class ([b3343ee](https://github.com/DataLinx/eclipsephp-plugin-template/commit/b3343eebb6b57d66199efa07f5085e0339a5519c))
diff --git a/README.md b/README.md
@@ -1,19 +1,26 @@
-# Eclipse Filament plugin template
+# Eclipse Filament Catalogue plugin
 
-![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/eclipsephp/plugin-template)
-![Packagist Version](https://img.shields.io/packagist/v/eclipsephp/plugin-template)
-![Packagist Downloads](https://img.shields.io/packagist/dt/eclipsephp/plugin-template)
-[![Tests](https://github.com/DataLinx/eclipsephp-plugin-template/actions/workflows/test-runner.yml/badge.svg)](https://github.com/DataLinx/eclipsephp-plugin-template/actions/workflows/test-runner.yml)
-[![codecov](https://codecov.io/gh/DataLinx/eclipsephp-plugin-template/graph/badge.svg?token=1HKSY5O6IW)](https://codecov.io/gh/DataLinx/eclipsephp-plugin-template)
+![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/eclipsephp/catalogue-plugin)
+![Packagist Version](https://img.shields.io/packagist/v/eclipsephp/catalogue-plugin)
+![Packagist Downloads](https://img.shields.io/packagist/dt/eclipsephp/catalogue-plugin)
+[![Tests](https://github.com/DataLinx/eclipsephp-catalogue-plugin/actions/workflows/test-runner.yml/badge.svg)](https://github.com/DataLinx/eclipsephp-catalogue-plugin/actions/workflows/test-runner.yml)
+[![codecov](https://codecov.io/gh/DataLinx/eclipsephp-catalogue-plugin/graph/badge.svg?token=1HKSY5O6IW)](https://codecov.io/gh/DataLinx/eclipsephp-catalogue-plugin)
 [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
-![Packagist License](https://img.shields.io/packagist/l/eclipsephp/plugin-template)
+![Packagist License](https://img.shields.io/packagist/l/eclipsephp/catalogue-plugin)
 
 ## About
-This package serves as a Filament plugin template for plugins developed by DataLinx for [Eclipse](https://github.com/DataLinx/eclipsephp-app), our web app based on Filament. It is also a reference of how such a package should be configured.
-
-The template is opinionated — it's based on our tech stack, which includes JetBrains PhpStorm.
-
-This template works on and expands our [PHP package template](https://github.com/DataLinx/php-package-template).
+Filament plugin for product catalogue data.
+
+🟧 Products (WIP)  
+🟧 Categories (WIP)  
+🟧 Price lists (WIP)    
+🟧 Tax classes (WIP)  
+🟧 Statuses (WIP)  
+⏳ Types and properties (planned)  
+⏳ Product groups (planned)  
+⏳ Promo/landing pages (planned)  
+⏳ Tariff codes (planned)  
+⏳ Other resources coming when needed ([suggest a feature](https://github.com/DataLinx/eclipsephp-catalogue-plugin/discussions) and/or [hire us](https://www.datalinx.si))
 
 ## Requirements
 - PHP >= 8.2 (due to Pest 3 requirement)
@@ -23,11 +30,10 @@ This template works on and expands our [PHP package template](https://github.com
 See [composer.json](composer.json) for details.
 
 ## Getting started
-* Download it with composer:
+Download it with composer:
 ```shell
-  composer require eclipsephp/plugin-template
+  composer require eclipsephp/catalogue-plugin
 ````
-* _Provide a simple example how to use the package._
 
 ## Contributing
 
@@ -38,21 +44,28 @@ Should you want to contribute, please see the development guidelines in the [Dat
 
 ### Development
 
+1. All development is subject to our [PHP package development guidelines](https://github.com/DataLinx/php-package-template/blob/bc39ae340e7818614ae2aaa607e97088318dd754/docs/Documentation.md).
+2. Our [Filament app development docs](https://github.com/DataLinx/eclipsephp-core/blob/cae7143c8f745f142bba2bb4cf1483cf09401509/docs/Documentation.md) will also be helpful.
+3. Any PRs will generally need to adhere to these before being merged.
+
 #### Requirements
 * Linux, Mac or Windows with WSL
 * [Lando](https://lando.dev/) (optional, but easier to start with)
 
 #### Get started
 1. Clone the git repo
 2. Start the Lando container
-```shell
-  lando start
-````
+    ```shell
+    lando start
+    ````
 3. Install dependencies (this also runs the setup composer script)
-```shell
-  lando composer install
-````
-4. Happy coding 😉
+    ```shell
+    lando composer install
+    ````
+4. You can now develop and run tests. Happy coding 😉
+
+💡 To manually test the plugin in the browser, see our [recommendation](https://github.com/DataLinx/eclipsephp-core/blob/main/docs/Documentation.md#-plugin-development), which is also [how Filament suggests package development](https://filamentphp.com/docs/3.x/support/contributing#developing-with-a-local-copy-of-filament).  
+However, the plugin should be universal and not dependent on our app setup or core package.
 
 ### Changelog
 All notable changes to this project are automatically documented in the [CHANGELOG.md](CHANGELOG.md) file using the release workflow, based on the [release-please](https://github.com/googleapis/release-please) GitHub action.
diff --git a/composer.json b/composer.json
@@ -1,12 +1,15 @@
 {
-    "name": "eclipsephp/plugin-template",
-    "description": "Eclipse template for Filament plugins",
+    "name": "eclipsephp/catalogue-plugin",
+    "description": "Filament plugin for product catalogue",
     "keywords": [
         "eclipse",
         "filament",
-        "laravel"
+        "laravel",
+        "catalogue",
+        "plugin",
+        "product"
     ],
-    "homepage": "https://github.com/DataLinx/eclipsephp-plugin-template",
+    "homepage": "https://github.com/DataLinx/eclipsephp-catalogue-plugin",
     "type": "library",
     "license": "MIT",
     "authors": [
@@ -26,9 +29,9 @@
     "prefer-stable": true,
     "autoload": {
         "psr-4": {
-            "Eclipse\\PluginTemplate\\": "src/",
-            "Eclipse\\PluginTemplate\\Factories\\": "database/factories/",
-            "Eclipse\\PluginTemplate\\Seeders\\": "database/seeders/"
+            "Eclipse\\Catalogue\\": "src/",
+            "Eclipse\\Catalogue\\Factories\\": "database/factories/",
+            "Eclipse\\Catalogue\\Seeders\\": "database/seeders/"
         }
     },
     "autoload-dev": {
@@ -78,7 +81,7 @@
     "extra": {
         "laravel": {
             "providers": [
-                "Eclipse\\PluginTemplate\\PluginTemplateServiceProvider"
+                "Eclipse\\Catalogue\\CatalogueServiceProvider"
             ]
         }
     }
diff --git a/config/catalogue.php b/config/catalogue.php
diff --git a/env/php-8.3/.lando.dist.yml b/env/php-8.3/.lando.dist.yml
@@ -1,4 +1,5 @@
-name: eclipsephp-plugin-template-8.3
+#file: noinspection ComposeUnknownKeys
+name: eclipsephp-catalogue-plugin-8.3
 services:
   appserver:
     type: php:custom
diff --git a/env/php-8.3/composer.json b/env/php-8.3/composer.json
@@ -1,5 +1,5 @@
 {
-    "name": "eclipsephp/plugin-template",
+    "name": "eclipsephp/catalogue-plugin",
     "require": {
         "wikimedia/composer-merge-plugin": "dev-master"
     },
@@ -12,7 +12,7 @@
         },
         "laravel": {
             "providers": [
-                "Eclipse\\PluginTemplate\\PluginTemplateServiceProvider"
+                "Eclipse\\Catalogue\\CatalogueServiceProvider"
             ]
         }
     },
@@ -25,9 +25,9 @@
     },
     "autoload": {
         "psr-4": {
-            "Eclipse\\PluginTemplate\\": "src/",
-            "Eclipse\\PluginTemplate\\Factories\\": "database/factories/",
-            "Eclipse\\PluginTemplate\\Seeders\\": "database/seeders/"
+            "Eclipse\\Catalogue\\": "src/",
+            "Eclipse\\Catalogue\\Factories\\": "database/factories/",
+            "Eclipse\\Catalogue\\Seeders\\": "database/seeders/"
         }
     },
     "autoload-dev": {
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/CataloguePlugin.php b/src/CataloguePlugin.php
@@ -1,15 +1,15 @@
 <?php
 
-namespace Eclipse\PluginTemplate;
+namespace Eclipse\Catalogue;
 
 use Filament\Contracts\Plugin;
 use Filament\Panel;
 
-class PluginTemplate implements Plugin
+class CataloguePlugin implements Plugin
 {
     public function getId(): string
     {
-        return 'plugin-template';
+        return 'eclipse-catalogue';
     }
 
     public function register(Panel $panel): void
diff --git a/src/CatalogueServiceProvider.php b/src/CatalogueServiceProvider.php
@@ -1,13 +1,13 @@
 <?php
 
-namespace Eclipse\PluginTemplate;
+namespace Eclipse\Catalogue;
 
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
-class PluginTemplateServiceProvider extends PackageServiceProvider
+class CatalogueServiceProvider extends PackageServiceProvider
 {
-    public static string $name = 'plugin-template';
+    public static string $name = 'eclipse-catalogue';
 
     public function configurePackage(Package $package): void
     {
diff --git a/tests/Pest.php b/tests/Pest.php
@@ -53,7 +53,7 @@
 |
 */
 
-function something()
-{
-    // ..
-}
+// function something()
+// {
+//    // ..
+// }
diff --git a/workbench/app/Providers/AdminPanelProvider.php b/workbench/app/Providers/AdminPanelProvider.php
@@ -3,7 +3,7 @@
 namespace Workbench\App\Providers;
 
 use BezhanSalleh\FilamentShield\FilamentShieldPlugin;
-use Eclipse\PluginTemplate\PluginTemplate;
+use Eclipse\Catalogue\CataloguePlugin;
 use Filament\Http\Middleware\Authenticate;
 use Filament\Http\Middleware\DisableBladeIconComponents;
 use Filament\Http\Middleware\DispatchServingFilamentEvent;
@@ -45,7 +45,7 @@ public function panel(Panel $panel): Panel
             ])
             ->plugins([
                 FilamentShieldPlugin::make(),
-                PluginTemplate::make(),
+                CataloguePlugin::make(),
             ])
             ->pages([
                 Dashboard::class,

Original file line number	Diff line number	Diff line change
`@@ -1,15 +1,15 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-namespace Eclipse\PluginTemplate;`
	`3`	`+namespace Eclipse\Catalogue;`
`4`	`4`
`5`	`5`	`use Filament\Contracts\Plugin;`
`6`	`6`	`use Filament\Panel;`
`7`	`7`
`8`		`-class PluginTemplate implements Plugin`
	`8`	`+class CataloguePlugin implements Plugin`
`9`	`9`	`{`
`10`	`10`	`public function getId(): string`
`11`	`11`	`{`
`12`		`- return 'plugin-template';`
	`12`	`+ return 'eclipse-catalogue';`
`13`	`13`	`}`
`14`	`14`
`15`	`15`	`public function register(Panel $panel): void`