Add re-frame-example

.github/workflows/test.yml

@@ -39,7 +39,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        example: [reagent-karma-example, node-test-example]
+        example: [reagent-karma-example, node-test-example, re-frame-example]
     defaults:
       run:
         working-directory: examples/${{ matrix.example }}

examples/re-frame-example/.clj-kondo/config.edn

@@ -0,0 +1,4 @@
+;; `await` is the native ClojureScript async operator (cljs >= 1.12.145).
+;; The clj-kondo release on npm does not recognize it yet, so silence the
+;; unresolved-symbol warning for it here.
+{:linters {:unresolved-symbol {:exclude [await]}}}

examples/re-frame-example/.gitignore

@@ -0,0 +1,7 @@
+node_modules
+/out
+/target
+/.shadow-cljs
+/.cpcache
+/.clj-kondo/.cache
+/.clj-kondo/imports

examples/re-frame-example/.prettierignore

@@ -0,0 +1,5 @@
+node_modules
+out
+target
+.shadow-cljs
+.cpcache

examples/re-frame-example/.prettierrc.json

@@ -0,0 +1,3 @@
+{
+  "plugins": ["prettier-plugin-cljfmt"]
+}

examples/re-frame-example/README.md

@@ -0,0 +1,33 @@
+# re-frame-example
+
+An example of testing a [re-frame](https://github.com/day8/re-frame) app with
+[`react-testing-library-cljs`](https://github.com/olecve/react-testing-library-cljs),
+using shadow-cljs's `:node-test` target and jsdom — no browser required.
+
+## What it demonstrates
+
+- **`app.events-test`** — unit-testing re-frame event and subscription handlers
+  as plain functions (the recommended re-frame pattern), with no DOM.
+- **`app.views-test`** — testing a re-frame view with the library:
+  - rendering it and reading the DOM with `screen`,
+  - reacting to a synchronous `dispatch-sync` (wrapped in `act`),
+  - driving state through a real click and waiting for the async re-frame
+    `dispatch` to reach the DOM via `find-by-text`.
+
+## Setup essentials
+
+- `shadow-cljs.edn` declares `reagent` and `re-frame` as dependencies and a
+  `:node-test` build with an `app.test-setup` preload. It references the
+  library's source in this repo via `:source-paths` (so the example always
+  tracks HEAD); a standalone project would add the Clojars dependency instead —
+  see the repository root README.
+- `src/app/test_setup.cljs` registers jsdom and sets `IS_REACT_ACT_ENVIRONMENT`.
+
+## Running
+
+```bash
+npm install
+npm test        # compile the :test build and run it on Node
+npm run lint    # clj-kondo
+npm run fmt     # prettier + cljfmt
+```