Add coverage reports to CI (#49)

* ci: add initial ci scripts

Add test & preflight CI scripts to test that I'm doing this right lol

* ci: add repo checkout steps (duh)

* ci: add dependency caching, polish other steps

* ci: add fn-setup reusable workflow

Add fn-setup to encapsulate all setup steps and DRY up the main ci workflow

* ci: debug deno directory

* ci: test out whether specifying DENO_DIR makes caching work properly

* ci: add DENO_DIR env variable to Set up Deno action

* ci: switch up debugging, remove DENO_DIR

* ci: change debug command

* ci: try using cache dir from cache action docs

* ci: update setup fn workflow with fixes from ci workflow

* ci: refactor ci workflow to use setup fn workflow and run tests

* ci: move checkout action to outside workflow fn

* ci: fix using workflow fn

* ci: remove preflight

* ci: rename CI workflow to proper file extension

* ci: rename setup fn workflow to proper file extension

* ci: create fn-setup composite workflow

* ci: try using composite workflow instead of reusable workflow

* ci: supply paths to deno deps cache action

* ci: clean up naming

* ci: debug: what happens when we remove the deps cache

* ci: debug: now what happens if we take away the cache hash

* ci: simplify everything back down to a single CI workflow

* ci: be sure to check out repository again

* ci: debug: what happens when we remove deps cache

* ci: debug: what happens when we take out explicit caching and only specify a hash

* ci: debug: what happens when we use it for both

* ci: officially remove vestigial caching

* ci: debug: what happens when we disable caching for test job

* ci: reactivate test job caching

* ci: remove redundant runner.os parameter

* ci: debug: what happens when we omit installing deps in test job

* ci: officially remove vestigial deno install

* ci: remove vestigial id props

* ci: add biome linting step

* ci: clarify when CI workflow runs

* ci: make deno permissions stricter

* ci: broaden scopes to original breadth

* ci: add check command

* chore: upgrade dependencies

* chore: add permissions

* chore: add coverage to .gitignore

* ci: add coverage reporting

* ci: prevent coverage guard action from uploading coverage report

* ci: remove coverage guard action

* ci: split coverage report artifacts

* ci: shuffle deno tests in CI

Author: ben-laird

.github/workflows/ci.yml

@@ -41,7 +41,21 @@ jobs:
           cache-hash: ${{ env.CACHE_KEY_BASE }}-${{ hashFiles('deno.lock') }}
 
       - name: Test
-        run: deno test --allow-read --no-prompt
+        run: deno test -P --no-prompt --coverage --shuffle
+
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: |
+            coverage/html
+            coverage/lcov.info
+
+      - name: Upload raw coverage files
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report-raw
+          path: coverage/*.json
 
   lint:
     name: Lint

.gitignore

@@ -1,3 +1,6 @@
+# Deno coverage report directory
+coverage
+
 hide*
 .vscode
 *.s

biome.jsonc

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://biomejs.dev/schemas/2.2.6/schema.json",
+  "$schema": "https://biomejs.dev/schemas/2.3.6/schema.json",
   "vcs": {
     "enabled": true,
     "clientKind": "git",

deno.jsonc

@@ -11,16 +11,29 @@
     // Import alias
     "@root/": "./",
     // External dependencies
-    "@biomejs/biome": "npm:@biomejs/biome@2.2.6",
-    "@std/assert": "jsr:@std/assert",
-    "@std/testing": "jsr:@std/testing",
-    "@std/fmt": "jsr:@std/fmt",
-    "@std/cli": "jsr:@std/cli",
-    "@std/fs": "jsr:@std/fs",
-    "@std/path": "jsr:@std/path",
+    "@biomejs/biome": "npm:@biomejs/biome@2.3.6",
+    "@std/assert": "jsr:@std/assert@1.0.16",
+    "@std/testing": "jsr:@std/testing@1.0.16",
+    "@std/fmt": "jsr:@std/fmt@1.0.8",
+    "@std/cli": "jsr:@std/cli@1.0.24",
+    "@std/fs": "jsr:@std/fs@1.0.20",
+    "@std/path": "jsr:@std/path@1.1.3",
     "chevrotain": "npm:chevrotain@^11.0.3"
   },
 
+  "test": {
+    "permissions": {
+      "read": true
+    }
+  },
+
+  "permissions": {
+    "biome": {
+      "env": true,
+      "run": true
+    }
+  },
+
   // Loosely ported from .prettierrc
   "fmt": {
     "useTabs": false,