Solid v2

.github/workflows/docs-preview.yml

@@ -0,0 +1,131 @@
+name: 📚 Docs Preview
+
+# Publishes each pull request's docs to its own surge.sh domain, comments the
+# link on the PR, and tears the site down when the PR closes. Pair it with the
+# pkg.pr.new comment from Continuous Releases and a PR has both an installable
+# package and the docs that describe it.
+#
+# Needs one repository secret, SURGE_TOKEN: run `npx surge token` locally.
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, closed]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+concurrency:
+  group: docs-preview-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+env:
+  DOMAIN: sparkstonepdx-solid-validation-pr-${{ github.event.pull_request.number }}.surge.sh
+
+jobs:
+  deploy:
+    name: "📚 Deploy docs preview"
+    # Pull requests from forks get no secrets, so they can't deploy.
+    if: >-
+      github.event.action != 'closed' &&
+      github.event.pull_request.head.repo.full_name == github.repository
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v3
+        with:
+          # matches packageManager in package.json
+          version: 12.4.2
+
+      - name: Use Node.js 24
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      # The root build is the library only; the docs build lives in website/
+      # and builds the library itself first. It writes the newest version and
+      # the root index into docs/, next to the frozen v1 already committed.
+      - name: Build
+        run: pnpm --dir website build
+
+      # The site is built for /solid-validation/, the path GitHub Pages serves
+      # it under, but a surge domain serves from its root. Placing the build
+      # one directory down keeps every path valid, and a root page forwards.
+      - name: Stage for surge
+        run: |
+          mkdir -p surge/solid-validation
+          cp -r docs/. surge/solid-validation/
+          cat > surge/index.html <<'HTML'
+          <!doctype html>
+          <meta charset="utf-8" />
+          <meta http-equiv="refresh" content="0; url=/solid-validation/" />
+          <a href="/solid-validation/">solid-validation docs</a>
+          HTML
+
+      - name: Deploy to surge.sh
+        run: pnpm exec surge ./surge "$DOMAIN"
+        env:
+          SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}
+
+      - name: Comment the preview link
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const marker = '<!-- docs-preview -->';
+            const body = `${marker}\n📚 Docs preview: https://${process.env.DOMAIN}/solid-validation/\n\nBuilt from ${context.payload.pull_request.head.sha.slice(0, 7)}.`;
+            const { owner, repo } = context.repo;
+            const issue_number = context.payload.pull_request.number;
+            const comments = await github.paginate(github.rest.issues.listComments, { owner, repo, issue_number });
+            const existing = comments.find(c => c.body?.startsWith(marker));
+            if (existing) await github.rest.issues.updateComment({ owner, repo, comment_id: existing.id, body });
+            else await github.rest.issues.createComment({ owner, repo, issue_number, body });
+
+  teardown:
+    name: "🧹 Tear down docs preview"
+    if: >-
+      github.event.action == 'closed' &&
+      github.event.pull_request.head.repo.full_name == github.repository
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v3
+        with:
+          version: 12.4.2
+
+      - name: Use Node.js 24
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Tear down surge.sh site
+        run: pnpm exec surge teardown "$DOMAIN"
+        env:
+          SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}
+
+      - name: Mark the comment as removed
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const marker = '<!-- docs-preview -->';
+            const { owner, repo } = context.repo;
+            const issue_number = context.payload.pull_request.number;
+            const comments = await github.paginate(github.rest.issues.listComments, { owner, repo, issue_number });
+            const existing = comments.find(c => c.body?.startsWith(marker));
+            if (existing) {
+              await github.rest.issues.updateComment({
+                owner, repo, comment_id: existing.id,
+                body: `${marker}\n📚 Docs preview removed: the pull request was closed.`,
+              });
+            }

.github/workflows/pkg-pr-new.yml

@@ -0,0 +1,48 @@
+name: ⚡️ Continuous Releases
+
+on:
+  push:
+    branches:
+      - main
+  merge_group:
+  pull_request:
+
+jobs:
+  cr:
+    name: "⚡️ Continuous Releases"
+
+    strategy:
+      fail-fast: false
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v3
+        with:
+          # matches packageManager in package.json
+          version: 12.4.2
+
+      - name: Use Node.js 24
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      # Unlike the css repo, this library has a test suite, so a build that
+      # fails it is not published as an installable preview.
+      - name: Test
+        run: pnpm test
+
+      - name: Build
+        run: pnpm run build
+
+      # pkg.pr.new asks that CI runs it from the lockfile rather than through
+      # dlx, so the version is pinned with everything else. Run from the root,
+      # it publishes the library only: the docs sites are private.
+      - name: Release
+        run: pnpm exec pkg-pr-new publish --compact

.gitignore

@@ -5,3 +5,6 @@ coverage
 
 # The built site is committed: github pages serves the repo's /docs folder.
 !/docs
+
+# Staging directory for surge.sh docs previews, built in CI.
+surge

changelog.md

@@ -5,6 +5,38 @@ All notable changes to `@sparkstone/solid-validation` will be documented in this
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.0]
+
+Targets Solid 2. **Projects on Solid 1 should stay on 1.x**: this release will
+not run there, and 1.6.1 remains supported for Solid 1. The v1 documentation
+stays published alongside the v2 docs.
+
+The [migration guide](https://sparkstonepdx.github.io/solid-validation/v2/migrating/)
+covers each change below with before and after code.
+
+### Changed
+- **Directives are replaced by ref factories.** Solid 2 has no `use:`
+  directives. `use:validate` becomes `ref={validate()}` and
+  `use:formSubmit={onSubmit}` becomes `ref={formSubmit(onSubmit)}`.
+- **`validate` takes an accessor** returning the validator array:
+  `ref={validate(() => [minLength(3)])}`.
+- **`submit()` returns `Promise<boolean>`**: `true` when the submission went
+  through, `false` when validation refused or the callback returned errors. It
+  returned `void` before, so a caller could not tell whether it ran.
+- **Cleared errors delete their key** instead of setting it to `undefined`, so
+  `Object.keys(errors)` lists only fields that are currently failing.
+- **Errors arrive on the next flush.** Solid 2 batches store writes, so an error
+  is no longer in the store in the same tick as the event that caused it.
+  Rendering is unaffected; imperative reads and tests should wait.
+- Peer dependencies are now `solid-js` and `@solidjs/web`, both `^2.0.0-rc.9`.
+
+### Removed
+- **`validateRef`.** It existed because a directive could not be passed as a
+  prop. `validate` returns an ordinary ref callback, so it covers that case:
+  `ref={props.validate(() => [...])}`.
+
+---
+
 ## [1.6.1]
 
 ### Changed