v1.67.0 pickStringRemember: save the picked items of a group in a separate remember key, fix #108

Author: rioj7

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Change Log
 
-## [1.6x.x] 2025-02-xx
+## [1.67.0] 2025-02-26
+### Added
+- `pickStringRemember`: save the picked items of a group in a separate remember key.
 ### Fixed
 - `pickStringRemember`: `dependsOn` for groups
 

README.md

@@ -1302,6 +1302,7 @@ The command has the following configuration attributes:
   * `name`: [_string_] (Optional) Used in multi pick list. They are the variables used in the `dependsOn` expressions.  
     It must be a [valid JavaScript variable name](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Grammar_and_types#variables).
   * `dependsOn`: [_string_] (Optional) Used in multi pick list. It must be a [valid JavaScript expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Expressions_and_Operators) that has a boolean ([ `true` | `false` ]) result. The variables allowed in the expression are the `name`s of items or groups. Here defined on a group it controls if the group validation is performed and if the value of the group items is part of the result when it is picked. See [`dependsOn`](#`dependson`). (default: `true`)
+  * `key`, `separator`, `joinByKey` : (Optional) If you want to remember the picked items of a group in a different remember store item define these properties in the group. They have the same meaning as for the top `args`  property. They are not inherited from the top `args` property (see Example 13).
 * `addLabelToTop` : [_string_] (Optional) Any [variables](#variables) are resolved. The pickItem with the identical label will be put on top. If needed add an extra remember item (see Example 7).
 * `key` : (Optional) Used to store and retrieve a particular pick. (default: `pickString` )  
   The value can later be retrieved with the [`remember`](#remember) command or [`${remember}`](#variable-remember) variable.
@@ -2165,6 +2166,105 @@ If `name1` and `name3` are selected the remember storage contains
 
 and `${input:set-v1-v2}` returns the value for key `v2`: `other1 other3`
 
+**Example 13**
+
+Next feature is by Axel Le Bourhis ([issue 108](https://github.com/rioj7/command-variable/issues/108))
+
+Sometimes you also want to use the items selected in a group. Or have the group selected items saved in individual remember keys and use 1 multipick instead of multiple `pickStringRemember` calls for each group.
+
+You specify for the particular groups a `key`. If you want a particular `separator` you can.  
+You can add the property `joinByKey` to a group if the option values are objects with key-value pairs.
+
+```json
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Grovery List",
+      "type": "shell",
+      "command": "echo",
+      "args": ["${input:groceryList}"]
+    }
+  ],
+  "inputs": [
+    {
+      "id": "groceryList",
+      "type": "command",
+      "command": "extension.commandvariable.pickStringRemember",
+      "args": {
+        "description": "Select groceries",
+        "key": "groceries",
+        "multiPick": true,
+        "optionGroups": [
+          {
+            "label": "Fruit",
+            "minCount": 1,
+            "maxCount": 3,
+            "options": ["apple", "orange", "banana", "lychee"],
+            "key": "category-fruit",
+            "separator": "##"
+          },
+          {
+            "label": "Vegetable",
+            "minCount": 1,
+            "maxCount": 3,
+            "options": ["kousenband", "artichoke", "sopropo", "lettuce"],
+            "key": "category-veg",
+            "separator": "%%"
+          }
+        ]
+      }
+    },
+    { "id": "category-fruit", "type": "command", "command": "extension.commandvariable.remember", "args": { "key": "category-fruit" } },
+    { "id": "category-veg", "type": "command", "command": "extension.commandvariable.remember", "args": { "key": "category-veg" } }
+  ]
+}
+```
+
+You can use this also for a single pick list. Groups that do not have an item selected are stored in the remember store as an empty string.
+
+```json
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Food Item",
+      "type": "shell",
+      "command": "echo",
+      "args": ["${input:fooditem}"]
+    }
+  ],
+  "inputs": [
+    {
+      "id": "fooditem",
+      "type": "command",
+      "command": "extension.commandvariable.pickStringRemember",
+      "args": {
+        "description": "Select a food item",
+        "key": "food-item",
+        "optionGroups": [
+          {
+            "label": "Fruit",
+            "options": ["apple", "orange", "banana", "lychee"],
+            "name": "fruit",
+            "key": "category-fruit",
+            "dependsOn": "fruit + veg === 1"
+          },
+          {
+            "label": "Vegetable",
+            "options": ["kousenband", "artichoke", "sopropo", "lettuce"],
+            "name": "veg",
+            "key": "category-veg"
+          }
+        ]
+      }
+    },
+    { "id": "category-fruit", "type": "command", "command": "extension.commandvariable.remember", "args": { "key": "category-fruit" } },
+    { "id": "category-veg", "type": "command", "command": "extension.commandvariable.remember", "args": { "key": "category-veg" } }
+  ]
+}
+```
+
 ## promptStringRemember
 
 `extension.commandvariable.promptStringRemember` has the same configuration attributes as the [Input variable promptString](https://code.visualstudio.com/docs/editor/variables-reference#_input-variables).

extension-common.js

@@ -245,6 +245,7 @@ class PickStringGroup extends PickStringMulti {
     this.minCount = minCount;
     this.maxCount = maxCount;
     this.items = [];
+    this.key = undefined;
   }
   addItem(qpItem) {
     let label = utils.getProperty(qpItem, 'label');
@@ -332,6 +333,10 @@ async function pickStringRemember(args, processPick) {
       name = name ? name : `group-${groups.length + 1}`;
       groupLabel = groupLabel ? groupLabel : name;
       let group = new PickStringGroup(name, groupLabel, minCount, maxCount, dependsOn);
+      for (const p of ['key', 'separator', 'joinByKey']) {
+        let v = utils.getProperty(optionGroup, p);
+        if (v !== undefined) { group[p] = v; }
+      }
       groups.push(group);
       for (const option of utils.getProperty(optionGroup, 'options', ['item1', 'item2'])) {
         let qpItem = undefined;
@@ -411,30 +416,41 @@ async function pickStringRemember(args, processPick) {
     if (newStored !== prevStored) {
       multiPickStorage.update(multiPickLabelKey, newStored);
     }
-    let separator = utils.getProperty(args, 'separator', ' ');
-    let picked = result.filter(e => groups.some(g => g.allowedLabel(pickContext, e.label))).map(e => e.value);
-    if (picked.length > 0 && utils.getProperty(args, 'joinByKey')) {
-      let keys = new Set();
-      for (const p of picked) {
-        if (!utils.isObject(p)) { continue; }
-        for (const vkey in p) {
-          if (p.hasOwnProperty(vkey)) {
-            keys.add(vkey);
+    const resultFor = (picked, args) => {
+      let result;
+      let separator = utils.getProperty(args, 'separator', ' ');
+      picked = picked.map(e => e.value);
+      if (picked.length > 0 && utils.getProperty(args, 'joinByKey')) {
+        let keys = new Set();
+        for (const p of picked) {
+          if (!utils.isObject(p)) { continue; }
+          for (const vkey in p) {
+            if (p.hasOwnProperty(vkey)) {
+              keys.add(vkey);
+            }
           }
         }
-      }
-      result = { value: {} };
-      for (const vkey of keys) {
-        result.value[vkey] = picked.filter(p => utils.isObject(p) && (utils.getProperty(p, vkey) !== undefined)).map(p => p[vkey]).join(separator);
-      }
-    } else {
-      result = { value: picked.map(value => {
-        if (utils.isObject(value)) {
-          value = storeStringRemember2(args, value);
+        result = { value: {} };
+        for (const vkey of keys) {
+          result.value[vkey] = picked.filter(p => utils.isObject(p) && (utils.getProperty(p, vkey) !== undefined)).map(p => p[vkey]).join(separator);
         }
-        return value;
-      }).join(separator)};
-    }
+      } else {
+        result = { value: picked.map(value => {
+          if (utils.isObject(value)) {
+            value = storeStringRemember2(args, value);
+          }
+          return value;
+        }).join(separator)};
+      }
+      return result;
+    };
+    let resultAllowed = result.filter(e => groups.some(g => g.allowedLabel(pickContext, e.label)));
+    groups.filter(g => g.key).forEach(g => {
+      let picked = resultAllowed.filter(e => g.allowedLabel(pickContext, e.label));
+      let result = resultFor(picked, g);
+      storeStringRemember2(g, result.value);
+    });
+    result = resultFor(resultAllowed, args);
   }
   let rememberTransformed = utils.getProperty(args, 'rememberTransformed', false);
   // @ts-ignore

package.json

@@ -4,7 +4,7 @@
   "description": "Calculate command variables for launch.json and tasks.json",
   "publisher": "rioj7",
   "license": "MIT",
-  "version": "1.66.0",
+  "version": "1.67.0",
   "engines": {"vscode": "^1.55.0"},
   "categories": ["Other"],
   "keywords": ["command","variable","launch","tasks","date","multi-root ready","pick","file","key","value","uuid","clipboard","number","remember"],