@rehearsal-db/core 1.1.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +43 -1
- package/COMPATIBILITY.md +40 -0
- package/README.md +7 -3
- package/dist/package.json +4 -1
- package/dist/src/cli/arguments.d.mts +1 -0
- package/dist/src/cli/arguments.mjs +5 -0
- package/dist/src/cli/basic_command_handlers.mjs +6 -0
- package/dist/src/cli/cli_commands.mjs +2 -0
- package/dist/src/cli/editor_command_handlers.mjs +24 -0
- package/dist/src/cli/project_commands.d.mts +8 -0
- package/dist/src/cli/runtime_commands.d.mts +2 -19
- package/dist/src/cli/runtime_commands.mjs +3 -90
- package/dist/src/cli/runtime_stack_runner.d.mts +41 -0
- package/dist/src/cli/runtime_stack_runner.mjs +104 -0
- package/dist/src/cli/runtime_workload_admission.d.mts +8 -0
- package/dist/src/cli/runtime_workload_admission.mjs +22 -0
- package/dist/src/cli/source_commands.d.mts +8 -0
- package/dist/src/cli/workload_command_handlers.d.mts +2 -0
- package/dist/src/cli/workload_command_handlers.mjs +38 -0
- package/dist/src/project/configuration_contract.d.mts +5 -0
- package/dist/src/project/configuration_normalization.d.mts +4 -0
- package/dist/src/project/configuration_resolution.d.mts +4 -0
- package/dist/src/project/configuration_resource_policy.d.mts +4 -0
- package/dist/src/project/configuration_resource_policy.mjs +20 -1
- package/dist/src/project/configuration_schema.mjs +1 -0
- package/dist/src/runtime/migration_history.d.mts +5 -1
- package/dist/src/runtime/migration_history.mjs +24 -6
- package/dist/src/runtime/migration_impact.d.mts +125 -0
- package/dist/src/runtime/migration_impact.mjs +278 -0
- package/dist/src/runtime/migration_impact_catalog.d.mts +18 -0
- package/dist/src/runtime/migration_impact_catalog.mjs +116 -0
- package/dist/src/runtime/migration_impact_plan.d.mts +47 -0
- package/dist/src/runtime/migration_impact_plan.mjs +297 -0
- package/dist/src/runtime/migration_impact_queries.d.mts +22 -0
- package/dist/src/runtime/migration_impact_queries.mjs +270 -0
- package/dist/src/runtime/migration_insights.d.mts +137 -0
- package/dist/src/runtime/migration_insights.mjs +143 -0
- package/dist/src/runtime/migration_insights_input.d.mts +13 -0
- package/dist/src/runtime/migration_insights_input.mjs +153 -0
- package/dist/src/runtime/migration_sql_lexer.d.mts +14 -0
- package/dist/src/runtime/migration_sql_lexer.mjs +204 -0
- package/dist/src/runtime/migration_sql_scan.d.mts +16 -0
- package/dist/src/runtime/migration_sql_scan.mjs +369 -0
- package/dist/src/runtime/plan.d.mts +2 -1
- package/dist/src/runtime/plan.mjs +4 -4
- package/dist/src/runtime/topology.d.mts +1 -1
- package/dist/src/runtime/topology.mjs +2 -2
- package/dist/src/runtime/workload_queue.d.mts +39 -0
- package/dist/src/runtime/workload_queue.mjs +211 -0
- package/dist/src/runtime/workload_queue_location.d.mts +1 -0
- package/dist/src/runtime/workload_queue_location.mjs +43 -0
- package/dist/src/runtime/workload_queue_store.d.mts +27 -0
- package/dist/src/runtime/workload_queue_store.mjs +182 -0
- package/dist/src/shared/cancellation.mjs +2 -0
- package/dist/src/shared/held_path_ancestry.d.mts +7 -0
- package/dist/src/shared/held_path_ancestry.mjs +110 -0
- package/dist/src/shared/operation_guard.mjs +1 -0
- package/dist/src/targets/migration_impact_runtime.d.mts +22 -0
- package/dist/src/targets/migration_impact_runtime.mjs +367 -0
- package/docs/README.md +20 -7
- package/docs/adapters.md +10 -0
- package/docs/architecture.md +84 -1
- package/docs/commands.md +189 -34
- package/docs/configuration.md +56 -6
- package/docs/getting-started.md +1 -1
- package/docs/index.md +1 -0
- package/docs/releasing.md +15 -9
- package/docs/roadmap.md +27 -6
- package/docs/runtime-lifecycle.md +10 -0
- package/docs/stability.md +4 -4
- package/docs/updating.md +73 -0
- package/docs/vscode.md +23 -17
- package/package.json +4 -1
package/docs/vscode.md
CHANGED
|
@@ -4,9 +4,9 @@ The Rehearsal extension turns the local CLI into a project-aware database-change
|
|
|
4
4
|
workbench. It is for developers who want the safety of exact migration plans and disposable
|
|
5
5
|
local runtimes without memorizing every command.
|
|
6
6
|
|
|
7
|
-
This guide targets **Free Starter 0.1.
|
|
7
|
+
This guide targets **Free Starter 0.1.24**, named **Rehearsal DB** on
|
|
8
8
|
[VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=rehearsal-db.rehearsal-db),
|
|
9
|
-
with a [reviewed GitHub VSIX](https://github.com/Ddupasquier/rehearsal-vscode/releases/tag/v0.1.
|
|
9
|
+
with a [reviewed GitHub VSIX](https://github.com/Ddupasquier/rehearsal-vscode/releases/tag/v0.1.24)
|
|
10
10
|
for direct installation. The canonical extension ID is **`rehearsal-db.rehearsal-db`**,
|
|
11
11
|
published by **`rehearsal-db`**. The workbench and commands retain the **Rehearsal** brand.
|
|
12
12
|
All included features are free indefinitely for personal or commercial development.
|
|
@@ -24,6 +24,9 @@ identity. This is not an automatic rename or uninstall.
|
|
|
24
24
|
|
|
25
25
|
- See what Rehearsal detected, what it suggests, and what still needs your decision.
|
|
26
26
|
- Review, filter, sort, and check off the exact pending migration set.
|
|
27
|
+
- Read optional static Migration Insights with core 1.2.0 and open unchanged source
|
|
28
|
+
at a lexical finding. Unsupported analysis stays unknown; no warning is a safety
|
|
29
|
+
verdict or proof of valid SQL. No database is started or contacted for this analysis.
|
|
27
30
|
- Inspect targets, runtime state, retained baseline generations, local ports, and app URLs.
|
|
28
31
|
- Review safe configuration changes as an exact diff before writing them.
|
|
29
32
|
- Launch the same public CLI operations with their exact command and confirmation intact.
|
|
@@ -66,8 +69,9 @@ real WSL core fixtures do not certify a native Remote-WSL editor walkthrough.
|
|
|
66
69
|
4. Follow **Next best step**. Review the detected project and active configuration;
|
|
67
70
|
setup, source access, migration execution and cleanup keep their own confirmations.
|
|
68
71
|
|
|
69
|
-
|
|
70
|
-
|
|
72
|
+
Core and the extension have independent version numbers. This guide targets core
|
|
73
|
+
**1.3.0** and Starter **0.1.24**, only once each is published. See [Updates](updating.md)
|
|
74
|
+
when moving an existing installation forward.
|
|
71
75
|
The extension's minimum core is `0.1.0-rc.4`. A project that is not ready should show
|
|
72
76
|
setup guidance, not require you to build the extension. Opening the dashboard does not
|
|
73
77
|
start a database or run a migration. Use
|
|
@@ -92,10 +96,10 @@ distinction between desktop OS, extension host, architecture and actual database
|
|
|
92
96
|
### Direct GitHub installation
|
|
93
97
|
|
|
94
98
|
The verified GitHub VSIX is an alternative to Marketplace. Open the
|
|
95
|
-
[Starter 0.1.
|
|
96
|
-
Under **Assets**, download `rehearsal-db-0.1.
|
|
97
|
-
run `shasum -a 256 /path/to/rehearsal-db-0.1.
|
|
98
|
-
`sha256sum /path/to/rehearsal-db-0.1.
|
|
99
|
+
[Starter 0.1.24 release](https://github.com/Ddupasquier/rehearsal-vscode/releases/tag/v0.1.24).
|
|
100
|
+
Under **Assets**, download `rehearsal-db-0.1.24.vsix` and `SHA256SUMS`. In a terminal,
|
|
101
|
+
run `shasum -a 256 /path/to/rehearsal-db-0.1.24.vsix` on macOS or
|
|
102
|
+
`sha256sum /path/to/rehearsal-db-0.1.24.vsix` on Linux. Compare the result with that
|
|
99
103
|
release's `SHA256SUMS`; stop if they differ. Do not substitute a local rebuild.
|
|
100
104
|
Then open **Extensions → … → Install from VSIX…** and choose the verified file.
|
|
101
105
|
Save your work and reload only if VS Code asks.
|
|
@@ -227,7 +231,7 @@ route; do not delete its coordination lock while a package manager may still be
|
|
|
227
231
|
|
|
228
232
|
Manual updating stays available: download and verify the next reviewed VSIX, then repeat
|
|
229
233
|
**Install from VSIX…**. See the release's
|
|
230
|
-
[installation guide](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.
|
|
234
|
+
[installation guide](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.24/README.md#install-and-open-your-project).
|
|
231
235
|
An ordinary core-package update is detected from its manifest, lockfile and installed
|
|
232
236
|
metadata without reloading VS Code. The header shows loaded extension and core versions
|
|
233
237
|
separately; installed → newest appears only after a successful release check. Unknown or
|
|
@@ -236,16 +240,18 @@ offline availability is not proof that you are up to date.
|
|
|
236
240
|
## Privacy boundary
|
|
237
241
|
|
|
238
242
|
Passive inspection stays local. The extension includes no telemetry, advertising, hosted
|
|
239
|
-
database access, or account. It does not read environment files, credentials, private rows
|
|
240
|
-
baseline contents
|
|
243
|
+
database access, or account. It does not read environment files, credentials, private rows
|
|
244
|
+
or baseline contents. With the optional Insights capability, core also reads bounded
|
|
245
|
+
project-local migration files and returns fixed findings, not SQL bodies or row values.
|
|
246
|
+
No SQL is executed or uploaded and no database is contacted for static analysis. An explicit migration
|
|
241
247
|
source action reads only the selected local input to check its approved bytes before
|
|
242
248
|
opening it in the editor; it does not upload SQL. User-approved package operations and
|
|
243
249
|
external links may use their own services.
|
|
244
250
|
|
|
245
251
|
## License, support and future Pro
|
|
246
252
|
|
|
247
|
-
Starter 0.1.
|
|
248
|
-
[free Starter license](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.
|
|
253
|
+
Starter 0.1.24 carries the same
|
|
254
|
+
[free Starter license](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.24/LICENSE).
|
|
249
255
|
Its current review, configuration, comparison and reporting tools are included; they
|
|
250
256
|
are not a timed evaluation or a paid feature gate. Free use does not mean the extension
|
|
251
257
|
is MIT-licensed: its bundled terms govern copying and redistribution. Core remains MIT.
|
|
@@ -254,17 +260,17 @@ Future optional Pro editor workflows must be separately identified. They cannot
|
|
|
254
260
|
retroactively remove Starter rights already granted for a received version. Pro pricing,
|
|
255
261
|
billing and entitlements are not implemented; no payment is needed to use Starter.
|
|
256
262
|
Database and safety capabilities stay in the free CLI. The
|
|
257
|
-
[edition guide](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.
|
|
263
|
+
[edition guide](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.24/docs/commercial-readiness.md)
|
|
258
264
|
owns the detailed boundary.
|
|
259
265
|
|
|
260
266
|
Preview describes stability, not a trial countdown. Support is best effort, with no
|
|
261
267
|
service-level agreement, database hosting, backups or production support. Before use,
|
|
262
|
-
read the release's [privacy statement](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.
|
|
263
|
-
and [support policy](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.
|
|
268
|
+
read the release's [privacy statement](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.24/PRIVACY.md)
|
|
269
|
+
and [support policy](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.24/SUPPORT.md).
|
|
264
270
|
Report editor problems in the
|
|
265
271
|
[Rehearsal issue tracker](https://github.com/Ddupasquier/rehearsal-db/issues), as
|
|
266
272
|
described in the support policy.
|
|
267
|
-
Use its [private security process](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.
|
|
273
|
+
Use its [private security process](https://github.com/Ddupasquier/rehearsal-vscode/blob/v0.1.24/SECURITY.md)
|
|
268
274
|
for vulnerabilities; never post credentials, private rows or baseline files publicly.
|
|
269
275
|
|
|
270
276
|
Historical VSIX files retain their bundled terms. Choose a reviewed release carrying
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rehearsal-db/core",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.3.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Catch PostgreSQL and Supabase migrations that pass on empty databases but fail on real data—before deploy.",
|
|
6
6
|
"repository": {
|
|
@@ -26,7 +26,10 @@
|
|
|
26
26
|
"projectDiscovery": 1,
|
|
27
27
|
"resourceInventory": 1,
|
|
28
28
|
"resourceManager": 1,
|
|
29
|
+
"workloadQueue": 1,
|
|
29
30
|
"migrationReview": 1,
|
|
31
|
+
"migrationInsights": 1,
|
|
32
|
+
"migrationImpact": 1,
|
|
30
33
|
"configurationReview": 1,
|
|
31
34
|
"baselineShape": 1
|
|
32
35
|
},
|