@sponson/sim 0.8.0 → 0.9.1
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/dist/demo.d.ts +8 -1
- package/dist/demo.js +12 -4
- package/dist/demo.js.map +1 -1
- package/package.json +1 -1
package/dist/demo.d.ts
CHANGED
|
@@ -4,6 +4,11 @@ export declare const DEMO_BRANCH = "feat/checkout";
|
|
|
4
4
|
export declare const DEMO_PR = "42";
|
|
5
5
|
/** The file `source` loads in the second terminal. */
|
|
6
6
|
export declare const DEMO_ENV_FILE = "sim.env";
|
|
7
|
+
/**
|
|
8
|
+
* This package's version, read from package.json (one level above both src/ and dist/). The packages are released
|
|
9
|
+
* together at one version, so it is also the `sponson` CLI the demo runs: the demo and the fake cloud always match.
|
|
10
|
+
*/
|
|
11
|
+
export declare const SIM_VERSION: string;
|
|
7
12
|
/**
|
|
8
13
|
* Comments carry the explanation, because a newcomer reads this file before running anything. It uses only the
|
|
9
14
|
* projects every provider's default seed creates (`prj_demo`, `proj_demo`; Clerk needs none).
|
|
@@ -21,7 +26,9 @@ export declare function demoSteps(dir: string): string[];
|
|
|
21
26
|
/**
|
|
22
27
|
* The env file: the sim's URLs and placeholder tokens (`simEnv`), `SPONSON_SIM_URL` for the drift command, and the
|
|
23
28
|
* pull request number. Setting `SPONSON_CTX_PR` also keeps `sponson` from asking `gh` which pull request this is,
|
|
24
|
-
* which in a repository without a remote only costs time.
|
|
29
|
+
* which in a repository without a remote only costs time. `sponson` is a shell function running the CLI of this
|
|
30
|
+
* sim's own version through npx: a function shadows any `sponson` on PATH, so a global install of another version
|
|
31
|
+
* cannot run the demo against a fake cloud it does not match.
|
|
25
32
|
*/
|
|
26
33
|
export declare function demoEnvFile(url: string): string;
|
|
27
34
|
/** `export NAME=value` for everything a shell needs to point `sponson` at the sim at `url`. */
|
package/dist/demo.js
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
*/
|
|
7
7
|
import { execFile } from "node:child_process";
|
|
8
8
|
import { mkdir, readdir, writeFile } from "node:fs/promises";
|
|
9
|
+
import { createRequire } from "node:module";
|
|
9
10
|
import { join } from "node:path";
|
|
10
11
|
import { promisify } from "node:util";
|
|
11
12
|
import { simEnv } from "./index.js";
|
|
@@ -16,6 +17,11 @@ export const DEMO_BRANCH = "feat/checkout";
|
|
|
16
17
|
export const DEMO_PR = "42";
|
|
17
18
|
/** The file `source` loads in the second terminal. */
|
|
18
19
|
export const DEMO_ENV_FILE = "sim.env";
|
|
20
|
+
/**
|
|
21
|
+
* This package's version, read from package.json (one level above both src/ and dist/). The packages are released
|
|
22
|
+
* together at one version, so it is also the `sponson` CLI the demo runs: the demo and the fake cloud always match.
|
|
23
|
+
*/
|
|
24
|
+
export const SIM_VERSION = createRequire(import.meta.url)("../package.json").version;
|
|
19
25
|
/**
|
|
20
26
|
* Comments carry the explanation, because a newcomer reads this file before running anything. It uses only the
|
|
21
27
|
* projects every provider's default seed creates (`prj_demo`, `proj_demo`; Clerk needs none).
|
|
@@ -73,7 +79,7 @@ export function demoSteps(dir) {
|
|
|
73
79
|
}
|
|
74
80
|
/** One line per step of `demoSteps`, for the printed walkthrough. */
|
|
75
81
|
const STEP_NOTES = [
|
|
76
|
-
"point sponson at the fake cloud (placeholder tokens, no accounts)",
|
|
82
|
+
"point sponson at the fake cloud (placeholder tokens, no accounts) and at the CLI of this sim's version",
|
|
77
83
|
"the diff: a branch to create, a variable and a callback waiting on it",
|
|
78
84
|
"creates the branch, injects DATABASE_URL by reference, finds the preview deploy, allows its URL",
|
|
79
85
|
"again: every line unchanged, zero writes",
|
|
@@ -84,7 +90,9 @@ const STEP_NOTES = [
|
|
|
84
90
|
/**
|
|
85
91
|
* The env file: the sim's URLs and placeholder tokens (`simEnv`), `SPONSON_SIM_URL` for the drift command, and the
|
|
86
92
|
* pull request number. Setting `SPONSON_CTX_PR` also keeps `sponson` from asking `gh` which pull request this is,
|
|
87
|
-
* which in a repository without a remote only costs time.
|
|
93
|
+
* which in a repository without a remote only costs time. `sponson` is a shell function running the CLI of this
|
|
94
|
+
* sim's own version through npx: a function shadows any `sponson` on PATH, so a global install of another version
|
|
95
|
+
* cannot run the demo against a fake cloud it does not match.
|
|
88
96
|
*/
|
|
89
97
|
export function demoEnvFile(url) {
|
|
90
98
|
const lines = [
|
|
@@ -92,8 +100,8 @@ export function demoEnvFile(url) {
|
|
|
92
100
|
...envExports(url),
|
|
93
101
|
"# The demo pretends this branch is pull request #42 (scope pr-42).",
|
|
94
102
|
`export SPONSON_CTX_PR=${DEMO_PR}`,
|
|
95
|
-
"#
|
|
96
|
-
|
|
103
|
+
"# The CLI of the same version as this fake cloud, through npx (a function, so it wins over any installed sponson).",
|
|
104
|
+
`sponson() { npx --yes sponson@${SIM_VERSION} "$@"; }`,
|
|
97
105
|
];
|
|
98
106
|
return `${lines.join("\n")}\n`;
|
|
99
107
|
}
|
package/dist/demo.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"demo.js","sourceRoot":"","sources":["../src/demo.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;AAEjC,6EAA6E;AAC7E,MAAM,CAAC,MAAM,WAAW,GAAG,eAAe,CAAC;AAC3C,6FAA6F;AAC7F,MAAM,CAAC,MAAM,OAAO,GAAG,IAAI,CAAC;AAC5B,sDAAsD;AACtD,MAAM,CAAC,MAAM,aAAa,GAAG,SAAS,CAAC;AAEvC;;;GAGG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiCxB,CAAC;AAEF,gHAAgH;AAChH,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,iCAAiC,EAAE,iCAAiC,EAAE,CAAC;AAEnG;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW;IACnC,OAAO;QACL,MAAM,UAAU,CAAC,GAAG,CAAC,cAAc,aAAa,EAAE;QAClD,cAAc;QACd,eAAe;QACf,eAAe;QACf,sDAAsD,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,GAAG;QAC9F,cAAc;QACd,yBAAyB;KAC1B,CAAC;AACJ,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,GAAG;IACjB,
|
|
1
|
+
{"version":3,"file":"demo.js","sourceRoot":"","sources":["../src/demo.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;AAEjC,6EAA6E;AAC7E,MAAM,CAAC,MAAM,WAAW,GAAG,eAAe,CAAC;AAC3C,6FAA6F;AAC7F,MAAM,CAAC,MAAM,OAAO,GAAG,IAAI,CAAC;AAC5B,sDAAsD;AACtD,MAAM,CAAC,MAAM,aAAa,GAAG,SAAS,CAAC;AAEvC;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAY,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,iBAAiB,CAAyB,CAAC,OAAO,CAAC;AAEtH;;;GAGG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiCxB,CAAC;AAEF,gHAAgH;AAChH,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,iCAAiC,EAAE,iCAAiC,EAAE,CAAC;AAEnG;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW;IACnC,OAAO;QACL,MAAM,UAAU,CAAC,GAAG,CAAC,cAAc,aAAa,EAAE;QAClD,cAAc;QACd,eAAe;QACf,eAAe;QACf,sDAAsD,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,GAAG;QAC9F,cAAc;QACd,yBAAyB;KAC1B,CAAC;AACJ,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,GAAG;IACjB,wGAAwG;IACxG,uEAAuE;IACvE,iGAAiG;IACjG,0CAA0C;IAC1C,yDAAyD;IACzD,iFAAiF;IACjF,yDAAyD;CAC1D,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,MAAM,KAAK,GAAG;QACZ,kGAAkG;QAClG,GAAG,UAAU,CAAC,GAAG,CAAC;QAClB,oEAAoE;QACpE,yBAAyB,OAAO,EAAE;QAClC,oHAAoH;QACpH,iCAAiC,WAAW,UAAU;KACvD,CAAC;IACF,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,OAAO,CAAC,0BAA0B,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/G,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,GAAW,EAAE,GAAW;IACtD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAwB,EAAE,EAAE;QACrE,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,EAAE,CAAC;QACnC,MAAM,CAAC,CAAC;IACV,CAAC,CAAC,CAAC;IACH,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,oEAAoE,CAAC,CAAC;IACrH,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACtC,MAAM,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,mBAAmB,CAAC,EAAE,SAAS,CAAC,CAAC;IAC3D,MAAM,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,EAAE,cAAc,aAAa,IAAI,CAAC,CAAC;IAC1E,MAAM,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5D,MAAM,GAAG,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IAC/B,MAAM,GAAG,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;IACtD,MAAM,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,mBAAmB,EAAE,YAAY,CAAC,CAAC,CAAC;IAC3D,MAAM,GAAG,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,2BAA2B,CAAC,CAAC,CAAC;AACrF,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,gBAAgB,CAAC,GAAW,EAAE,GAAW;IACvD,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAC7B,OAAO;QACL,yDAAyD,GAAG,2CAA2C;QACvG,8BAA8B,GAAG,uEAAuE;QACxG,sGAAsG;QACtG,EAAE;QACF,gDAAgD;QAChD,EAAE;QACF,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,EAAE;QACF,qBAAqB;QACrB,EAAE;QACF,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QAC7D,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,GAAG,CAAC,GAAW,EAAE,IAAc;IAC5C,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,GAAG,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IACnF,MAAM,KAAK,GAAG,EAAE,eAAe,EAAE,cAAc,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,cAAc,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,eAAe,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,CAAC;IAClQ,MAAM,MAAM,GAAG,CAAC,IAAI,EAAE,sBAAsB,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,yBAAyB,CAAC,CAAC;IAC5G,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,GAAG,KAAK,EAAE,EAAE,CAAC,CAAC;IAC9E,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,GAAG,GAAG,CAAgD,CAAC;QAC7D,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAC;QACvH,MAAM,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACzF,CAAC;AACH,CAAC;AAED,gGAAgG;AAChG,MAAM,UAAU,UAAU,CAAC,CAAS;IAClC,OAAO,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC;AAC5E,CAAC"}
|