✨ commands are automatically lazy resolved

see changes in readme for more information

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

Author: bnomei

README.md

@@ -247,52 +247,6 @@ If you want you can also call any of [the core shipping with the CLI](https://gi
 
 Keep in mind that the Janitor panel button and webhooks will append the `--quiet` option on all commands automatically to silence outputs to the non-existing CLI. But if you use `janitor()->command()` you will have to append `--quiet` to your command yourself.
 
-### 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.
-
-To achieve this you need to change the query language bounds for that argument from `{{ query }}` to `{( query )}`.
-
-```yml
-test_sendmail:
-  type: janitor
-  command: 'sendmail --to {{ user.email }} --data {( page.htmlOfEmail )}'
-  label: send mail
-```
-
-> Note: This only works inside the Janitor fields `command`-property.
-
-### Dynamic values in commands aka "Wrong value even after saving"
-
-In the example above the `user.email` will resolve to the email of the user when the button is first rendered in the panel. But let's assume you want to pick a **value from the same page**. The example below will echo back the selected email as a message. But because of the complexity involved janitor commands (and other props) are NOT dynamic - they do NOT change if you change a value in the panel but only on reload of the page. So if you change the value and hit the button you will not get the new value but the old one!
-
-```yaml
-  selectEmail:
-    type: select
-    options:
-      - [email protected] 			# <--- SET VALUE
-      - [email protected]
-      - [email protected]
-  janitor_savedData:
-    label: 'Saved Data'
-    type: janitor
-    # will use [email protected] until you reload the page manually
-    command: 'janitor:pipe --data {{ page.selectEmail }} --to message'
-```
-
-There are two ways to fix this.
-
-1. One is to enforce a page reload with the `autosave: true` property. 
-2. The other and recommended solution is to use the lazy resolved queries with the `{( )}` instead of `{{ }}` inside the command. This will resolve the query language of the data **every time** the button is clicked.
-
-```yaml
-  janitor_savedData:
-    label: 'Saved Data'
-    type: janitor
-    command: 'janitor:pipe --data {( page.selectEmail )} --to message'
-    # autosave: true
-```
-
 ### Running commands in your code
 
 You can run any command in you own code as well like in a model, template, controller or hook. Since commands do not return data directly you need to retrieve data stored for Janitor using a helper `janitor()->data($commandName)`.

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "bnomei/kirby3-janitor",
     "type": "kirby-plugin",
-    "version": "3.9.2",
+    "version": "3.10.0",
     "license": "MIT",
     "homepage": "https://github.com/bnomei/kirby3-janitor",
     "description": "Kirby 3 Plugin for running commands like cleaning the cache from within the Panel, PHP code or a cronjob",

composer.lock

@@ -50,6 +50,12 @@
 					return Janitor::isTrue($clipboard);
 				},
 				'command' => function ($command = null) {
+					// make lazy by default
+					$command = str_replace(['{{', '}}'], ['{(', ')}'], $command);
+
+					// allow non-lazy
+					$command = str_replace(['{<', '>}'], ['{{', '}}'], $command);
+
 					// resolve queries
 					$command = Janitor::query($command, $this->model());
 

index.php

@@ -158,6 +158,7 @@ fields:
     type: janitor
     command: 'janitor:pipe --data {( model.text.kirbytext )} --to message'
     # pipe will show lazy/smart resolved data on button (aka the message)
+    help: THIS IS NEW AUTOMATIC DEFAULT IN v3.10
 
   janitor_color:
     label: Janitor buttons can now be colorful
@@ -186,5 +187,5 @@ fields:
   janitor_savedData:
     label: 'Saved Data'
     type: janitor
-    command: 'janitor:pipe --data {( page.sele )} --to message'
+    command: 'janitor:pipe --data {{ page.sele }} --to message'
     # autosave: true

tests/site/blueprints/pages/default.yml

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