🚑 STDOUT error

✨ help can be set from API
✨ button will quiet commands automatically

closes #100

Signed-off-by: bnomei <[email protected]>

Author: bnomei

README.md

@@ -154,6 +154,7 @@ The button you create with the `field: janitor` in your blueprint can be configu
 - `command`, command like you would enter it in terminal, with [query language support](https://getkirby.com/docs/guide/blueprints/query-language) and page/file/user/site/data arguments
 - `cooldown`, time in milliseconds the message is flashed on the button (default: 2000)
 - `error`, set message to show on all **non-200**-status returns with query language support
+- `help`, set help of the button
 - `icon`, set the [icon](https://getkirby.com/docs/reference/panel/icons) of the button
 - `intab`, if `true` then use in combination with the `open`-option to open an URL in a new tab
 - `label`, set label of the button
@@ -168,6 +169,7 @@ In either the command or the callback you will be setting/returning data to the
 - `clipboard`, string to copy to clipboard
 - `download`, URL to start downloading
 - `error`, see `error`-field option
+- `help`, see `help`-field option
 - `icon`, see `icon`-field option
 - `label`, see `label`-field option
 - `message`, see `message`-field option
@@ -232,6 +234,8 @@ janitor_thumbssite:
 
 If you want you can also call any of [the core shipping with the CLI](https://github.com/getkirby/cli#available-core-commands) like `clear:cache`.
 
+Keep in mind that the Janitor panel button will append the `--quiet` option on all commands automatically to silence outputs to the non-existing CLI.
+
 ### Smartly delaying resolution of a command argument
 
 In some cases you do not want to resolve the query language of a commands argument(s) **every time** when the button is shown in the panel but delay that until the api call is received by Janitor. Janitor will then resolve it **once** and forward the updated argument(s) to your command. This is useful for process-intensive calls or when the string of the data would be very long, like when the data is HTML.

classes/Janitor.php

@@ -50,7 +50,7 @@ final class Janitor
         ],
     ];
 
-    private static array $data;
+    private static array $data = [];
 
     public function data(string $command, ?array $data = null): ?array
     {

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "bnomei/kirby3-janitor",
     "type": "kirby-plugin",
-    "version": "3.3.0",
+    "version": "3.4.0",
     "license": "MIT",
     "description": "Kirby 3 Plugin for running commands like cleaning the cache from within the Panel, PHP code or a cronjob",
     "authors": [

index.js

@@ -51,6 +51,9 @@
                     }
                     $command .= ' --model '. $this->model()->uuid()->toString() ??
                         ($this->model() instanceof \Kirby\Cms\Site ? 'site://' : $this->model()->id());
+
+                    $command .= ' --quiet'; // no STDOUT on frontend PHP
+
                     return $command;
                 },
                 'confirm' => function ($confirm = '') {

index.php

@@ -10,7 +10,7 @@
     >
       {{ button.label || label }}
     </k-button>
-    <k-text v-if="help" theme="help" class="k-field-help" :html="help" />
+    <k-text v-if="button.help || help" theme="help" class="k-field-help" :html="button.help || help" />
     <a
       v-show="downloadRequest"
       ref="downloadAnchor"
@@ -54,6 +54,7 @@ export default {
       button: {
         label: null,
         state: null,
+        help: null,
       },
       clipboardRequest: null,
       downloadRequest: null,
@@ -152,7 +153,7 @@ export default {
       this.button.label = this.progress ?? `${this.label} …`;
       this.button.state = "is-running";
 
-      const { label, message, status, reload, open, download, clipboard, success, error, icon } =
+      const { label, message, status, reload, open, download, clipboard, success, error, icon, help } =
         await this.$api.post(path, data);
 
       if (status === 200) {
@@ -169,6 +170,10 @@ export default {
         this.button.label = message;
       }
 
+      if (help) {
+        this.button.help = help;
+      }
+
       if (icon) {
         this.icon = icon;
       }

src/components/fields/Janitor.vue

@@ -1,8 +1,8 @@
 <?php return array(
     'root' => array(
         'name' => 'bnomei/kirby3-janitor',
-        'pretty_version' => '3.3.0',
-        'version' => '3.3.0.0',
+        'pretty_version' => '3.4.0',
+        'version' => '3.4.0.0',
         'reference' => NULL,
         'type' => 'kirby-plugin',
         'install_path' => __DIR__ . '/../../',
@@ -11,8 +11,8 @@
     ),
     'versions' => array(
         'bnomei/kirby3-janitor' => array(
-            'pretty_version' => '3.3.0',
-            'version' => '3.3.0.0',
+            'pretty_version' => '3.4.0',
+            'version' => '3.4.0.0',
             'reference' => NULL,
             'type' => 'kirby-plugin',
             'install_path' => __DIR__ . '/../../',