Editor max height i177 (#180)

* Add editor-max-height to prevent maximum growth

* Add doc entry and test

* Add release note

* Version bump

Author: coatless

_extensions/webr/_extension.yml

@@ -1,7 +1,7 @@
 name: webr
 title: Embedded webr code cells
 author: James Joseph Balamuta
-version: 0.4.2-dev.1
+version: 0.4.2-dev.2
 quarto-required: ">=1.2.198"
 contributes:
   filters:

_extensions/webr/qwebr-monaco-editor-element.js

@@ -56,10 +56,18 @@ globalThis.qwebrCreateMonacoEditorInstance = function (cellData) {
     // Dynamically modify the height of the editor window if new lines are added.
     let ignoreEvent = false;
     const updateHeight = () => {
-      const contentHeight = editor.getContentHeight();
+      // Increment editor height by 2 to prevent vertical scroll bar from appearing
+      const contentHeight = editor.getContentHeight() + 2;
+
+      // Retrieve editor-max-height option
+      const maxEditorHeight = qwebrOptions['editor-max-height'];
+
+      // If editor-max-height is missing, allow infinite growth. Otherwise, threshold.
+      const editorHeight = !maxEditorHeight ?  contentHeight : Math.min(contentHeight, maxEditorHeight);
+
       // We're avoiding a width change
       //editorDiv.style.width = `${width}px`;
-      editorDiv.style.height = `${contentHeight}px`;
+      editorDiv.style.height = `${editorHeight}px`;
       try {
         ignoreEvent = true;
 

_extensions/webr/webr.lua

@@ -72,7 +72,8 @@ local qwebRDefaultCellOptions = {
   ["fig-width"] = 7,
   ["fig-height"] = 5,
   ["out-width"] = "700px",
-  ["out-height"] = ""
+  ["out-height"] = "",
+  ["editor-max-height"] = ""
 }
 
 ----

docs/qwebr-cell-options.qmd

@@ -38,10 +38,11 @@ The `{quarto-webr}` extension does not support all of the cell options from [Qua
 | `context`   | `interactive` | Describe how the cell should operate on the page through either `interactive` (Runnable code editor), `output` (Output only of executed at runtime), or `setup` (execute code without seeing output at runtime). |
 | `autorun`   | `false`       | Allow `interactive` cells to be run during document initialization without a user pressing run code.                                                                                                             |
 | `read-only` | `false`       | Prevent code in `interactive` cells from being modified by disallowing code input.                                                                                                                               |
+| `editor-max-height` | `0`       | Set a threshold to prevent infinite growth of the editor window.                                                                                                                               |
 
 
 :::{.callout-note}
-Options listed here are unique to the `{quarto-webr}` extension. For more details, please see [Hiding and Executing Code](qwebr-internal-cell.qmd).
+Options listed here are unique to the `{quarto-webr}` extension. For details regarding `context`, please see [Hiding and Executing Code](qwebr-internal-cell.qmd).
 :::
 
 ## Attributes

docs/qwebr-release-notes.qmd

@@ -8,7 +8,7 @@ format:
     toc: true
 ---
 
-# 0.4.2-dev.1: ??????? (??-??-??)
+# 0.4.2-dev.2: ??????? (??-??-??)
 
 :::{.callout-note}
 Features listed under the `-dev` version have not yet been solidified and may change at any point.
@@ -18,8 +18,13 @@ Features listed under the `-dev` version have not yet been solidified and may ch
 
 - Added `cell-options` document-level option to specify global defaults for `{webr-r}` options ([#173](https://github.com/coatless/quarto-webr/pulls/173), thanks [ute](https://github.com/ute)!)
 
+- Added `editor-max-height` cell option to limit growth of the editor window. ([#177](https://github.com/coatless/quarto-webr/pulls/173), thanks [ute](https://github.com/ute)!)
+
+
 ## Bug fixes
 
+- Prevented vertical scroll bars from always being present by modifying the adaptive container of the editor to always be at least 2 pixels greater than the editor's content instead of being the exact amount. ([#164](https://github.com/coatless/quarto-webr/issues/164))
+
 ## Documentation
 
 # 0.4.1: Vivid Montage (03-25-2024)

tests/qwebr-test-editor-options.qmd

@@ -0,0 +1,42 @@
+---
+title: "Test: Editor Options"
+format: html
+engine: knitr
+filters:
+  - webr
+---
+
+Check that the editor responses correctly to options being set. 
+
+## Interactive
+
+
+### Single line
+
+```{webr-r}
+print("test")
+```
+
+
+### Uncapped height
+
+
+```{webr-r}
+print("test")
+59120
+1 + 1
+c(1, 3, 4)
+print("line 5")
+```
+
+
+### Height cap
+
+```{webr-r}
+#| editor-max-height: 80
+print("test")
+59120
+1 + 1
+c(1, 3, 4)
+print("line 5")
+```