Enable the IDE cell evaluation with webr-r tag (#12)

* Enable the IDE cell evaluation with webr-r tag

* Bump version

Author: coatless

.gitignore

@@ -0,0 +1 @@
+/.luarc.json

README.md

@@ -45,7 +45,7 @@ filters:
 
 This is a webr-enabled code cell in a Quarto HTML document.
 
-```{webr}
+```{webr-r}
 fit = lm(mpg ~ am, data = mtcars)
 summary(fit)
 ```
@@ -148,8 +148,8 @@ For additional justificaiton on why the headers are required, please see [webR's
 
 ### Engine Registration
 
-If using the `knitr` engine instead of the `jupyter` engine, there is a known warning
-that will appear in the render processing output of:
+If using the `knitr` engine instead of the `jupyter` engine and you are using the original tag of `{webr}` instead of `{webr-r}`, 
+there is a known warning that will appear in the render processing output of:
 
 ```r
 Warning message:
@@ -160,11 +160,12 @@ In get_engine(options$engine) :
 This warning does not prevent or impact the ability of the `webr` filter to function. 
 Though, we would like to address it at some point since it is not aesthetically pleasing.
 
-
 ## Acknowledgements
 
 We appreciate the early testing feedback from [Eli E. Holmes](https://eeholmes.github.io/) and [Bob Rudis](https://rud.is/).
 
+We also appreciate the Quarto team assisting with [setting up a new code cell type](https://github.com/quarto-dev/quarto-cli/discussions/4761#discussioncomment-5336636).
+
 This repository builds ontop of the initial proof of concept for a standalone Quarto HTML document in:
 
 <https://github.com/coatless-r-n-d/webR-quarto-demos>

_extensions/webr/_extension.yml

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

_extensions/webr/webr.lua

@@ -92,39 +92,54 @@ return {
       -- Should display the following elements:
       -- https://pandoc.org/lua-filters.html#type-codeblock
 
-      -- Ensure that the {webr} tag is present and the document type is HTML
+      -- Verify the element has attributes and the document type is HTML
       -- not sure if this will work with an epub (may need html:js)
-      -- Right now, we're using `{webr}` if engine is jupyter and `webr` if engine is `knitr` since the later dislikes custom engines
-      if el.attr and (el.attr.classes:includes("{webr}") or el.attr.classes:includes("webr")) and quarto.doc.is_format("html") then
-        
-        -- Make sure we've initialized the code block
-        ensureWebRSetup()
+      if el.attr and quarto.doc.is_format("html") then
 
-        -- Modify the counter variable each time this is run to create
-        -- unique code cells
-        counter = counter + 1
-        
-        -- 7 is the default height and width for knitr. But, that doesn't translate to pixels.
-        -- So, we have 504 and 360 respectively.
-        -- Should we check the attributes for this value? Seems odd.
-        -- https://yihui.org/knitr/options/
-        local substitutions = {
-          ["WEBRCOUNTER"] = counter, 
-          ["WIDTH"] = 504,
-          ["HEIGHT"] = 360,
-          ["WEBRCODE"] = escapeControlSequences(el.text)
-        }
-        
-        -- Make sure we perform a copy
-        local copied_editor_template = editor_template
+        -- Check to see if any form of the {webr} tag is present 
 
-        -- Make the necessary substitutions
-        local webr_enabled_code_cell = substitute_in_file(copied_editor_template, substitutions)
+        -- Look for the original compute cell type `{webr}` 
+        -- If the compute engine is:
+        -- - jupyter: this appears as `{webr}` 
+        -- - knitr: this appears as `webr`
+        --  since the later dislikes custom engines
+        local originalEngine = el.attr.classes:includes("{webr}") or el.attr.classes:includes("webr")
 
-        -- Return the modified HTML template as a raw cell
-        return pandoc.RawInline('html', webr_enabled_code_cell)
+        -- Check for the new engine syntax that allows for the cell to be 
+        -- evaluated in VS Code or RStudio editor views, c.f.
+        -- https://github.com/quarto-dev/quarto-cli/discussions/4761#discussioncomment-5336636
+        local newEngine = el.attr.classes:includes("{webr-r}")
+        
+        if (originalEngine or newEngine) then
+          
+          -- Make sure we've initialized the code block
+          ensureWebRSetup()
+
+          -- Modify the counter variable each time this is run to create
+          -- unique code cells
+          counter = counter + 1
+          
+          -- 7 is the default height and width for knitr. But, that doesn't translate to pixels.
+          -- So, we have 504 and 360 respectively.
+          -- Should we check the attributes for this value? Seems odd.
+          -- https://yihui.org/knitr/options/
+          local substitutions = {
+            ["WEBRCOUNTER"] = counter, 
+            ["WIDTH"] = 504,
+            ["HEIGHT"] = 360,
+            ["WEBRCODE"] = escapeControlSequences(el.text)
+          }
+          
+          -- Make sure we perform a copy
+          local copied_editor_template = editor_template
+
+          -- Make the necessary substitutions
+          local webr_enabled_code_cell = substitute_in_file(copied_editor_template, substitutions)
+
+          -- Return the modified HTML template as a raw cell
+          return pandoc.RawInline('html', webr_enabled_code_cell)
+        end
       end
-      
       -- Allow for a pass through in other languages
       return el
     end

webr-demo.qmd

@@ -8,24 +8,24 @@ filters:
 
 ## Demo
 
-This is a webr-enabled code cell in a Quarto HTML document.
+WebR-enabled code cell are established by using `{webr-r}` in a Quarto HTML document.
 
-```{webr}
+```{webr-r}
 1 + 1 
 ```
 
 ## Sample cases
 
 ### Fit a linear regression model
 
-```{webr}
+```{webr-r}
 fit = lm(mpg ~ am, data = mtcars)
 summary(fit)
 ```
 
 ### Create a graph with base R
 
-```{webr}
+```{webr-r}
 plot(pressure)
 ```
 
@@ -36,7 +36,7 @@ plot(pressure)
 
 You can view what packages are available for webR by either executing the following R code (either with WebR or just R):
 
-```{webr}
+```{webr-r}
 available.packages(
     repos="https://repo.r-wasm.org/", 
     type="source")[,c("Package", "Version")]
@@ -50,15 +50,15 @@ Or, by navigating to the WebR repository:
 
 Installing `ggplot2` may take at least 2 minutes to run. 
 
-```{webr}
+```{webr-r}
 webr::install("ggplot2")
 ```
 
 #### Using a Package
 
 Once `ggplot2` is loaded, then use the package as normal.
 
-```{webr}
+```{webr-r}
 library(ggplot2)
 
 p = ggplot(mpg, aes(class, hwy))
@@ -67,33 +67,39 @@ p + geom_boxplot()
 
 ### Define variables and re-use them in later cells
 
-```{webr}
+```{webr-r}
 name = "James"
 age = 42
 ```
 
 
-```{webr}
+```{webr-r}
 message(name, " is ", age, " years old!")
 ```
 
 
 ### Escape characters in a string
 
-```{webr}
+```{webr-r}
 seven_seas = "Ahoy, matey!\nLet's set sail for adventure!\n"
 seven_seas
 ```
 
 ### Anonymous function definition
 
-```{webr}
+```{webr-r}
 add_one <- \(x) x + 1
 add_one(2)
 ```
 
 ### Empty code cell
 
-```{webr}
+```{webr-r}
 
+```
+
+### Pre-rendered code cell
+
+```{r}
+message("Hello!")
 ```