@rehearsal-db/core 0.1.0-rc.9 → 1.0.1

package/docs/vscode.md

@@ -4,6 +4,22 @@ The Rehearsal extension turns the local CLI into a project-aware database-change
 workbench. It is for developers who want the safety of exact migration plans and disposable
 local runtimes without memorizing every command.
 
+This guide targets **Free Starter 0.1.21**, named **Rehearsal DB** on
+[VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=rehearsal-db.rehearsal-db),
+with a [reviewed GitHub VSIX](https://github.com/Ddupasquier/rehearsal-vscode/releases/tag/v0.1.21)
+for direct installation. The canonical extension ID is **`rehearsal-db.rehearsal-db`**,
+published by **`rehearsal-db`**. The workbench and commands retain the **Rehearsal** brand.
+All included features are free indefinitely for personal or commercial development.
+No account, payment card, purchase, trial period, or license activation is required.
+The CLI is separately available on [npm](https://www.npmjs.com/package/@rehearsal-db/core)
+under the MIT license. There is no paid CLI tier.
+Confirm the target version appears in its official channel before installing. A guide
+or checked-in version does not mean that publication has completed.
+
+Already using the GitHub preview through 0.1.18? Follow the
+[one-time migration steps](#move-from-a-preview-through-0118) before installing the new
+identity. This is not an automatic rename or uninstall.
+
 ## What you can do
 
 - See what Rehearsal detected, what it suggests, and what still needs your decision.
@@ -14,6 +30,11 @@ local runtimes without memorizing every command.
 - Export a privacy-safe verification report and review bounded local activity.
 - Keep the sidebar and open workbench current when another terminal changes the project's
   Rehearsal package, lockfile, manifest, or known configuration.
+- Browse resource inventories in independent pages of 5, 10 or 25 cards, rather than
+  one unbounded list.
+- Read a configuration diff before choosing **Apply changes** or **Cancel**, then
+  return to the project from the saved result.
+- Choose independent, initially off automatic-update options for the extension and CLI.
 
 The extension does not become a second database engine. Rehearsal core still owns data
 boundaries, baselines, migration digests, runtime isolation, locks, rollback, and cleanup.
@@ -22,6 +43,11 @@ boundaries, baselines, migration digests, runtime isolation, locks, rollback, an
 
 Use desktop VS Code 1.101 or newer on macOS or Linux and a supported Node.js release
 (22, 24, or 26). You do not need the extension source repository or Test Lab.
+For a Windows desktop, use the [WSL 2 Linux-workspace setup](getting-started.md#windows-use-a-wsl-2-linux-workspace).
+With editor 0.1.21, native Windows inspection and foreground actions refuse before launching a child
+process and directs you to Remote-WSL. Install the extension into the Linux extension
+host and keep the project on its Linux filesystem. WSL compatibility remains a preview;
+real WSL core fixtures do not certify a native Remote-WSL editor walkthrough.
 
 1. Open your application's folder in VS Code—the one containing `package.json` and
    your migrations. Install Rehearsal there if it is missing:
@@ -30,31 +56,154 @@ Use desktop VS Code 1.101 or newer on macOS or Linux and a supported Node.js rel
    npm install --save-dev @rehearsal-db/core
    ```
 
-2. Open the [reviewed GitHub prereleases](https://github.com/Ddupasquier/rehearsal-vscode/releases).
-   Download the chosen release's `.vsix` and `SHA256SUMS`. Compare the file's SHA-256
-   with that release's checksum; do not substitute an unreviewed rebuild.
-3. In VS Code, open **Extensions → … → Install from VSIX…** and choose that file.
-   Reload the extension host if VS Code asks.
-4. Review Workspace Trust, then open the Command Palette and choose
+2. Open **Extensions** and search **`@id:rehearsal-db.rehearsal-db`**, or open the
+   [official Rehearsal DB listing](https://marketplace.visualstudio.com/items?itemName=rehearsal-db.rehearsal-db).
+   Confirm publisher **`rehearsal-db`** and the full extension ID, then choose **Install**.
+   The similar-looking legacy ID `rehearsal-db.rehearsal` is not the canonical package.
+   If you prefer a direct download, use the verified GitHub VSIX instructions below.
+3. Review Workspace Trust, then open the Command Palette and choose
    **Rehearsal: Open Dashboard**. The Rehearsal sidebar also has a dashboard button.
-5. Follow **Next best step**. Review the detected project and active configuration;
+4. Follow **Next best step**. Review the detected project and active configuration;
    setup, source access, migration execution and cleanup keep their own confirmations.
 
-The extension needs `@rehearsal-db/core@0.1.0-rc.4` or newer. A project that is not ready
-should show setup guidance, not require you to build the extension. Use
+The release pairing described here is core **1.0.1** with Starter **0.1.21**.
+Install it once both versions appear in their official release channels.
+The extension's minimum core is `0.1.0-rc.4`. A project that is not ready should show
+setup guidance, not require you to build the extension. Opening the dashboard does not
+start a database or run a migration. Use
 [Getting started](getting-started.md) for the CLI and safe baseline inputs.
 
-## Updates
-
-GitHub VSIX installations do not auto-update. Download and verify the next reviewed
-release, then use **Install from VSIX…** again. Keep the previous reviewed file for
-rollback. See the extension's [installation guide](https://github.com/Ddupasquier/rehearsal-vscode#install-and-open-your-project)
-for checksum commands and the optional command-line installer.
-
-Updating the project's core package is separate: its manifest, lockfile and installed
-metadata trigger a narrow read-only refresh automatically. You do not reload the VS Code
-window after an ordinary core-package update. Replacing the VSIX may require VS Code's
-one-time extension-host reload so the new extension code becomes active.
+Native Windows inspection refusal is not database-runtime support. Browser-based
+VS Code, Codespaces, SSH and Dev Containers have no end-to-end support claim.
+Native Windows means the Windows Node/extension host, not a Windows desktop
+connected to WSL. iOS/iPadOS, Android, BSD and unlisted systems are not
+supported by this desktop/local-runtime release. Consult the
+[platform matrix](https://github.com/Ddupasquier/rehearsal-db/blob/main/COMPATIBILITY.md#operating-systems-and-execution-location) for the
+distinction between desktop OS, extension host, architecture and actual database proof.
+
+### Direct GitHub installation
+
+The verified GitHub VSIX is an alternative to Marketplace. Open the
+[Starter 0.1.21 release](https://github.com/Ddupasquier/rehearsal-vscode/releases/tag/v0.1.21).
+Under **Assets**, download `rehearsal-db-0.1.21.vsix` and `SHA256SUMS`. In a terminal,
+run `shasum -a 256 /path/to/rehearsal-db-0.1.21.vsix` on macOS or
+`sha256sum /path/to/rehearsal-db-0.1.21.vsix` on Linux. Compare the result with that
+release's `SHA256SUMS`; stop if they differ. Do not substitute a local rebuild.
+Then open **Extensions → … → Install from VSIX…** and choose the verified file.
+Save your work and reload only if VS Code asks.
+
+### Move from a preview through 0.1.18
+
+Earlier GitHub previews use `rehearsal-db.rehearsal`, a separate VS Code identity.
+Their released 0.1.18 bytes, tag and checksum remain available and unchanged. Its updater
+looks for `rehearsal-<version>.vsix`, so it ignores the canonical
+`rehearsal-db-<version>.vsix` family instead of silently switching identities.
+
+1. Finish Rehearsal commands in all open project windows. If a sandbox app is open,
+   press **Ctrl+C** once in its owning terminal and wait for its normal shell prompt
+   and configured lifecycle result. Save your work.
+2. Explicitly uninstall the legacy extension: in **Extensions**, search
+   **`@id:rehearsal-db.rehearsal`**, then use its gear menu → **Uninstall**.
+3. Save remaining files and run **Developer: Reload Window**. Ensure the old extension
+   is no longer installed in each profile where you will use the canonical version.
+4. Install **Rehearsal DB**, ID **`rehearsal-db.rehearsal-db`**, using Marketplace or the
+   verified canonical VSIX above. Reload if asked, reopen the dashboard and review your
+   update preferences.
+
+The canonical extension refuses activation whenever VS Code still reports the legacy ID.
+Not currently active is not proof that an installed extension is disabled; uninstalling
+and reloading is the supported route. The extension does not automatically uninstall,
+disable or rename your existing installation, interrupt a command or force a reload.
+
+This identity change does not reset or modify databases, Storage, project configuration,
+keys or baselines. Private per-extension view state, activity history and metadata-check
+consent are not copied to the new identity; re-select views and review consent there.
+Shared VS Code user settings, including `rehearsal.automaticUpdates`, retain your existing
+values. Review or disable those flags before migration if desired. Do not run database
+cleanup or **Reset Saved Editor State** as a migration step.
+
+## Everyday editor workflow
+
+Use **Overview** for the next safe step, **Migrations** to review the complete ordered
+candidate set, and **Environments** for local resource inventory. Filters and sorting
+apply to the full inventory before pagination. Each list has its own **Previous/Next**
+controls and **5/10/25** page size. Paging preserves drafts and selections; bulk image
+selection selects safe candidates on the current page only. Off-page selections remain
+counted and can be cleared before the exact cleanup review. Display filters never narrow
+database cleanup ownership or the required migration set.
+
+For configuration, change only the values you intend to change, then choose
+**Review exact configuration diff** or **Review name & protection**. The review tab
+keeps the full diff readable. **Cancel** makes no changes; **Apply changes** saves the
+reviewed change. Wait for **Saved**, then choose **Return to project**. Concurrent edits
+refuse safely instead of overwriting someone else's work; a saved confirmation is tied
+to the exact bytes read back from disk, not merely a completed write request.
+
+Commands reuse the same Rehearsal terminal for a project only after its previous command
+has a confirmed exit and its directory still matches. A running sandbox or manually
+entered foreground command is never interrupted to make room for another action. If
+shell integration or completion evidence is unavailable, finish the command and close
+that terminal before retrying. An idle database lock is not proof that a terminal is free.
+
+**Open sandbox** is a persistent hands-on session, not a task that should finish while
+you browse. Overview distinguishes **Opening sandbox**, **Sandbox running** and
+**Closing sandbox** from core phase evidence. Missing evidence says **Sandbox session
+open**, not ready. Project inspection waits for that session; the app itself is not
+paused. Use the local address shown by the owning terminal. **Open application** opens
+that address without running another CLI command. Press **Ctrl+C** once in the owning
+terminal when done, then wait for its shell prompt and the configured lifecycle result.
+
+## Optional automatic updates
+
+Open **Rehearsal: Check for Updates** from the Command Palette, or use the dashboard's
+**Check for updates** action. The prompt has two independent, initially unchecked choices:
+
+- **Automatically keep the Rehearsal extension up to date**
+- **Automatically keep Rehearsal CLI dependencies up to date**
+
+Check the options you want, then choose **Save preferences**. Checking a box alone does
+not save consent: **Later**, **Skip versions**, or closing the tab do not opt you in.
+These choices are stored only in machine-scoped VS Code user settings, not your
+repository or Settings Sync. A project cannot authorize automatic installation. You can
+also edit the user setting directly:
+
+```json
+"rehearsal.automaticUpdates": { "extension": true, "cli": false }
+```
+
+Extension updates download only the official GitHub release, verify the checksum,
+package identity and engine compatibility, and hand the local VSIX to VS Code's
+installer. Rehearsal never forces a window reload; VS Code may ask you to reload when
+you are ready to activate installed code. Keep the previous reviewed VSIX for rollback.
+Canonical automatic updates require `rehearsal-db-<version>.vsix` and embedded identity
+`rehearsal-db.rehearsal-db`; they do not automatically import or replace a legacy package.
+
+CLI updates require the separate CLI opt-in. They update compatible registry-backed npm
+dependencies in trusted, idle projects, preserve the dependency group, pin the exact
+checked version and update the lockfile with install scripts disabled. Busy or
+unknown-completion terminals, dirty dependency files, another window's update, offline
+services and unverifiable artifacts defer the update rather than guessing. Breaking
+upgrades, unsupported package managers and local/candidate provenance remain manual.
+No migration, database lifecycle action or forced editor reload is requested.
+
+Enabled automatic options check at project opening and daily while the editor stays
+open; there is no separate background daemon. npm/GitHub receive ordinary connection
+information and requested public releases, not project files, database data, credentials
+or installed-version reports. Metadata-only advisory checks keep their separate consent.
+
+Turn either option off to revoke its future automatic work. **Rehearsal: Configure
+Update Checks → Disable updates** turns both automatic options off on this computer and
+stops this project's release checks. Existing installations are not rolled back. An
+interrupted package-manager update with unknown completion requires the support recovery
+route; do not delete its coordination lock while a package manager may still be running.
+
+Manual updating stays available: download and verify the next reviewed VSIX, then repeat
+**Install from VSIX…**. See the release's
+[installation guide](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.21/README.md#install-and-open-your-project).
+An ordinary core-package update is detected from its manifest, lockfile and installed
+metadata without reloading VS Code. The header shows loaded extension and core versions
+separately; installed → newest appears only after a successful release check. Unknown or
+offline availability is not proof that you are up to date.
 
 ## Privacy boundary
 
@@ -63,28 +212,37 @@ database access, or account. It does not read environment files, credentials, pr
 baseline contents, or project source. User-approved package operations and external links
 may use their own services.
 
-## Licensing and planned editions
-
-The approved direction is a complete free MIT CLI, a useful free VS Code Starter, and
-optional paid Pro editor workflows. The [extension's edition guide](https://github.com/Ddupasquier/rehearsal-vscode/blob/main/docs/commercial-readiness.md)
-owns that planned split. Database and safety capabilities stay in the free CLI.
-
-The split is not implemented yet: current preview artifacts retain their bundled 14-day
-evaluation and per-user license, without a technical trial countdown or feature paywall.
-GitHub VSIX installations do not auto-update, so each reviewed delivery includes its exact
-version, compatible core range, checksum, privacy statement, license, and support policy.
-
-Technical GitHub prereleases are already public; they are not a Marketplace listing or
-an announcement of paid availability. A development candidate is not a released artifact
-merely because it has the same version number. Read the release's license, privacy and
-support documents before evaluation.
-
-Starter/Pro license terms and Marketplace distribution still need approval. Paid Pro
-availability also needs reviewed seller identity, checkout/refund arrangements and support
-ownership. Do not send payment based on an unofficial download or message. Native Windows,
-browser-based VS Code, Codespaces, SSH and Dev Containers are not yet claimed as supported.
+## License, support and future Pro
+
+Starter 0.1.21 carries the same
+[free Starter license](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.21/LICENSE).
+Its current review, configuration, comparison and reporting tools are included; they
+are not a timed evaluation or a paid feature gate. Free use does not mean the extension
+is MIT-licensed: its bundled terms govern copying and redistribution. Core remains MIT.
+
+Future optional Pro editor workflows must be separately identified. They cannot
+retroactively remove Starter rights already granted for a received version. Pro pricing,
+billing and entitlements are not implemented; no payment is needed to use Starter.
+Database and safety capabilities stay in the free CLI. The
+[edition guide](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.21/docs/commercial-readiness.md)
+owns the detailed boundary.
+
+Preview describes stability, not a trial countdown. Support is best effort, with no
+service-level agreement, database hosting, backups or production support. Before use,
+read the release's [privacy statement](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.21/PRIVACY.md)
+and [support policy](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.21/SUPPORT.md).
+Report editor problems in the
+[Rehearsal issue tracker](https://github.com/Ddupasquier/rehearsal-db/issues), as
+described in the support policy.
+Use its [private security process](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.21/SECURITY.md)
+for vulnerabilities; never post credentials, private rows or baseline files publicly.
+
+Historical VSIX files retain their bundled terms. Choose a reviewed release carrying
+the Starter license; a development candidate is not released merely because its version
+number matches. The [release list](https://github.com/Ddupasquier/rehearsal-vscode/releases)
+is the authority for downloadable artifacts and their checksums.
 
 ## Try the free engine first
 
 Start with [Getting started](getting-started.md). A successful CLI rehearsal proves the
-project and local runtime are compatible before you evaluate the visual workflow.
+project and local runtime are compatible before you use the visual workflow.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rehearsal-db/core",
-  "version": "0.1.0-rc.9",
+  "version": "1.0.1",
   "private": false,
   "description": "Catch PostgreSQL and Supabase migrations that pass on empty databases but fail on real data—before deploy.",
   "repository": {
@@ -76,9 +76,9 @@
     "test:fixture:standalone": "npm run build && node scripts/verification/run_scenario.mjs standalone",
     "test:fixture:privacy": "npm run build && node scripts/verification/run_scenario.mjs privacy",
     "test:fixture:resources": "npm run build && node scripts/verification/run_scenario.mjs resources",
-    "release:verify": "node scripts/verification/release_gate.mjs",
+    "release:verify": "npm run build && node scripts/verification/release_gate.mjs",
     "check": "npm run check:syntax && npm run typecheck && npm run test && npm run docs:build && npm run format:check && npm run package:audit",
-    "check:syntax": "find scripts tests -type f -name '*.mjs' -exec node --check {} +",
+    "check:syntax": "node scripts/verification/check_syntax.mjs",
     "typecheck": "npm run build && tsc --project tsconfig.json",
     "format": "prettier --write .",
     "format:check": "prettier --check .",