🚸 [2.1.78] Docs: Preserve search filter

Author: thinkyhead

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 The following enhancements and changes have been made to ***Auto Build Marlin***.
 
+## 2.1.78
+- Docs Panel: Preserve last-used search filter
+- Docs Panel: Use Flexbox layout, improve link bounds
+- Schema: Clean up 'requires' clauses, empty comments
+- Schema: Developer flag to export schema as JSON
+
 ## 2.1.77
 - Docs Panel: Replacing "Info" panel
 - Docs Panel: Filter now includes group name

abm/abm.js

@@ -38,30 +38,6 @@ function init(c) {
   set_context('inited', true);
 }
 
-/**
- * The simplest layout concept is to take the entire config
- * and parse it in a big list. Parent items are at root, and
- * those with children have a colored background and a
- * "reveal" widget. Child items should be compact so we can fit
- * 2-3 fields across. Grouped (XYZE) items need to align left.
- *
- * I do want to make the layouts customized for each configuration,
- * but I also want the flexibility to grab fields from the config
- * files as they change. So, my idea is simply to wrap all the fields
- * in span containers. To create the panel, we send all the fields
- * in the relevant section to the web view script as soon as the panel
- * is selected. The web view takes care of creating the fields, adding
- * them to the DOM, and showing the panel. The CSS uses a FLEX layout
- * with certain named spans included, while the ones not named in the
- * layout will be placed into the "fallback" location, probably down
- * at the bottom.
- *
- * For the Geometry panel a simple hook is added to update the canvas
- * whenever the fields are updated. And the canvas has interactive bits
- * that update the geometry fields. If there is a pause of a few seconds
- * or the panel is switched then the changes are applied to the configs.
- */
-
 // Return the path to the given item within the build folder.
 function envSubPath(sub, env, item) {
   var bp = path.join(marlin.workspaceRoot, '.pio', sub, env);

abm/js/docsview.js

@@ -21,7 +21,14 @@ function log(message, data) {
   if (data !== undefined) console.dir(data);
 }
 
+// Save the current view state.
+// Use this to restore the view when it is revealed.
 var docs_filter = "";
+function saveWebViewState() {
+  const data = { filter: docs_filter };
+  log('saveWebViewState', data);
+  vscode.setState(data);
+}
 
 //
 // Declare a marlinfwSearch singleton
@@ -85,9 +92,6 @@ var marlinfwSearch = (() => {
                     if (k >= 32 || k == 8) self.onSearchKeyUp();
                   })
 
-      // Search the provided string on load
-      self.searchFromField();
-
       // Focus the search field, and also select all chars
       $searchInput.focus().select();
     },
@@ -97,6 +101,12 @@ var marlinfwSearch = (() => {
       return $searchInput.val().trim();
     },
 
+    // Set the search field value
+    setFilter: (val) => {
+      $searchInput.val(val).select().focus();
+      self.searchFromField();
+    },
+
     // Convert a string to a regex pattern
     searchPattern: (str) => {
       const patt = str.toLowerCase().replace(ignore_pattern, '').trim().replace(/\s+/gm, '.+').replace(/([([\\])/gm, '\\$1');
@@ -141,6 +151,7 @@ var marlinfwSearch = (() => {
       if (newq == '') return;
 
       docs_filter = newq;
+      saveWebViewState();
       qmatch = newm;
 
       let resultsCount = 0, results = '', prevclass = '';
@@ -229,14 +240,6 @@ $(function () {
     marlinfwSearch.init();
   }
 
-  // Save the current view state.
-  // Use this to restore the view when it is revealed.
-  function saveWebViewState() {
-    const data = { data: {} };
-    log('saveWebViewState', data);
-    vscode.setState(data);
-  }
-
   /**
    * @brief Handle messages sent from the provider with iview.postMessage(msg)
    * @description Handle 'message' events sent directly to the view.
@@ -275,9 +278,9 @@ $(function () {
   const state = vscode.getState();
   if (state) {
     log("Got VSCode state", state);
-    if ('data' in state) {
+    if ('filter' in state) {
       log("Init Marlin Docs Webview with stored data")
-      initDocsView();
+      marlinfwSearch.setFilter(state.filter);
     }
   }
 

package.json

@@ -2,7 +2,7 @@
   "name": "auto-build",
   "displayName": "Auto Build Marlin",
   "description": "Provides an interface to configure, build, and upload Marlin Firmware.",
-  "version": "2.1.77",
+  "version": "2.1.78",
   "preview": false,
   "publisher": "marlinfirmware",
   "icon": "icon.png",