Add error message for missing templates. (#109)

coatless · Nov 19, 2023 · e370fbb · e370fbb
1 parent ac97ee9
commit e370fbb
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/_extensions/webr/webr.lua b/_extensions/webr/webr.lua
@@ -175,11 +175,17 @@ function readTemplateFile(template)
 
   -- Let's hopefully read the template file... 
 
-  -- Open the webr editor
+  -- Open the template file
   local file = io.open(path, "r")
 
   -- Check if null pointer before grabbing content
-  if not file then
+  if not file then        
+    error("\nWe were unable to read the template file `" .. template .. "` from the extension directory.\n\n" ..
+          "Double check that the extension is fully available by comparing the \n" ..
+          "`_extensions/coatless/webr` directory with the main repository:\n" ..
+          "https://github.com/coatless/quarto-webr/tree/main/_extensions/webr\n\n" ..
+          "You may need to modify `.gitignore` to allow the extension files using:\n" ..
+          "!_extensions/*/*/*\n")
     return nil
   end
 

diff --git a/docs/qwebr-release-notes.qmd b/docs/qwebr-release-notes.qmd
@@ -20,6 +20,10 @@ format:
 
 - Minor documentation tweaks.
 
+## Deployment
+
+- Added an instructive error message regarding whether template files are missing. ([#107](https://github.com/coatless/quarto-webr/issues/107))
+
 # 0.3.9: Zoom-Zoom (11-16-2023)
 
 ## Breaking changes