Merge pull request #34 from jimjam-slam/dev

v2.0.1: cleanup injection code, fix docs site

Author: jimjam-slam

.github/workflows/check.yml

@@ -15,6 +15,7 @@ jobs:
     strategy:
       matrix:
         os: ["ubuntu-latest", "windows-latest"]
+        quarto: ["release", "pre-release"]
 
     runs-on: ${{ matrix.os }}
 
@@ -24,29 +25,30 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      # check on both latest and prerelease
       - name: Install Quarto
         uses: quarto-dev/quarto-actions/setup@v2
         with:
-          version: 1.5.25
+          version: ${{ matrix.quarto }}
 
       - name: Install Node
         uses: actions/setup-node@v4
         with:
           node-version: 20
 
-      - name: Install quarto-svelte docs npm dependencies
-        run: npm install
+      - name: Copy quarto-evelte extension; run npm install
+        run: ./copy-extension.sh
         working-directory: ./docs
-
-      - name: Create docs _extensions folder
-        run: mkdir docs/_extensions
-        shell: bash
-
-      - name: Copy quarto-svelte extension into docs 
-        run: cp -rf _extensions/quarto-svelte docs/_extensions/quarto-svelte
         shell: bash
 
       - name: Render quarto-svelte docs
         uses: quarto-dev/quarto-actions/render@v2
         with:
           path: docs
+
+      - name: Verify that compiled Svelte .js bundles are present
+        shell: bash
+        run: |
+          test -f docs/_site/Circles.js &&
+          test -f docs/_site/examples/barchart/BarChart.js &&
+          test -f docs/_site/examples/time-series/TimeSeriesChart.js

.github/workflows/publish.yml

@@ -22,34 +22,45 @@ jobs:
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
     steps:
+      
       - uses: actions/checkout@v4
+
+      # use latest release version to publish docs
       - name: Install Quarto
         uses: quarto-dev/quarto-actions/setup@v2
         with:
-          version: 1.5.25
+          version: "release"
+      
       - name: Install Node
         uses: actions/setup-node@v4
         with:
           node-version: 20
-      - name: Install quarto-svelte docs npm dependencies
-        run: npm install
+      
+      - name: Copy quarto-evelte extension; run npm install
+        run: ./copy-extension.sh
         working-directory: ./docs
-      - name: Create docs _extensions folder
-        run: mkdir docs/_extensions
-        shell: bash
-      - name: Copy quarto-svelte extension into docs 
-        run: cp -rf _extensions/quarto-svelte docs/_extensions/quarto-svelte
         shell: bash
+      
       - name: Render quarto-svelte docs
         uses: quarto-dev/quarto-actions/render@v2
         with:
           path: docs
+      
+      - name: Verify that compiled Svelte .js bundles are present
+        shell: bash
+        run: |
+          test -f docs/_site/Circles.js &&
+          test -f docs/_site/examples/barchart/BarChart.js &&
+          test -f docs/_site/examples/time-series/TimeSeriesChart.js
+      
       - name: Setup Pages
         uses: actions/configure-pages@v5
+      
       - name: Upload docs/ artifact
         uses: actions/upload-pages-artifact@v3
         with:
           path: "./docs/_site"
+      
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4

NEWS.md

@@ -1,3 +1,8 @@
+## quarto-svelte 2.0.1
+
+- Improvement: extraneous OJS import code is removed from bootstrapping script
+- Fix errors in GitHub Actions workflows that prevented examples in the documentation site from appearing. GHA actions now run on latest Quarto release (check workflow also runs on latest prerelease).
+
 ## quarto-svelte 2.0.0
 
 - Rename Sverto to quarto-svelte

_extensions/quarto-svelte/_extension.yml

@@ -1,6 +1,6 @@
 title: quarto-svelte
 author: James Goldie
-version: 2.0.0
+version: 2.0.1
 quarto-version: ">=1.5.46"
 contributes:
   filters:

_extensions/quarto-svelte/quarto-svelte.lua

@@ -36,28 +36,7 @@ function inject_svelte_and_compile(m)
   -- either add text to start of body (and return nil), or return a rawblock
   -- %s: compiled svelte js path
   -- %s: obj_name
-  local svelte_js_import_template = [[
-    <script type="module">
-
-      // when the doc is ready, find quarto's ojs and inject svelte import
-      document.addEventListener("DOMContentLoaded", () => {
-        
-        import("%s").then(svelteModule => {
-
-          const ojsModule = window._ojs?.ojsConnector?.mainModule
-          if (ojsModule === undefined) {
-            console.error("Quarto OJS module not found")
-          }
-  
-          // TODO - check to see if there's already a variable with that name
-          const quartoSvelteImport = ojsModule?.variable()
-          quartoSvelteImport?.define("%s", svelteModule)
-
-        })
-
-      })
-    </script>
-  ]]
+  local svelte_js_import_template = '<script src="%s" type="module"></script>'
 
   -- abort if quarto-svelte.use is not a string or a list of MetaInlines
   local quarto_svelte_use = util.get_svelte_paths_from_meta(m)
@@ -80,7 +59,7 @@ function inject_svelte_and_compile(m)
 
     -- ... and inject the ojs init code for it
     local svelte_insert = string.format(svelte_js_import_template,
-      web_path, obj_name)
+      web_path)
     quarto.doc.include_text("before-body", svelte_insert)
 
     -- finally, if we're rendering a single doc (not in a project),

docs/news.qmd

@@ -3,6 +3,11 @@ title: News
 date: last-modified
 ---
 
+## quarto-svelte 2.0.1
+
+- Improvement: extraneous OJS import code is removed from bootstrapping script
+- Fix errors in GitHub Actions workflows that prevented examples in the documentation site from appearing. GHA actions now run on latest Quarto release (check workflow also runs on latest prerelease).
+
 ## quarto-svelte 2.0.0
 
 - Rename Sverto to quarto-svelte