@kodentuzo/spotcraft 0.0.0-stage → 0.6.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/LICENSE +202 -0
- package/NOTICE +8 -0
- package/README.md +81 -2
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +196 -0
- package/dist/project.d.ts +41 -0
- package/dist/project.js +152 -0
- package/dist/provision.d.ts +57 -0
- package/dist/provision.js +163 -0
- package/dist/stack.d.ts +87 -0
- package/dist/stack.js +317 -0
- package/package.json +56 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
Spotcraft
|
|
2
|
+
Copyright 2026 Ivan Vinski
|
|
3
|
+
|
|
4
|
+
This product is licensed under the Apache License, Version 2.0 (see LICENSE).
|
|
5
|
+
|
|
6
|
+
The agent skills vendored in .claude/skills/ are third-party works under their own
|
|
7
|
+
licenses (MIT, Apache-2.0, MPL-2.0); each skill folder carries its LICENSE, and
|
|
8
|
+
skills-lock.json records the source and license of every one.
|
package/README.md
CHANGED
|
@@ -1,3 +1,82 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @kodentuzo/spotcraft
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The `spotcraft` command. `spotcraft dev` runs a local stack that matches a Spotcraft server, one
|
|
4
|
+
per repository ([ADR 0037](https://github.com/kodentuzo/spotcraft/blob/main/docs/decisions/0037-local-stack-per-repo.md)):
|
|
5
|
+
Postgres set up as on the server, the user pool, and Mailpit to catch email. It needs Docker.
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install --save-dev @kodentuzo/spotcraft # same version as the Spotcraft you deploy to
|
|
9
|
+
npx spotcraft dev # start, set up this app, fill .env, migrate
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
It replaces the `spotcraft` package, which apps on `@spotcraft/kit` keep at 0.5 until they move
|
|
13
|
+
to the user pool.
|
|
14
|
+
|
|
15
|
+
| Command | What |
|
|
16
|
+
| ---------------------- | ------------------------------------------------------------------------------------------------------ |
|
|
17
|
+
| `dev` | starts the stack if needed, sets up this app's schema, adds missing settings to `.env`, runs `migrate` |
|
|
18
|
+
| `dev env [--write]` | prints this app's settings; `--write` adds missing ones to `.env` |
|
|
19
|
+
| `dev db reset [--yes]` | deletes everything in this app's schema (asks first), then runs `migrate` |
|
|
20
|
+
| `dev migrate` | runs `migrate` from `spotcraft.json` with this app's settings |
|
|
21
|
+
| `dev status` | whether the stack runs, its addresses, and this app's schema |
|
|
22
|
+
| `dev stop` | stops the stack; the data stays |
|
|
23
|
+
| `dev ls` | every repository's stack on this machine |
|
|
24
|
+
|
|
25
|
+
## The app
|
|
26
|
+
|
|
27
|
+
The app's name comes from `--name`, else `name` in `spotcraft.json`, else the `name` in
|
|
28
|
+
`package.json` made into an app name (`@acme/Blog_API` → `blog-api`). `spotcraft.json` sits in
|
|
29
|
+
the deployable's folder:
|
|
30
|
+
|
|
31
|
+
```json
|
|
32
|
+
{ "name": "lifts-api", "migrate": "pnpm db:migrate" }
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
`migrate` runs through the shell in that folder, with the app's settings; values in `.env` win.
|
|
36
|
+
On the server, the image's `dev.spotcraft.migrate` label does that job instead
|
|
37
|
+
([the contract](https://github.com/kodentuzo/spotcraft/blob/main/docs/contracts.md)).
|
|
38
|
+
|
|
39
|
+
`.env` gets the names the server uses, pointing at the local stack: `DATABASE_URL`,
|
|
40
|
+
`DATABASE_SCHEMA`, `APP_NAME`, `APP_SECRET` (random, kept), `PUBLIC_URL`
|
|
41
|
+
(`http://localhost:3000`; change it to your dev server's), `AUTH_URL`, `AUTH_ISSUER`,
|
|
42
|
+
`AUTH_JWKS_URL`, `SMTP_URL` and `MAIL_FROM`. Existing lines are never changed.
|
|
43
|
+
|
|
44
|
+
An app set up by the old `spotcraft` CLI keeps its own database and gets only `DATABASE_URL`
|
|
45
|
+
and `AUTH_SECRET`; `dev db reset` moves it to a schema.
|
|
46
|
+
|
|
47
|
+
## The stack
|
|
48
|
+
|
|
49
|
+
- **One per repository**, found from the folder you run it in: the nearest folder up with
|
|
50
|
+
`.git` or `pnpm-workspace.yaml`. Every deployable in a monorepo shares it, so their tables can
|
|
51
|
+
point at the same local users. It is the Compose project
|
|
52
|
+
`spotcraft-dev-<repo folder>-<hash>`, with its data in its own volume. The hash is 6 hex
|
|
53
|
+
characters of the root's absolute path, so two checkouts or worktrees with the same folder
|
|
54
|
+
name get their own stacks. `dev status` prints the name; `dev ls` lists every stack without
|
|
55
|
+
the `spotcraft-dev-` prefix.
|
|
56
|
+
- **Ports and the name** are picked on the first run and kept in `.spotcraft/dev.json` at the
|
|
57
|
+
repository's root, so `.env` stays valid. A stack made by 0.6.0 keeps its name,
|
|
58
|
+
`spotcraft-dev-<repo folder>`. `.spotcraft/` ignores itself in git.
|
|
59
|
+
- **Postgres:** the server's pinned image and login rules, the same roles and grants (the deploy
|
|
60
|
+
script's SQL), and the same provisioning code as the agent (`@kodentuzo/spotcraft/provision`).
|
|
61
|
+
Every app has its own schema and role in the `apps` database. Tests fail if the copies of the
|
|
62
|
+
image, the rules or that SQL drift from `infra/`.
|
|
63
|
+
- **The user pool:** the `spotcraft` image of this CLI's version (`SPOTCRAFT_DEV_IMAGE`
|
|
64
|
+
overrides it, e.g. with a local build), over plain HTTP. It trusts any
|
|
65
|
+
`http://localhost:<port>` and `http://127.0.0.1:<port>` origin, where dev servers run. Its
|
|
66
|
+
cookies are host-only, and browsers send `localhost` cookies to every port, so an app at
|
|
67
|
+
`localhost:3000` and the pool at its own port share the session.
|
|
68
|
+
- **Mailpit** catches every email sent to `SMTP_URL`; its inbox is at the address `dev status`
|
|
69
|
+
shows.
|
|
70
|
+
|
|
71
|
+
Everything listens on `127.0.0.1` only. The passwords are fixed (`local-<name>-password` for an
|
|
72
|
+
app), which is fine for throwaway data on your own machine and nowhere else. To remove a stack
|
|
73
|
+
and its data: `docker compose -p <name from dev status> down -v`.
|
|
74
|
+
|
|
75
|
+
## Developing
|
|
76
|
+
|
|
77
|
+
In the workspace, run it from source with
|
|
78
|
+
`node --conditions=spotcraft-source packages/cli/src/cli.ts dev …` from an app's folder. pnpm
|
|
79
|
+
selects this package by folder (`--filter ./packages/cli`), as `spotcraft` is also the
|
|
80
|
+
workspace root's name. `pnpm --filter ./packages/cli build` writes `dist/`: the `spotcraft` bin,
|
|
81
|
+
and `@kodentuzo/spotcraft/provision`, which the agent imports. That export is for Spotcraft
|
|
82
|
+
itself, not for apps.
|
package/dist/cli.d.ts
ADDED
package/dist/cli.js
ADDED
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { spawn } from 'node:child_process';
|
|
3
|
+
import { readFileSync } from 'node:fs';
|
|
4
|
+
import { readFile } from 'node:fs/promises';
|
|
5
|
+
import { join } from 'node:path';
|
|
6
|
+
import { createInterface } from 'node:readline/promises';
|
|
7
|
+
import { parseArgs } from 'node:util';
|
|
8
|
+
import { appName, findRoot, localEnv, parseEnv, readSpotcraftJson, repoSlug, writeMissing, } from "./project.js";
|
|
9
|
+
import { appLayout, appRoleName, provision, purge } from "./provision.js";
|
|
10
|
+
import { adminUrl, appPassword, databaseUrl, down, isRunning, listStacks, loadStack, mailUrl, poolImage, poolUrl, StackError, up, } from "./stack.js";
|
|
11
|
+
const VERSION = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf8')).version;
|
|
12
|
+
const HELP = `Usage: spotcraft dev [command] [--name <app>]
|
|
13
|
+
|
|
14
|
+
Runs a local stack that matches a Spotcraft server, one per repository (ADR 0037): Postgres,
|
|
15
|
+
the user pool and Mailpit. Needs Docker.
|
|
16
|
+
|
|
17
|
+
Commands:
|
|
18
|
+
(none) start the stack if needed, set up this app's schema, add missing settings
|
|
19
|
+
to .env, and run "migrate" from spotcraft.json
|
|
20
|
+
env [--write] print this app's settings; --write adds missing ones to .env
|
|
21
|
+
db reset [--yes]
|
|
22
|
+
delete everything in this app's schema and start it empty, then migrate
|
|
23
|
+
migrate run "migrate" from spotcraft.json with this app's settings
|
|
24
|
+
status whether the stack runs, its addresses, and this app's schema
|
|
25
|
+
stop stop the stack (the data stays)
|
|
26
|
+
ls every repository's stack on this machine
|
|
27
|
+
|
|
28
|
+
The app name comes from --name, spotcraft.json or package.json.
|
|
29
|
+
`;
|
|
30
|
+
const print = (line = '') => process.stdout.write(`${line}\n`);
|
|
31
|
+
async function confirm(question) {
|
|
32
|
+
const rl = createInterface({ input: process.stdin, output: process.stdout });
|
|
33
|
+
try {
|
|
34
|
+
return /^y(es)?$/i.test((await rl.question(`${question} [y/N] `)).trim());
|
|
35
|
+
}
|
|
36
|
+
finally {
|
|
37
|
+
rl.close();
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
/** This app's settings: its schema (or its own old database), the pool, mail. */
|
|
41
|
+
async function appEnv(cwd, stack, name) {
|
|
42
|
+
const layout = (await isRunning(stack)) ? await appLayout(adminUrl(stack), name) : 'none';
|
|
43
|
+
return layout === 'database'
|
|
44
|
+
? localEnv(cwd, stack, { name, databaseUrl: databaseUrl(stack, name, appRoleName(name)) })
|
|
45
|
+
: localEnv(cwd, stack, {
|
|
46
|
+
name,
|
|
47
|
+
databaseUrl: databaseUrl(stack, name),
|
|
48
|
+
schema: appRoleName(name),
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Runs `migrate` from spotcraft.json in the app's folder, through the shell (it is the
|
|
53
|
+
* repository's own command), with the app's settings: those in .env win over the stack's.
|
|
54
|
+
*/
|
|
55
|
+
async function migrate(cwd, stack, name) {
|
|
56
|
+
const { migrate: command } = await readSpotcraftJson(cwd);
|
|
57
|
+
if (!command) {
|
|
58
|
+
print('No "migrate" in spotcraft.json; nothing to run.');
|
|
59
|
+
return 0;
|
|
60
|
+
}
|
|
61
|
+
const env = Object.fromEntries(await appEnv(cwd, stack, name));
|
|
62
|
+
const own = parseEnv(await readFile(join(cwd, '.env'), 'utf8').catch(() => ''));
|
|
63
|
+
print(`$ ${command}`);
|
|
64
|
+
return new Promise((resolve) => {
|
|
65
|
+
const child = spawn(command, {
|
|
66
|
+
cwd,
|
|
67
|
+
shell: true,
|
|
68
|
+
stdio: 'inherit',
|
|
69
|
+
env: { ...process.env, ...env, ...Object.fromEntries(own) },
|
|
70
|
+
});
|
|
71
|
+
child.on('close', (code) => resolve(code ?? 1));
|
|
72
|
+
child.on('error', () => resolve(127));
|
|
73
|
+
});
|
|
74
|
+
}
|
|
75
|
+
function addresses(stack) {
|
|
76
|
+
print(`Postgres 127.0.0.1:${stack.ports.postgres}`);
|
|
77
|
+
print(`Users ${poolUrl(stack)}`);
|
|
78
|
+
print(`Mail ${mailUrl(stack)}`);
|
|
79
|
+
}
|
|
80
|
+
export async function main(argv) {
|
|
81
|
+
const { values, positionals } = parseArgs({
|
|
82
|
+
args: argv,
|
|
83
|
+
allowPositionals: true,
|
|
84
|
+
options: {
|
|
85
|
+
name: { type: 'string' },
|
|
86
|
+
write: { type: 'boolean', default: false },
|
|
87
|
+
yes: { type: 'boolean', default: false },
|
|
88
|
+
help: { type: 'boolean', short: 'h', default: false },
|
|
89
|
+
},
|
|
90
|
+
});
|
|
91
|
+
const [group, ...rest] = positionals;
|
|
92
|
+
const command = rest.join(' ');
|
|
93
|
+
if (values.help || group !== 'dev') {
|
|
94
|
+
print(HELP);
|
|
95
|
+
return values.help ? 0 : 1;
|
|
96
|
+
}
|
|
97
|
+
const cwd = process.cwd();
|
|
98
|
+
const root = await findRoot(cwd);
|
|
99
|
+
const stack = await loadStack(root, repoSlug(root));
|
|
100
|
+
const image = poolImage(VERSION);
|
|
101
|
+
switch (command) {
|
|
102
|
+
case '':
|
|
103
|
+
case 'start': {
|
|
104
|
+
const name = await appName(cwd, values.name);
|
|
105
|
+
await up(stack, image);
|
|
106
|
+
const { database } = await provision(adminUrl(stack), { name, password: appPassword(name) });
|
|
107
|
+
const env = await appEnv(cwd, stack, name);
|
|
108
|
+
const { added, kept } = await writeMissing(cwd, env);
|
|
109
|
+
print(`${stack.project} is up; ${appRoleName(name)} is ready in ${database}.`);
|
|
110
|
+
addresses(stack);
|
|
111
|
+
if (added.length)
|
|
112
|
+
print(`Added to .env: ${added.join(', ')}`);
|
|
113
|
+
if (kept.length)
|
|
114
|
+
print(`Already in .env, left as they are: ${kept.join(', ')}`);
|
|
115
|
+
return migrate(cwd, stack, name);
|
|
116
|
+
}
|
|
117
|
+
case 'stop':
|
|
118
|
+
await down(stack, image);
|
|
119
|
+
print(`${stack.project} stopped; the data stays.`);
|
|
120
|
+
return 0;
|
|
121
|
+
case 'ls': {
|
|
122
|
+
const stacks = await listStacks();
|
|
123
|
+
if (stacks.length === 0)
|
|
124
|
+
print('No local stacks.');
|
|
125
|
+
const width = Math.max(...stacks.map(({ name }) => name.length));
|
|
126
|
+
for (const { name, status } of stacks)
|
|
127
|
+
print(`${name.padEnd(width)} ${status}`);
|
|
128
|
+
return 0;
|
|
129
|
+
}
|
|
130
|
+
case 'status': {
|
|
131
|
+
const name = await appName(cwd, values.name);
|
|
132
|
+
if (!(await isRunning(stack))) {
|
|
133
|
+
print(`${stack.project}: stopped (spotcraft dev)`);
|
|
134
|
+
return 0;
|
|
135
|
+
}
|
|
136
|
+
const layout = await appLayout(adminUrl(stack), name).catch(() => 'none');
|
|
137
|
+
print(`${stack.project}: running`);
|
|
138
|
+
addresses(stack);
|
|
139
|
+
const state = {
|
|
140
|
+
schema: 'ready',
|
|
141
|
+
database: 'ready, in its own database (spotcraft dev db reset moves it to a schema)',
|
|
142
|
+
none: 'not set up yet (spotcraft dev)',
|
|
143
|
+
}[layout];
|
|
144
|
+
print(`${appRoleName(name)}: ${state}`);
|
|
145
|
+
return 0;
|
|
146
|
+
}
|
|
147
|
+
case 'env': {
|
|
148
|
+
const name = await appName(cwd, values.name);
|
|
149
|
+
const env = await appEnv(cwd, stack, name);
|
|
150
|
+
if (!values.write) {
|
|
151
|
+
for (const [key, value] of env)
|
|
152
|
+
print(`${key}=${value}`);
|
|
153
|
+
return 0;
|
|
154
|
+
}
|
|
155
|
+
const { added, kept } = await writeMissing(cwd, env);
|
|
156
|
+
if (added.length)
|
|
157
|
+
print(`Added to .env: ${added.join(', ')}`);
|
|
158
|
+
if (kept.length)
|
|
159
|
+
print(`Already in .env, left as they are: ${kept.join(', ')}`);
|
|
160
|
+
return 0;
|
|
161
|
+
}
|
|
162
|
+
case 'db reset':
|
|
163
|
+
case 'reset': {
|
|
164
|
+
const name = await appName(cwd, values.name);
|
|
165
|
+
if (!(await isRunning(stack)))
|
|
166
|
+
throw new StackError('The stack is not running; run `spotcraft dev`');
|
|
167
|
+
const role = appRoleName(name);
|
|
168
|
+
if (!values.yes &&
|
|
169
|
+
!(await confirm(`Delete everything in the local ${role} and start it empty?`))) {
|
|
170
|
+
print('Nothing changed.');
|
|
171
|
+
return 1;
|
|
172
|
+
}
|
|
173
|
+
await purge(adminUrl(stack), name);
|
|
174
|
+
await provision(adminUrl(stack), { name, password: appPassword(name) });
|
|
175
|
+
print(`${role} is empty again.`);
|
|
176
|
+
return migrate(cwd, stack, name);
|
|
177
|
+
}
|
|
178
|
+
case 'migrate': {
|
|
179
|
+
const name = await appName(cwd, values.name);
|
|
180
|
+
if (!(await isRunning(stack)))
|
|
181
|
+
throw new StackError('The stack is not running; run `spotcraft dev`');
|
|
182
|
+
await provision(adminUrl(stack), { name, password: appPassword(name) });
|
|
183
|
+
return migrate(cwd, stack, name);
|
|
184
|
+
}
|
|
185
|
+
default:
|
|
186
|
+
print(HELP);
|
|
187
|
+
return 1;
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
// Run when executed (not when a test imports it).
|
|
191
|
+
if (import.meta.main) {
|
|
192
|
+
main(process.argv.slice(2)).then((code) => process.exit(code), (error) => {
|
|
193
|
+
process.stderr.write(`spotcraft: ${error instanceof Error ? error.message : String(error)}\n`);
|
|
194
|
+
process.exit(1);
|
|
195
|
+
});
|
|
196
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { type Stack } from './stack.ts';
|
|
2
|
+
/**
|
|
3
|
+
* The repository's root: the nearest folder up from `dir` with `.git` or `pnpm-workspace.yaml`,
|
|
4
|
+
* else `dir`. Every deployable in a repository shares its stack (ADR 0037).
|
|
5
|
+
*/
|
|
6
|
+
export declare function findRoot(dir: string): Promise<string>;
|
|
7
|
+
/** A name for the repository's stack: its folder's name, made safe for Compose. */
|
|
8
|
+
export declare function repoSlug(root: string): string;
|
|
9
|
+
/** `spotcraft.json` in a deployable's folder (ADR 0034): its name and local migrate command. */
|
|
10
|
+
export interface SpotcraftJson {
|
|
11
|
+
name?: string;
|
|
12
|
+
migrate?: string;
|
|
13
|
+
}
|
|
14
|
+
export declare function readSpotcraftJson(dir: string): Promise<SpotcraftJson>;
|
|
15
|
+
/**
|
|
16
|
+
* The app's name: `--name`, else `name` in spotcraft.json, else the `name` in package.json,
|
|
17
|
+
* made into a Spotcraft app name (`@acme/Blog_API` → `blog-api`). Throws when none gives a
|
|
18
|
+
* valid one.
|
|
19
|
+
*/
|
|
20
|
+
export declare function appName(dir: string, flag?: string): Promise<string>;
|
|
21
|
+
/** KEY=value lines of a .env file (comments and blank lines skipped). */
|
|
22
|
+
export declare function parseEnv(text: string): Map<string, string>;
|
|
23
|
+
/**
|
|
24
|
+
* The settings an app gets locally, with the names the server uses (ADR 0034): its database
|
|
25
|
+
* URL and schema, the local pool and mail, and an APP_SECRET kept if .env already has one.
|
|
26
|
+
* An app that still has its own database (from before ADR 0034) gets that database and the
|
|
27
|
+
* kit's AUTH_SECRET instead of a schema.
|
|
28
|
+
*/
|
|
29
|
+
export declare function localEnv(dir: string, stack: Stack, app: {
|
|
30
|
+
name: string;
|
|
31
|
+
databaseUrl: string;
|
|
32
|
+
schema?: string;
|
|
33
|
+
}): Promise<Map<string, string>>;
|
|
34
|
+
/**
|
|
35
|
+
* Adds the variables .env doesn't have yet, at the end, and leaves every existing line alone.
|
|
36
|
+
* Returns which were added and which were already there (possibly with another value).
|
|
37
|
+
*/
|
|
38
|
+
export declare function writeMissing(dir: string, values: Map<string, string>): Promise<{
|
|
39
|
+
added: string[];
|
|
40
|
+
kept: string[];
|
|
41
|
+
}>;
|